This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 219d52d0 update documentation for tag main
219d52d0 is described below
commit 219d52d0011f8854d2f224b161ad877cae7a036b
Author: GitHub Actions <[email protected]>
AuthorDate: Fri May 17 19:12:51 2024 +0000
update documentation for tag main
---
main/genindex.html | 16 ++----------
main/objects.inv | Bin 20905 -> 20875 bytes
main/r/pkgdown.yml | 2 +-
main/reference/python/array-stream.html | 41 -----------------------------
main/reference/python/array.html | 44 ++------------------------------
main/searchindex.js | 2 +-
6 files changed, 6 insertions(+), 99 deletions(-)
diff --git a/main/genindex.html b/main/genindex.html
index d1e5e597..cf74c60f 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -1658,25 +1658,13 @@ document.write(`
<li><a
href="reference/python/schema.html#nanoarrow.schema.time64">time64() (in module
nanoarrow.schema)</a>
</li>
<li><a
href="reference/python/schema.html#nanoarrow.schema.timestamp">timestamp() (in
module nanoarrow.schema)</a>
-</li>
- <li><a
href="reference/python/schema.html#nanoarrow.schema.TimeUnit">TimeUnit (class
in nanoarrow.schema)</a>
-</li>
- <li><a
href="reference/python/schema.html#nanoarrow.schema.Schema.timezone">timezone
(Schema property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
- <li><a
href="reference/python/array.html#nanoarrow.array.Array.to_columns">to_columns()
(Array method)</a>
-
- <ul>
- <li><a
href="reference/python/array-stream.html#nanoarrow.array_stream.ArrayStream.to_columns">(ArrayStream
method)</a>
+ <li><a
href="reference/python/schema.html#nanoarrow.schema.TimeUnit">TimeUnit (class
in nanoarrow.schema)</a>
</li>
- </ul></li>
- <li><a
href="reference/python/array.html#nanoarrow.array.Array.to_pylist">to_pylist()
(Array method)</a>
-
- <ul>
- <li><a
href="reference/python/array-stream.html#nanoarrow.array_stream.ArrayStream.to_pylist">(ArrayStream
method)</a>
+ <li><a
href="reference/python/schema.html#nanoarrow.schema.Schema.timezone">timezone
(Schema property)</a>
</li>
- </ul></li>
<li><a href="reference/python/schema.html#nanoarrow.schema.Type">Type
(class in nanoarrow.schema)</a>
</li>
<li><a
href="reference/python/schema.html#nanoarrow.schema.Schema.type">type (Schema
property)</a>
diff --git a/main/objects.inv b/main/objects.inv
index a8f7a7e0..48ce98a4 100644
Binary files a/main/objects.inv and b/main/objects.inv differ
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 80cf9c35..74fa9864 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.3
pkgdown: 2.0.9
pkgdown_sha: ~
articles: {}
-last_built: 2024-05-17T17:49Z
+last_built: 2024-05-17T19:12Z
diff --git a/main/reference/python/array-stream.html
b/main/reference/python/array-stream.html
index 7685094d..cc15514c 100644
--- a/main/reference/python/array-stream.html
+++ b/main/reference/python/array-stream.html
@@ -642,45 +642,6 @@ in this stream.</p>
</div>
</dd></dl>
-<dl class="py method">
-<dt class="sig sig-object py"
id="nanoarrow.array_stream.ArrayStream.to_columns">
-<span class="sig-name descname"><span
class="pre">to_columns</span></span><span class="sig-paren">(</span><span
class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span
class="pre">str</span><span class="p"><span class="pre">,</span></span><span
class="w"> </span><span class="pre">Sequence</span><span class="p"><span
class="pre">] [...]
-<dd><p>Convert this Array to a <a href="#id8"><span class="problematic"
id="id9">``</span></a>list()` of sequences</p>
-<p>Converts a stream of struct arrays into its column-wise representation
-such that each column is either a contiguous buffer or a <code class="docutils
literal notranslate"><span class="pre">list()</span></code>.</p>
-<section id="id10">
-<h3>Examples<a class="headerlink" href="#id10" title="Link to this
heading">#</a></h3>
-<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</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">batch</span> <span
class="o">=</span> <span class="n">pa</span><span class="o">.</span><span
class="n">record_batch</span><span class="p">([</span><span
class="n">pa</span><span class="o">.</span><span class="n">array</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="mi">3</span><span
class="p">])],</span> <span class="n">names</span><span cla [...]
-<span class="gp">>>> </span><span class="n">stream</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">ArrayStream</span><span class="p">(</span><span
class="n">batch</span><span class="p">)</span>
-<span class="gp">>>> </span><span class="n">names</span><span
class="p">,</span> <span class="n">columns</span> <span class="o">=</span>
<span class="n">stream</span><span class="o">.</span><span
class="n">to_columns</span><span class="p">()</span>
-<span class="gp">>>> </span><span class="n">names</span>
-<span class="go">['col1']</span>
-<span class="gp">>>> </span><span class="n">columns</span>
-<span class="go">[[1, 2, 3]]</span>
-</pre></div>
-</div>
-</section>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py"
id="nanoarrow.array_stream.ArrayStream.to_pylist">
-<span class="sig-name descname"><span class="pre">to_pylist</span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span
class="sig-return-typehint"><span class="pre">List</span></span></span><a
class="headerlink" href="#nanoarrow.array_stream.ArrayStream.to_pylist"
title="Link to this definition">#</a></dt>
-<dd><p>Convert this Array to a <a href="#id11"><span class="problematic"
id="id12">``</span></a>list()` of Python objects</p>
-<p>Computes an identical value to list(<a class="reference internal"
href="#nanoarrow.array_stream.ArrayStream.iter_py"
title="nanoarrow.array_stream.ArrayStream.iter_py"><code class="xref py py-meth
docutils literal notranslate"><span class="pre">iter_py()</span></code></a>)
but can be several
-times faster.</p>
-<section id="id13">
-<h3>Examples<a class="headerlink" href="#id13" title="Link to this
heading">#</a></h3>
-<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
-<span class="gp">>>> </span><span class="n">stream</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">ArrayStream</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="mi">3</span><span class="p">],</span> <span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">())</span>
-<span class="gp">>>> </span><span class="n">stream</span><span
class="o">.</span><span class="n">to_pylist</span><span class="p">()</span>
-<span class="go">[1, 2, 3]</span>
-</pre></div>
-</div>
-</section>
-</dd></dl>
-
</section>
</dd></dl>
@@ -743,8 +704,6 @@ times faster.</p>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array_stream.ArrayStream.read_all"><code class="docutils
literal notranslate"><span
class="pre">ArrayStream.read_all()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array_stream.ArrayStream.read_next"><code class="docutils
literal notranslate"><span
class="pre">ArrayStream.read_next()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array_stream.ArrayStream.schema"><code class="docutils literal
notranslate"><span class="pre">ArrayStream.schema</span></code></a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array_stream.ArrayStream.to_columns"><code class="docutils
literal notranslate"><span
class="pre">ArrayStream.to_columns()</span></code></a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array_stream.ArrayStream.to_pylist"><code class="docutils
literal notranslate"><span
class="pre">ArrayStream.to_pylist()</span></code></a></li>
</ul>
</li>
</ul>
diff --git a/main/reference/python/array.html b/main/reference/python/array.html
index e89fbc36..9109f597 100644
--- a/main/reference/python/array.html
+++ b/main/reference/python/array.html
@@ -788,44 +788,6 @@ contiguous in memory.</p>
<dd><p>Get the schema (data type) of this Array</p>
</dd></dl>
-<dl class="py method">
-<dt class="sig sig-object py" id="nanoarrow.array.Array.to_columns">
-<span class="sig-name descname"><span
class="pre">to_columns</span></span><span class="sig-paren">(</span><span
class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span
class="pre">str</span><span class="p"><span class="pre">,</span></span><span
class="w"> </span><span class="pre">Sequence</span><span class="p"><span
class="pre">] [...]
-<dd><p>Convert this Array to a <a href="#id22"><span class="problematic"
id="id23">``</span></a>list()` of sequences</p>
-<p>Converts a stream of struct arrays into its column-wise representation
-such that each column is either a contiguous buffer or a <code class="docutils
literal notranslate"><span class="pre">list()</span></code>.</p>
-<section id="id24">
-<h3>Examples<a class="headerlink" href="#id24" title="Link to this
heading">#</a></h3>
-<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</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">array</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">Array</span><span class="p">(</span><span class="n">pa</span><span
class="o">.</span><span class="n">record_batch</span><span
class="p">([</span><span class="n">pa</span><span class="o">.</span><span
class="n">array</span><span class="p">([</span><span class="mi">1</span><span
class="p">,</span> <span class="mi">2</span><span class="p [...]
-<span class="gp">>>> </span><span class="n">names</span><span
class="p">,</span> <span class="n">columns</span> <span class="o">=</span>
<span class="n">array</span><span class="o">.</span><span
class="n">to_columns</span><span class="p">()</span>
-<span class="gp">>>> </span><span class="n">names</span>
-<span class="go">['col1']</span>
-<span class="gp">>>> </span><span class="n">columns</span>
-<span class="go">[[1, 2, 3]]</span>
-</pre></div>
-</div>
-</section>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="nanoarrow.array.Array.to_pylist">
-<span class="sig-name descname"><span class="pre">to_pylist</span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span
class="sig-return-typehint"><span class="pre">List</span></span></span><a
class="headerlink" href="#nanoarrow.array.Array.to_pylist" title="Link to this
definition">#</a></dt>
-<dd><p>Convert this Array to a <a href="#id25"><span class="problematic"
id="id26">``</span></a>list()` of Python objects</p>
-<p>Computes an identical value to list(<a class="reference internal"
href="#nanoarrow.array.Array.iter_py"
title="nanoarrow.array.Array.iter_py"><code class="xref py py-meth docutils
literal notranslate"><span class="pre">iter_py()</span></code></a>) but can be
several
-times faster.</p>
-<section id="id27">
-<h3>Examples<a class="headerlink" href="#id27" title="Link to this
heading">#</a></h3>
-<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
-<span class="gp">>>> </span><span class="n">array</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">Array</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="mi">3</span><span class="p">],</span> <span class="n">na</span><span
class="o">.</span><span class="n">int32</span><span class="p">())</span>
-<span class="gp">>>> </span><span class="n">array</span><span
class="o">.</span><span class="n">to_pylist</span><span class="p">()</span>
-<span class="go">[1, 2, 3]</span>
-</pre></div>
-</div>
-</section>
-</dd></dl>
-
</section>
</dd></dl>
@@ -840,8 +802,8 @@ an <a class="reference internal"
href="#nanoarrow.array.Array" title="nanoarrow.
<p>Note that it is rarely efficient to iterate over Scalar objects:
use the iterators in <code class="xref py py-mod docutils literal
notranslate"><span class="pre">nanoarrow.iterator</span></code> to more
effectively
iterate over an <a class="reference internal" href="#nanoarrow.array.Array"
title="nanoarrow.array.Array"><code class="xref py py-class docutils literal
notranslate"><span class="pre">Array</span></code></a>.</p>
-<section id="id28">
-<h2>Examples<a class="headerlink" href="#id28" title="Link to this
heading">#</a></h2>
+<section id="id22">
+<h2>Examples<a class="headerlink" href="#id22" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">array</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">Array</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="mi">3</span><span class="p">],</span> <span class="n">na</span><span
class="o">.</span><span class="n">int32</span><span class="p">())</span>
<span class="gp">>>> </span><span class="n">array</span><span
class="p">[</span><span class="mi">0</span><span class="p">]</span>
@@ -941,8 +903,6 @@ iterate over an <a class="reference internal"
href="#nanoarrow.array.Array" titl
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Array.n_chunks"><code class="docutils literal
notranslate"><span class="pre">Array.n_chunks</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Array.offset"><code class="docutils literal
notranslate"><span class="pre">Array.offset</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Array.schema"><code class="docutils literal
notranslate"><span class="pre">Array.schema</span></code></a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Array.to_columns"><code class="docutils literal
notranslate"><span class="pre">Array.to_columns()</span></code></a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Array.to_pylist"><code class="docutils literal
notranslate"><span class="pre">Array.to_pylist()</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Scalar"><code class="docutils literal notranslate"><span
class="pre">Scalar</span></code></a><ul class="visible nav section-nav
flex-column">
diff --git a/main/searchindex.js b/main/searchindex.js
index ae57610f..edd3037a 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[8, "api-reference"]], "Array
Stream utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[ [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[8, "api-reference"]], "Array
Stream utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[ [...]
\ No newline at end of file
