http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.lib.UInt16Array.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.lib.UInt16Array.html b/docs/python/generated/pyarrow.lib.UInt16Array.html new file mode 100644 index 0000000..5264226 --- /dev/null +++ b/docs/python/generated/pyarrow.lib.UInt16Array.html @@ -0,0 +1,364 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.lib.UInt16Array — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="pyarrow.lib.UInt32Array" href="pyarrow.lib.UInt32Array.html" /> + <link rel="prev" title="pyarrow.lib.UInt8Array" href="pyarrow.lib.UInt8Array.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><p class="caption"><span class="caption-text">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.lib.UInt16Array</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.lib.UInt8Array.html" title="Previous Chapter: pyarrow.lib.UInt8Array"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.lib.U...</span> + </a> + </li> + <li> + <a href="pyarrow.lib.UInt32Array.html" title="Next Chapter: pyarrow.lib.UInt32Array"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.lib.U... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.lib.UInt16Array.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-lib-uint16array"> +<h1>pyarrow.lib.UInt16Array<a class="headerlink" href="#pyarrow-lib-uint16array" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.lib.UInt16Array"> +<em class="property">class </em><code class="descclassname">pyarrow.lib.</code><code class="descname">UInt16Array</code><a class="headerlink" href="#pyarrow.lib.UInt16Array" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="pyarrow.lib.IntegerArray.html#pyarrow.lib.IntegerArray" title="pyarrow.lib.IntegerArray"><code class="xref py py-class docutils literal"><span class="pre">pyarrow.lib.IntegerArray</span></code></a></p> +<dl class="method"> +<dt id="pyarrow.lib.UInt16Array.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt16Array.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>Initialize self. See help(type(self)) for accurate signature.</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt16Array.equals" title="pyarrow.lib.UInt16Array.equals"><code class="xref py py-obj docutils literal"><span class="pre">equals</span></code></a>(self, Array other)</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt16Array.from_pandas" title="pyarrow.lib.UInt16Array.from_pandas"><code class="xref py py-obj docutils literal"><span class="pre">from_pandas</span></code></a>(obj[, mask, timestamps_to_ms])</td> +<td>Convert pandas.Series to an Arrow Array.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt16Array.isnull" title="pyarrow.lib.UInt16Array.isnull"><code class="xref py py-obj docutils literal"><span class="pre">isnull</span></code></a>(self)</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt16Array.slice" title="pyarrow.lib.UInt16Array.slice"><code class="xref py py-obj docutils literal"><span class="pre">slice</span></code></a>(self[, offset, length])</td> +<td>Compute zero-copy slice of this array</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt16Array.to_pandas" title="pyarrow.lib.UInt16Array.to_pandas"><code class="xref py py-obj docutils literal"><span class="pre">to_pandas</span></code></a>(self, ...)</td> +<td>Convert to an array object suitable for use in pandas</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt16Array.to_pylist" title="pyarrow.lib.UInt16Array.to_pylist"><code class="xref py py-obj docutils literal"><span class="pre">to_pylist</span></code></a>(self)</td> +<td>Convert to an list of native Python objects.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt16Array.validate" title="pyarrow.lib.UInt16Array.validate"><code class="xref py py-obj docutils literal"><span class="pre">validate</span></code></a>(self)</td> +<td>Perform any validation checks implemented by arrow::ValidateArray.</td> +</tr> +</tbody> +</table> +<p class="rubric">Attributes</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt16Array.null_count" title="pyarrow.lib.UInt16Array.null_count"><code class="xref py py-obj docutils literal"><span class="pre">null_count</span></code></a></td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt16Array.type" title="pyarrow.lib.UInt16Array.type"><code class="xref py py-obj docutils literal"><span class="pre">type</span></code></a></td> +<td></td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="pyarrow.lib.UInt16Array.equals"> +<code class="descname">equals</code><span class="sig-paren">(</span><em>self</em>, <em>Array other</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt16Array.equals" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt16Array.from_pandas"> +<code class="descname">from_pandas</code><span class="sig-paren">(</span><em>obj</em>, <em>mask=None</em>, <em>DataType type=None</em>, <em>timestamps_to_ms=False</em>, <em>MemoryPool memory_pool=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt16Array.from_pandas" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert pandas.Series to an Arrow Array.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>series</strong> (<em>pandas.Series</em><em> or </em><em>numpy.ndarray</em>) – </li> +<li><strong>mask</strong> (<em>pandas.Series</em><em> or </em><em>numpy.ndarray</em><em>, </em><em>optional</em>) – boolean mask if the object is null (True) or valid (False)</li> +<li><strong>type</strong> (<em>pyarrow.DataType</em>) – Explicit type to attempt to coerce to</li> +<li><strong>timestamps_to_ms</strong> (<em>bool</em><em>, </em><em>optional</em>) – Convert datetime columns to ms resolution. This is needed for +compatibility with other functionality like Parquet I/O which +only supports milliseconds.</li> +<li><strong>memory_pool</strong> (<a class="reference internal" href="pyarrow.MemoryPool.html#pyarrow.MemoryPool" title="pyarrow.MemoryPool"><em>MemoryPool</em></a><em>, </em><em>optional</em>) – Specific memory pool to use to allocate the resulting Arrow array.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<p class="rubric">Notes</p> +<p>Localized timestamps will currently be returned as UTC (pandas’s native +representation). Timezone-naive data will be implicitly interpreted as +UTC.</p> +<p class="rubric">Examples</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span> +<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span> +<span class="gp">>>> </span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]))</span> +<span class="go"><pyarrow.array.Int64Array object at 0x7f674e4c0e10></span> +<span class="go">[</span> +<span class="go"> 1,</span> +<span class="go"> 2</span> +<span class="go">]</span> +</pre></div> +</div> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> +<span class="gp">>>> </span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]),</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> +<span class="gp">... </span><span class="n">dtype</span><span class="o">=</span><span class="nb">bool</span><span class="p">))</span> +<span class="go"><pyarrow.array.Int64Array object at 0x7f9019e11208></span> +<span class="go">[</span> +<span class="go"> 1,</span> +<span class="go"> NA</span> +<span class="go">]</span> +</pre></div> +</div> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><ul class="simple"> +<li><strong>array</strong> (<em>pyarrow.Array or pyarrow.ChunkedArray (if object data</em>)</li> +<li><em>overflowed binary storage)</em></li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt16Array.isnull"> +<code class="descname">isnull</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt16Array.isnull" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.lib.UInt16Array.null_count"> +<code class="descname">null_count</code><a class="headerlink" href="#pyarrow.lib.UInt16Array.null_count" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt16Array.slice"> +<code class="descname">slice</code><span class="sig-paren">(</span><em>self</em>, <em>offset=0</em>, <em>length=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt16Array.slice" title="Permalink to this definition">¶</a></dt> +<dd><p>Compute zero-copy slice of this array</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>offset</strong> (<em>int</em><em>, </em><em>default 0</em>) – Offset from start of array to slice</li> +<li><strong>length</strong> (<em>int</em><em>, </em><em>default None</em>) – Length of slice (default is until end of Array starting from +offset)</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><strong>sliced</strong> (<em>RecordBatch</em>)</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt16Array.to_pandas"> +<code class="descname">to_pandas</code><span class="sig-paren">(</span><em>self</em>, <em>bool strings_to_categorical=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt16Array.to_pandas" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert to an array object suitable for use in pandas</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>strings_to_categorical</strong> (<em>boolean</em><em>, </em><em>default False</em>) – Encode string (UTF8) and binary types to pandas.Categorical</td> +</tr> +</tbody> +</table> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><code class="xref py py-meth docutils literal"><span class="pre">Column.to_pandas()</span></code>, <code class="xref py py-meth docutils literal"><span class="pre">Table.to_pandas()</span></code>, <code class="xref py py-meth docutils literal"><span class="pre">RecordBatch.to_pandas()</span></code></p> +</div> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt16Array.to_pylist"> +<code class="descname">to_pylist</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt16Array.to_pylist" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert to an list of native Python objects.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.lib.UInt16Array.type"> +<code class="descname">type</code><a class="headerlink" href="#pyarrow.lib.UInt16Array.type" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt16Array.validate"> +<code class="descname">validate</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt16Array.validate" title="Permalink to this definition">¶</a></dt> +<dd><p>Perform any validation checks implemented by +arrow::ValidateArray. Raises exception with error message if array does +not validate</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">ArrowInvalid</span></code></td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.lib.UInt32Array.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.lib.UInt32Array.html b/docs/python/generated/pyarrow.lib.UInt32Array.html new file mode 100644 index 0000000..5654263 --- /dev/null +++ b/docs/python/generated/pyarrow.lib.UInt32Array.html @@ -0,0 +1,364 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.lib.UInt32Array — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="pyarrow.lib.UInt64Array" href="pyarrow.lib.UInt64Array.html" /> + <link rel="prev" title="pyarrow.lib.UInt16Array" href="pyarrow.lib.UInt16Array.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><p class="caption"><span class="caption-text">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.lib.UInt32Array</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.lib.UInt16Array.html" title="Previous Chapter: pyarrow.lib.UInt16Array"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.lib.U...</span> + </a> + </li> + <li> + <a href="pyarrow.lib.UInt64Array.html" title="Next Chapter: pyarrow.lib.UInt64Array"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.lib.U... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.lib.UInt32Array.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-lib-uint32array"> +<h1>pyarrow.lib.UInt32Array<a class="headerlink" href="#pyarrow-lib-uint32array" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.lib.UInt32Array"> +<em class="property">class </em><code class="descclassname">pyarrow.lib.</code><code class="descname">UInt32Array</code><a class="headerlink" href="#pyarrow.lib.UInt32Array" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="pyarrow.lib.IntegerArray.html#pyarrow.lib.IntegerArray" title="pyarrow.lib.IntegerArray"><code class="xref py py-class docutils literal"><span class="pre">pyarrow.lib.IntegerArray</span></code></a></p> +<dl class="method"> +<dt id="pyarrow.lib.UInt32Array.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt32Array.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>Initialize self. See help(type(self)) for accurate signature.</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt32Array.equals" title="pyarrow.lib.UInt32Array.equals"><code class="xref py py-obj docutils literal"><span class="pre">equals</span></code></a>(self, Array other)</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt32Array.from_pandas" title="pyarrow.lib.UInt32Array.from_pandas"><code class="xref py py-obj docutils literal"><span class="pre">from_pandas</span></code></a>(obj[, mask, timestamps_to_ms])</td> +<td>Convert pandas.Series to an Arrow Array.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt32Array.isnull" title="pyarrow.lib.UInt32Array.isnull"><code class="xref py py-obj docutils literal"><span class="pre">isnull</span></code></a>(self)</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt32Array.slice" title="pyarrow.lib.UInt32Array.slice"><code class="xref py py-obj docutils literal"><span class="pre">slice</span></code></a>(self[, offset, length])</td> +<td>Compute zero-copy slice of this array</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt32Array.to_pandas" title="pyarrow.lib.UInt32Array.to_pandas"><code class="xref py py-obj docutils literal"><span class="pre">to_pandas</span></code></a>(self, ...)</td> +<td>Convert to an array object suitable for use in pandas</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt32Array.to_pylist" title="pyarrow.lib.UInt32Array.to_pylist"><code class="xref py py-obj docutils literal"><span class="pre">to_pylist</span></code></a>(self)</td> +<td>Convert to an list of native Python objects.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt32Array.validate" title="pyarrow.lib.UInt32Array.validate"><code class="xref py py-obj docutils literal"><span class="pre">validate</span></code></a>(self)</td> +<td>Perform any validation checks implemented by arrow::ValidateArray.</td> +</tr> +</tbody> +</table> +<p class="rubric">Attributes</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt32Array.null_count" title="pyarrow.lib.UInt32Array.null_count"><code class="xref py py-obj docutils literal"><span class="pre">null_count</span></code></a></td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt32Array.type" title="pyarrow.lib.UInt32Array.type"><code class="xref py py-obj docutils literal"><span class="pre">type</span></code></a></td> +<td></td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="pyarrow.lib.UInt32Array.equals"> +<code class="descname">equals</code><span class="sig-paren">(</span><em>self</em>, <em>Array other</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt32Array.equals" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt32Array.from_pandas"> +<code class="descname">from_pandas</code><span class="sig-paren">(</span><em>obj</em>, <em>mask=None</em>, <em>DataType type=None</em>, <em>timestamps_to_ms=False</em>, <em>MemoryPool memory_pool=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt32Array.from_pandas" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert pandas.Series to an Arrow Array.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>series</strong> (<em>pandas.Series</em><em> or </em><em>numpy.ndarray</em>) – </li> +<li><strong>mask</strong> (<em>pandas.Series</em><em> or </em><em>numpy.ndarray</em><em>, </em><em>optional</em>) – boolean mask if the object is null (True) or valid (False)</li> +<li><strong>type</strong> (<em>pyarrow.DataType</em>) – Explicit type to attempt to coerce to</li> +<li><strong>timestamps_to_ms</strong> (<em>bool</em><em>, </em><em>optional</em>) – Convert datetime columns to ms resolution. This is needed for +compatibility with other functionality like Parquet I/O which +only supports milliseconds.</li> +<li><strong>memory_pool</strong> (<a class="reference internal" href="pyarrow.MemoryPool.html#pyarrow.MemoryPool" title="pyarrow.MemoryPool"><em>MemoryPool</em></a><em>, </em><em>optional</em>) – Specific memory pool to use to allocate the resulting Arrow array.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<p class="rubric">Notes</p> +<p>Localized timestamps will currently be returned as UTC (pandas’s native +representation). Timezone-naive data will be implicitly interpreted as +UTC.</p> +<p class="rubric">Examples</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span> +<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span> +<span class="gp">>>> </span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]))</span> +<span class="go"><pyarrow.array.Int64Array object at 0x7f674e4c0e10></span> +<span class="go">[</span> +<span class="go"> 1,</span> +<span class="go"> 2</span> +<span class="go">]</span> +</pre></div> +</div> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> +<span class="gp">>>> </span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]),</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> +<span class="gp">... </span><span class="n">dtype</span><span class="o">=</span><span class="nb">bool</span><span class="p">))</span> +<span class="go"><pyarrow.array.Int64Array object at 0x7f9019e11208></span> +<span class="go">[</span> +<span class="go"> 1,</span> +<span class="go"> NA</span> +<span class="go">]</span> +</pre></div> +</div> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><ul class="simple"> +<li><strong>array</strong> (<em>pyarrow.Array or pyarrow.ChunkedArray (if object data</em>)</li> +<li><em>overflowed binary storage)</em></li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt32Array.isnull"> +<code class="descname">isnull</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt32Array.isnull" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.lib.UInt32Array.null_count"> +<code class="descname">null_count</code><a class="headerlink" href="#pyarrow.lib.UInt32Array.null_count" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt32Array.slice"> +<code class="descname">slice</code><span class="sig-paren">(</span><em>self</em>, <em>offset=0</em>, <em>length=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt32Array.slice" title="Permalink to this definition">¶</a></dt> +<dd><p>Compute zero-copy slice of this array</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>offset</strong> (<em>int</em><em>, </em><em>default 0</em>) – Offset from start of array to slice</li> +<li><strong>length</strong> (<em>int</em><em>, </em><em>default None</em>) – Length of slice (default is until end of Array starting from +offset)</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><strong>sliced</strong> (<em>RecordBatch</em>)</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt32Array.to_pandas"> +<code class="descname">to_pandas</code><span class="sig-paren">(</span><em>self</em>, <em>bool strings_to_categorical=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt32Array.to_pandas" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert to an array object suitable for use in pandas</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>strings_to_categorical</strong> (<em>boolean</em><em>, </em><em>default False</em>) – Encode string (UTF8) and binary types to pandas.Categorical</td> +</tr> +</tbody> +</table> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><code class="xref py py-meth docutils literal"><span class="pre">Column.to_pandas()</span></code>, <code class="xref py py-meth docutils literal"><span class="pre">Table.to_pandas()</span></code>, <code class="xref py py-meth docutils literal"><span class="pre">RecordBatch.to_pandas()</span></code></p> +</div> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt32Array.to_pylist"> +<code class="descname">to_pylist</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt32Array.to_pylist" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert to an list of native Python objects.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.lib.UInt32Array.type"> +<code class="descname">type</code><a class="headerlink" href="#pyarrow.lib.UInt32Array.type" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt32Array.validate"> +<code class="descname">validate</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt32Array.validate" title="Permalink to this definition">¶</a></dt> +<dd><p>Perform any validation checks implemented by +arrow::ValidateArray. Raises exception with error message if array does +not validate</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">ArrowInvalid</span></code></td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.lib.UInt64Array.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.lib.UInt64Array.html b/docs/python/generated/pyarrow.lib.UInt64Array.html new file mode 100644 index 0000000..7366afc --- /dev/null +++ b/docs/python/generated/pyarrow.lib.UInt64Array.html @@ -0,0 +1,364 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.lib.UInt64Array — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="pyarrow.lib.BinaryArray" href="pyarrow.lib.BinaryArray.html" /> + <link rel="prev" title="pyarrow.lib.UInt32Array" href="pyarrow.lib.UInt32Array.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><p class="caption"><span class="caption-text">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.lib.UInt64Array</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.lib.UInt32Array.html" title="Previous Chapter: pyarrow.lib.UInt32Array"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.lib.U...</span> + </a> + </li> + <li> + <a href="pyarrow.lib.BinaryArray.html" title="Next Chapter: pyarrow.lib.BinaryArray"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.lib.B... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.lib.UInt64Array.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-lib-uint64array"> +<h1>pyarrow.lib.UInt64Array<a class="headerlink" href="#pyarrow-lib-uint64array" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.lib.UInt64Array"> +<em class="property">class </em><code class="descclassname">pyarrow.lib.</code><code class="descname">UInt64Array</code><a class="headerlink" href="#pyarrow.lib.UInt64Array" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="pyarrow.lib.IntegerArray.html#pyarrow.lib.IntegerArray" title="pyarrow.lib.IntegerArray"><code class="xref py py-class docutils literal"><span class="pre">pyarrow.lib.IntegerArray</span></code></a></p> +<dl class="method"> +<dt id="pyarrow.lib.UInt64Array.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt64Array.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>Initialize self. See help(type(self)) for accurate signature.</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt64Array.equals" title="pyarrow.lib.UInt64Array.equals"><code class="xref py py-obj docutils literal"><span class="pre">equals</span></code></a>(self, Array other)</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt64Array.from_pandas" title="pyarrow.lib.UInt64Array.from_pandas"><code class="xref py py-obj docutils literal"><span class="pre">from_pandas</span></code></a>(obj[, mask, timestamps_to_ms])</td> +<td>Convert pandas.Series to an Arrow Array.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt64Array.isnull" title="pyarrow.lib.UInt64Array.isnull"><code class="xref py py-obj docutils literal"><span class="pre">isnull</span></code></a>(self)</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt64Array.slice" title="pyarrow.lib.UInt64Array.slice"><code class="xref py py-obj docutils literal"><span class="pre">slice</span></code></a>(self[, offset, length])</td> +<td>Compute zero-copy slice of this array</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt64Array.to_pandas" title="pyarrow.lib.UInt64Array.to_pandas"><code class="xref py py-obj docutils literal"><span class="pre">to_pandas</span></code></a>(self, ...)</td> +<td>Convert to an array object suitable for use in pandas</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt64Array.to_pylist" title="pyarrow.lib.UInt64Array.to_pylist"><code class="xref py py-obj docutils literal"><span class="pre">to_pylist</span></code></a>(self)</td> +<td>Convert to an list of native Python objects.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt64Array.validate" title="pyarrow.lib.UInt64Array.validate"><code class="xref py py-obj docutils literal"><span class="pre">validate</span></code></a>(self)</td> +<td>Perform any validation checks implemented by arrow::ValidateArray.</td> +</tr> +</tbody> +</table> +<p class="rubric">Attributes</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt64Array.null_count" title="pyarrow.lib.UInt64Array.null_count"><code class="xref py py-obj docutils literal"><span class="pre">null_count</span></code></a></td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt64Array.type" title="pyarrow.lib.UInt64Array.type"><code class="xref py py-obj docutils literal"><span class="pre">type</span></code></a></td> +<td></td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="pyarrow.lib.UInt64Array.equals"> +<code class="descname">equals</code><span class="sig-paren">(</span><em>self</em>, <em>Array other</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt64Array.equals" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt64Array.from_pandas"> +<code class="descname">from_pandas</code><span class="sig-paren">(</span><em>obj</em>, <em>mask=None</em>, <em>DataType type=None</em>, <em>timestamps_to_ms=False</em>, <em>MemoryPool memory_pool=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt64Array.from_pandas" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert pandas.Series to an Arrow Array.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>series</strong> (<em>pandas.Series</em><em> or </em><em>numpy.ndarray</em>) – </li> +<li><strong>mask</strong> (<em>pandas.Series</em><em> or </em><em>numpy.ndarray</em><em>, </em><em>optional</em>) – boolean mask if the object is null (True) or valid (False)</li> +<li><strong>type</strong> (<em>pyarrow.DataType</em>) – Explicit type to attempt to coerce to</li> +<li><strong>timestamps_to_ms</strong> (<em>bool</em><em>, </em><em>optional</em>) – Convert datetime columns to ms resolution. This is needed for +compatibility with other functionality like Parquet I/O which +only supports milliseconds.</li> +<li><strong>memory_pool</strong> (<a class="reference internal" href="pyarrow.MemoryPool.html#pyarrow.MemoryPool" title="pyarrow.MemoryPool"><em>MemoryPool</em></a><em>, </em><em>optional</em>) – Specific memory pool to use to allocate the resulting Arrow array.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<p class="rubric">Notes</p> +<p>Localized timestamps will currently be returned as UTC (pandas’s native +representation). Timezone-naive data will be implicitly interpreted as +UTC.</p> +<p class="rubric">Examples</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span> +<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span> +<span class="gp">>>> </span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]))</span> +<span class="go"><pyarrow.array.Int64Array object at 0x7f674e4c0e10></span> +<span class="go">[</span> +<span class="go"> 1,</span> +<span class="go"> 2</span> +<span class="go">]</span> +</pre></div> +</div> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> +<span class="gp">>>> </span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]),</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> +<span class="gp">... </span><span class="n">dtype</span><span class="o">=</span><span class="nb">bool</span><span class="p">))</span> +<span class="go"><pyarrow.array.Int64Array object at 0x7f9019e11208></span> +<span class="go">[</span> +<span class="go"> 1,</span> +<span class="go"> NA</span> +<span class="go">]</span> +</pre></div> +</div> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><ul class="simple"> +<li><strong>array</strong> (<em>pyarrow.Array or pyarrow.ChunkedArray (if object data</em>)</li> +<li><em>overflowed binary storage)</em></li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt64Array.isnull"> +<code class="descname">isnull</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt64Array.isnull" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.lib.UInt64Array.null_count"> +<code class="descname">null_count</code><a class="headerlink" href="#pyarrow.lib.UInt64Array.null_count" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt64Array.slice"> +<code class="descname">slice</code><span class="sig-paren">(</span><em>self</em>, <em>offset=0</em>, <em>length=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt64Array.slice" title="Permalink to this definition">¶</a></dt> +<dd><p>Compute zero-copy slice of this array</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>offset</strong> (<em>int</em><em>, </em><em>default 0</em>) – Offset from start of array to slice</li> +<li><strong>length</strong> (<em>int</em><em>, </em><em>default None</em>) – Length of slice (default is until end of Array starting from +offset)</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><strong>sliced</strong> (<em>RecordBatch</em>)</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt64Array.to_pandas"> +<code class="descname">to_pandas</code><span class="sig-paren">(</span><em>self</em>, <em>bool strings_to_categorical=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt64Array.to_pandas" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert to an array object suitable for use in pandas</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>strings_to_categorical</strong> (<em>boolean</em><em>, </em><em>default False</em>) – Encode string (UTF8) and binary types to pandas.Categorical</td> +</tr> +</tbody> +</table> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><code class="xref py py-meth docutils literal"><span class="pre">Column.to_pandas()</span></code>, <code class="xref py py-meth docutils literal"><span class="pre">Table.to_pandas()</span></code>, <code class="xref py py-meth docutils literal"><span class="pre">RecordBatch.to_pandas()</span></code></p> +</div> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt64Array.to_pylist"> +<code class="descname">to_pylist</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt64Array.to_pylist" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert to an list of native Python objects.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.lib.UInt64Array.type"> +<code class="descname">type</code><a class="headerlink" href="#pyarrow.lib.UInt64Array.type" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt64Array.validate"> +<code class="descname">validate</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt64Array.validate" title="Permalink to this definition">¶</a></dt> +<dd><p>Perform any validation checks implemented by +arrow::ValidateArray. Raises exception with error message if array does +not validate</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">ArrowInvalid</span></code></td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.lib.UInt8Array.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.lib.UInt8Array.html b/docs/python/generated/pyarrow.lib.UInt8Array.html new file mode 100644 index 0000000..67b836c --- /dev/null +++ b/docs/python/generated/pyarrow.lib.UInt8Array.html @@ -0,0 +1,364 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.lib.UInt8Array — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="pyarrow.lib.UInt16Array" href="pyarrow.lib.UInt16Array.html" /> + <link rel="prev" title="pyarrow.lib.NumericArray" href="pyarrow.lib.NumericArray.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><p class="caption"><span class="caption-text">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.lib.UInt8Array</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.lib.NumericArray.html" title="Previous Chapter: pyarrow.lib.NumericArray"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.lib.N...</span> + </a> + </li> + <li> + <a href="pyarrow.lib.UInt16Array.html" title="Next Chapter: pyarrow.lib.UInt16Array"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.lib.U... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.lib.UInt8Array.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-lib-uint8array"> +<h1>pyarrow.lib.UInt8Array<a class="headerlink" href="#pyarrow-lib-uint8array" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.lib.UInt8Array"> +<em class="property">class </em><code class="descclassname">pyarrow.lib.</code><code class="descname">UInt8Array</code><a class="headerlink" href="#pyarrow.lib.UInt8Array" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="pyarrow.lib.IntegerArray.html#pyarrow.lib.IntegerArray" title="pyarrow.lib.IntegerArray"><code class="xref py py-class docutils literal"><span class="pre">pyarrow.lib.IntegerArray</span></code></a></p> +<dl class="method"> +<dt id="pyarrow.lib.UInt8Array.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt8Array.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>Initialize self. See help(type(self)) for accurate signature.</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt8Array.equals" title="pyarrow.lib.UInt8Array.equals"><code class="xref py py-obj docutils literal"><span class="pre">equals</span></code></a>(self, Array other)</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt8Array.from_pandas" title="pyarrow.lib.UInt8Array.from_pandas"><code class="xref py py-obj docutils literal"><span class="pre">from_pandas</span></code></a>(obj[, mask, timestamps_to_ms])</td> +<td>Convert pandas.Series to an Arrow Array.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt8Array.isnull" title="pyarrow.lib.UInt8Array.isnull"><code class="xref py py-obj docutils literal"><span class="pre">isnull</span></code></a>(self)</td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt8Array.slice" title="pyarrow.lib.UInt8Array.slice"><code class="xref py py-obj docutils literal"><span class="pre">slice</span></code></a>(self[, offset, length])</td> +<td>Compute zero-copy slice of this array</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt8Array.to_pandas" title="pyarrow.lib.UInt8Array.to_pandas"><code class="xref py py-obj docutils literal"><span class="pre">to_pandas</span></code></a>(self, ...)</td> +<td>Convert to an array object suitable for use in pandas</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt8Array.to_pylist" title="pyarrow.lib.UInt8Array.to_pylist"><code class="xref py py-obj docutils literal"><span class="pre">to_pylist</span></code></a>(self)</td> +<td>Convert to an list of native Python objects.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt8Array.validate" title="pyarrow.lib.UInt8Array.validate"><code class="xref py py-obj docutils literal"><span class="pre">validate</span></code></a>(self)</td> +<td>Perform any validation checks implemented by arrow::ValidateArray.</td> +</tr> +</tbody> +</table> +<p class="rubric">Attributes</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.lib.UInt8Array.null_count" title="pyarrow.lib.UInt8Array.null_count"><code class="xref py py-obj docutils literal"><span class="pre">null_count</span></code></a></td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.lib.UInt8Array.type" title="pyarrow.lib.UInt8Array.type"><code class="xref py py-obj docutils literal"><span class="pre">type</span></code></a></td> +<td></td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="pyarrow.lib.UInt8Array.equals"> +<code class="descname">equals</code><span class="sig-paren">(</span><em>self</em>, <em>Array other</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt8Array.equals" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt8Array.from_pandas"> +<code class="descname">from_pandas</code><span class="sig-paren">(</span><em>obj</em>, <em>mask=None</em>, <em>DataType type=None</em>, <em>timestamps_to_ms=False</em>, <em>MemoryPool memory_pool=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt8Array.from_pandas" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert pandas.Series to an Arrow Array.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>series</strong> (<em>pandas.Series</em><em> or </em><em>numpy.ndarray</em>) – </li> +<li><strong>mask</strong> (<em>pandas.Series</em><em> or </em><em>numpy.ndarray</em><em>, </em><em>optional</em>) – boolean mask if the object is null (True) or valid (False)</li> +<li><strong>type</strong> (<em>pyarrow.DataType</em>) – Explicit type to attempt to coerce to</li> +<li><strong>timestamps_to_ms</strong> (<em>bool</em><em>, </em><em>optional</em>) – Convert datetime columns to ms resolution. This is needed for +compatibility with other functionality like Parquet I/O which +only supports milliseconds.</li> +<li><strong>memory_pool</strong> (<a class="reference internal" href="pyarrow.MemoryPool.html#pyarrow.MemoryPool" title="pyarrow.MemoryPool"><em>MemoryPool</em></a><em>, </em><em>optional</em>) – Specific memory pool to use to allocate the resulting Arrow array.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<p class="rubric">Notes</p> +<p>Localized timestamps will currently be returned as UTC (pandas’s native +representation). Timezone-naive data will be implicitly interpreted as +UTC.</p> +<p class="rubric">Examples</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span> +<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span> +<span class="gp">>>> </span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]))</span> +<span class="go"><pyarrow.array.Int64Array object at 0x7f674e4c0e10></span> +<span class="go">[</span> +<span class="go"> 1,</span> +<span class="go"> 2</span> +<span class="go">]</span> +</pre></div> +</div> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> +<span class="gp">>>> </span><span class="n">pa</span><span class="o">.</span><span class="n">Array</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]),</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> +<span class="gp">... </span><span class="n">dtype</span><span class="o">=</span><span class="nb">bool</span><span class="p">))</span> +<span class="go"><pyarrow.array.Int64Array object at 0x7f9019e11208></span> +<span class="go">[</span> +<span class="go"> 1,</span> +<span class="go"> NA</span> +<span class="go">]</span> +</pre></div> +</div> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><ul class="simple"> +<li><strong>array</strong> (<em>pyarrow.Array or pyarrow.ChunkedArray (if object data</em>)</li> +<li><em>overflowed binary storage)</em></li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt8Array.isnull"> +<code class="descname">isnull</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt8Array.isnull" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.lib.UInt8Array.null_count"> +<code class="descname">null_count</code><a class="headerlink" href="#pyarrow.lib.UInt8Array.null_count" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt8Array.slice"> +<code class="descname">slice</code><span class="sig-paren">(</span><em>self</em>, <em>offset=0</em>, <em>length=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt8Array.slice" title="Permalink to this definition">¶</a></dt> +<dd><p>Compute zero-copy slice of this array</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> +<li><strong>offset</strong> (<em>int</em><em>, </em><em>default 0</em>) – Offset from start of array to slice</li> +<li><strong>length</strong> (<em>int</em><em>, </em><em>default None</em>) – Length of slice (default is until end of Array starting from +offset)</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><strong>sliced</strong> (<em>RecordBatch</em>)</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt8Array.to_pandas"> +<code class="descname">to_pandas</code><span class="sig-paren">(</span><em>self</em>, <em>bool strings_to_categorical=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt8Array.to_pandas" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert to an array object suitable for use in pandas</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>strings_to_categorical</strong> (<em>boolean</em><em>, </em><em>default False</em>) – Encode string (UTF8) and binary types to pandas.Categorical</td> +</tr> +</tbody> +</table> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><code class="xref py py-meth docutils literal"><span class="pre">Column.to_pandas()</span></code>, <code class="xref py py-meth docutils literal"><span class="pre">Table.to_pandas()</span></code>, <code class="xref py py-meth docutils literal"><span class="pre">RecordBatch.to_pandas()</span></code></p> +</div> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt8Array.to_pylist"> +<code class="descname">to_pylist</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt8Array.to_pylist" title="Permalink to this definition">¶</a></dt> +<dd><p>Convert to an list of native Python objects.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.lib.UInt8Array.type"> +<code class="descname">type</code><a class="headerlink" href="#pyarrow.lib.UInt8Array.type" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.lib.UInt8Array.validate"> +<code class="descname">validate</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.lib.UInt8Array.validate" title="Permalink to this definition">¶</a></dt> +<dd><p>Perform any validation checks implemented by +arrow::ValidateArray. Raises exception with error message if array does +not validate</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">ArrowInvalid</span></code></td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.list_.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.list_.html b/docs/python/generated/pyarrow.list_.html index df5270b..b8d5b5d 100644 --- a/docs/python/generated/pyarrow.list_.html +++ b/docs/python/generated/pyarrow.list_.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -149,7 +150,7 @@ <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> -<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value_type</strong> (<a class="reference internal" href="pyarrow.DataType.html#pyarrow.DataType" title="pyarrow.DataType"><em>DataType</em></a><em> or </em><a class="reference internal" href="pyarrow.Field.html#pyarrow.Field" title="pyarrow.Field"><em>Field</em></a>) – </td> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value_type</strong> (<a class="reference internal" href="pyarrow.lib.DataType.html#pyarrow.lib.DataType" title="pyarrow.lib.DataType"><em>DataType</em></a><em> or </em><a class="reference internal" href="pyarrow.lib.Field.html#pyarrow.lib.Field" title="pyarrow.lib.Field"><em>Field</em></a>) – </td> </tr> <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>list_type</strong> (<em>DataType</em>)</td> </tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.memory_map.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.memory_map.html b/docs/python/generated/pyarrow.memory_map.html index 3013ee2..2bf6a24 100644 --- a/docs/python/generated/pyarrow.memory_map.html +++ b/docs/python/generated/pyarrow.memory_map.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.null.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.null.html b/docs/python/generated/pyarrow.null.html index 6ac4a12..aff5bed 100644 --- a/docs/python/generated/pyarrow.null.html +++ b/docs/python/generated/pyarrow.null.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.open_file.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.open_file.html b/docs/python/generated/pyarrow.open_file.html index 1f18d7e..8aba386 100644 --- a/docs/python/generated/pyarrow.open_file.html +++ b/docs/python/generated/pyarrow.open_file.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -105,7 +106,7 @@ </a> </li> <li> - <a href="pyarrow.open_stream.html" title="Next Chapter: pyarrow.open_stream"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.open_stream »</span> + <a href="pyarrow.open_stream.html" title="Next Chapter: pyarrow.open_stream"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.open_... »</span> </a> </li>
