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 9cc37283 update documentation for tag main
9cc37283 is described below
commit 9cc37283206e2a749b609a31110ffc889d7417da
Author: GitHub Actions <[email protected]>
AuthorDate: Tue Oct 1 17:19:14 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1164310 -> 1180895 bytes
main/.doctrees/reference/c.doctree | Bin 701696 -> 729450 bytes
main/genindex.html | 14 +++++++++++--
main/objects.inv | Bin 17649 -> 17870 bytes
main/r/pkgdown.yml | 2 +-
main/reference/c.html | 40 +++++++++++++++++++++++++++++++++++++
main/searchindex.js | 2 +-
7 files changed, 54 insertions(+), 4 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 6c3bf9ef..572a8a94 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/.doctrees/reference/c.doctree
b/main/.doctrees/reference/c.doctree
index 10ffc4d5..a8001fbb 100644
Binary files a/main/.doctrees/reference/c.doctree and
b/main/.doctrees/reference/c.doctree differ
diff --git a/main/genindex.html b/main/genindex.html
index f1e55450..d5612e1d 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -492,6 +492,14 @@ document.write(`
<li><a
href="reference/c.html#_CPPv421ArrowArrayViewComparePK14ArrowArrayViewPK14ArrowArrayView17ArrowCompareLevelPiP10ArrowError">ArrowArrayViewCompare
(C++ function)</a>
</li>
<li><a
href="reference/c.html#_CPPv430ArrowArrayViewComputeNullCountPK14ArrowArrayView">ArrowArrayViewComputeNullCount
(C++ function)</a>
+</li>
+ <li><a
href="reference/c.html#_CPPv431ArrowArrayViewGetBufferDataTypeP14ArrowArrayView7int64_t">ArrowArrayViewGetBufferDataType
(C++ function)</a>
+</li>
+ <li><a
href="reference/c.html#_CPPv438ArrowArrayViewGetBufferElementSizeBitsP14ArrowArrayView7int64_t">ArrowArrayViewGetBufferElementSizeBits
(C++ function)</a>
+</li>
+ <li><a
href="reference/c.html#_CPPv427ArrowArrayViewGetBufferTypeP14ArrowArrayView7int64_t">ArrowArrayViewGetBufferType
(C++ function)</a>
+</li>
+ <li><a
href="reference/c.html#_CPPv427ArrowArrayViewGetBufferViewP14ArrowArrayView7int64_t">ArrowArrayViewGetBufferView
(C++ function)</a>
</li>
<li><a
href="reference/c.html#_CPPv428ArrowArrayViewGetBytesUnsafePK14ArrowArrayView7int64_t">ArrowArrayViewGetBytesUnsafe
(C++ function)</a>
</li>
@@ -500,6 +508,8 @@ document.write(`
<li><a
href="reference/c.html#_CPPv429ArrowArrayViewGetDoubleUnsafePK14ArrowArrayView7int64_t">ArrowArrayViewGetDoubleUnsafe
(C++ function)</a>
</li>
<li><a
href="reference/c.html#_CPPv426ArrowArrayViewGetIntUnsafePK14ArrowArrayView7int64_t">ArrowArrayViewGetIntUnsafe
(C++ function)</a>
+</li>
+ <li><a
href="reference/c.html#_CPPv427ArrowArrayViewGetNumBuffersP14ArrowArrayView">ArrowArrayViewGetNumBuffers
(C++ function)</a>
</li>
<li><a
href="reference/c.html#_CPPv429ArrowArrayViewGetStringUnsafePK14ArrowArrayView7int64_t">ArrowArrayViewGetStringUnsafe
(C++ function)</a>
</li>
@@ -679,14 +689,14 @@ document.write(`
</li>
<li><a
href="reference/device.html#_CPPv424ArrowDeviceArrayViewInitP20ArrowDeviceArrayView">ArrowDeviceArrayViewInit
(C++ function)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv425ArrowDeviceArrayViewResetP20ArrowDeviceArrayView">ArrowDeviceArrayViewReset
(C++ function)</a>
</li>
<li><a
href="reference/device.html#_CPPv428ArrowDeviceArrayViewSetArrayP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError">ArrowDeviceArrayViewSetArray
(C++ function)</a>
</li>
<li><a
href="reference/device.html#_CPPv433ArrowDeviceArrayViewSetArrayAsyncP20ArrowDeviceArrayViewP16ArrowDeviceArrayPvP10ArrowError">ArrowDeviceArrayViewSetArrayAsync
(C++ function)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv435ArrowDeviceArrayViewSetArrayMinimalP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError">ArrowDeviceArrayViewSetArrayMinimal
(C++ function)</a>
</li>
<li><a
href="reference/device.html#_CPPv431ArrowDeviceBasicArrayStreamInitP22ArrowDeviceArrayStreamP16ArrowArrayStreamP11ArrowDevice">ArrowDeviceBasicArrayStreamInit
(C++ function)</a>
diff --git a/main/objects.inv b/main/objects.inv
index 904e1192..4a398278 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 1ee319a3..eed7bd26 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2024-09-30T17:00Z
+last_built: 2024-10-01T17:18Z
diff --git a/main/reference/c.html b/main/reference/c.html
index cb37d481..d5c7cba8 100644
--- a/main/reference/c.html
+++ b/main/reference/c.html
@@ -899,6 +899,41 @@ document.write(`
<dd><p>Set buffer sizes and data pointers from an ArrowArray except for those
that require dereferencing buffer content. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv427ArrowArrayViewGetNumBuffersP14ArrowArrayView">
+<span id="_CPPv327ArrowArrayViewGetNumBuffersP14ArrowArrayView"></span><span
id="_CPPv227ArrowArrayViewGetNumBuffersP14ArrowArrayView"></span><span
id="ArrowArrayViewGetNumBuffers__ArrowArrayViewP"></span><span class="target"
id="group__nanoarrow-array-view_1ga90f2d1fde8869d738087906df374f5f8"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="n"><span class="pre"> [...]
+<dd><p>Get the number of buffers. </p>
+<p>The number of buffers referred to by this ArrowArrayView. In may cases this
can also be calculated from the ArrowLayout member of the ArrowArrayView or <a
class="reference internal" href="#struct_arrow_schema_view"><span class="std
std-ref">ArrowSchemaView</span></a>; however, for binary view and string view
types, the number of total buffers depends on the number of variadic buffers.
</p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv427ArrowArrayViewGetBufferViewP14ArrowArrayView7int64_t">
+<span
id="_CPPv327ArrowArrayViewGetBufferViewP14ArrowArrayView7int64_t"></span><span
id="_CPPv227ArrowArrayViewGetBufferViewP14ArrowArrayView7int64_t"></span><span
id="ArrowArrayViewGetBufferView__ArrowArrayViewP.int64_t"></span><span
class="target"
id="group__nanoarrow-array-view_1ga33fb22451b0b859aaf3d864bd6f59d8a"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
clas [...]
+<dd><p>Get a view of a specific buffer from an ArrowArrayView. </p>
+<p>This is the ArrowArrayView equivalent of ArrowArray::buffers[i] that
includes size information (if known). </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv427ArrowArrayViewGetBufferTypeP14ArrowArrayView7int64_t">
+<span
id="_CPPv327ArrowArrayViewGetBufferTypeP14ArrowArrayView7int64_t"></span><span
id="_CPPv227ArrowArrayViewGetBufferTypeP14ArrowArrayView7int64_t"></span><span
id="ArrowArrayViewGetBufferType__ArrowArrayViewP.int64_t"></span><span
class="target"
id="group__nanoarrow-array-view_1gaefdebe8cb2775e55aa1fe8d7aa530902"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
clas [...]
+<dd><p>Get the function of a specific buffer in an ArrowArrayView. </p>
+<p>In may cases this can also be obtained from the ArrowLayout member of the
ArrowArrayView or <a class="reference internal"
href="#struct_arrow_schema_view"><span class="std
std-ref">ArrowSchemaView</span></a>; however, for binary view and string view
types, the function of each buffer may be different between two arrays of the
same type depending on the number of variadic buffers. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv431ArrowArrayViewGetBufferDataTypeP14ArrowArrayView7int64_t">
+<span
id="_CPPv331ArrowArrayViewGetBufferDataTypeP14ArrowArrayView7int64_t"></span><span
id="_CPPv231ArrowArrayViewGetBufferDataTypeP14ArrowArrayView7int64_t"></span><span
id="ArrowArrayViewGetBufferDataType__ArrowArrayViewP.int64_t"></span><span
class="target"
id="group__nanoarrow-array-view_1ga9c74b21f79021d74854ec00861325e86"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </spa [...]
+<dd><p>Get the data type of a specific buffer in an ArrowArrayView. </p>
+<p>In may cases this can also be obtained from the ArrowLayout member of the
ArrowArrayView or <a class="reference internal"
href="#struct_arrow_schema_view"><span class="std
std-ref">ArrowSchemaView</span></a>; however, for binary view and string view
types, the data type of each buffer may be different between two arrays of the
same type depending on the number of variadic buffers. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv438ArrowArrayViewGetBufferElementSizeBitsP14ArrowArrayView7int64_t">
+<span
id="_CPPv338ArrowArrayViewGetBufferElementSizeBitsP14ArrowArrayView7int64_t"></span><span
id="_CPPv238ArrowArrayViewGetBufferElementSizeBitsP14ArrowArrayView7int64_t"></span><span
id="ArrowArrayViewGetBufferElementSizeBits__ArrowArrayViewP.int64_t"></span><span
class="target"
id="group__nanoarrow-array-view_1ga0a842aa0755ffaaadb8126b5fca3dbd4"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span>< [...]
+<dd><p>Get the element size (in bits) of a specific buffer in an
ArrowArrayView. </p>
+<p>In may cases this can also be obtained from the ArrowLayout member of the
ArrowArrayView or <a class="reference internal"
href="#struct_arrow_schema_view"><span class="std
std-ref">ArrowSchemaView</span></a>; however, for binary view and string view
types, the element width of each buffer may be different between two arrays of
the same type depending on the number of variadic buffers. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv422ArrowArrayViewValidateP14ArrowArrayView20ArrowValidationLevelP10ArrowError">
<span
id="_CPPv322ArrowArrayViewValidateP14ArrowArrayView20ArrowValidationLevelP10ArrowError"></span><span
id="_CPPv222ArrowArrayViewValidateP14ArrowArrayView20ArrowValidationLevelP10ArrowError"></span><span
id="ArrowArrayViewValidate__ArrowArrayViewP.ArrowValidationLevel.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array-view_1gaad1f410d559f83791c471313846970bd"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="sig [...]
@@ -1621,6 +1656,11 @@ document.write(`
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv423ArrowArrayViewSetLengthP14ArrowArrayView7int64_t"><code
class="docutils literal notranslate"><span
class="pre">ArrowArrayViewSetLength()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv422ArrowArrayViewSetArrayP14ArrowArrayViewPK10ArrowArrayP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowArrayViewSetArray()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv429ArrowArrayViewSetArrayMinimalP14ArrowArrayViewPK10ArrowArrayP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowArrayViewSetArrayMinimal()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv427ArrowArrayViewGetNumBuffersP14ArrowArrayView"><code
class="docutils literal notranslate"><span
class="pre">ArrowArrayViewGetNumBuffers()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv427ArrowArrayViewGetBufferViewP14ArrowArrayView7int64_t"><code
class="docutils literal notranslate"><span
class="pre">ArrowArrayViewGetBufferView()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv427ArrowArrayViewGetBufferTypeP14ArrowArrayView7int64_t"><code
class="docutils literal notranslate"><span
class="pre">ArrowArrayViewGetBufferType()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv431ArrowArrayViewGetBufferDataTypeP14ArrowArrayView7int64_t"><code
class="docutils literal notranslate"><span
class="pre">ArrowArrayViewGetBufferDataType()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv438ArrowArrayViewGetBufferElementSizeBitsP14ArrowArrayView7int64_t"><code
class="docutils literal notranslate"><span
class="pre">ArrowArrayViewGetBufferElementSizeBits()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv422ArrowArrayViewValidateP14ArrowArrayView20ArrowValidationLevelP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowArrayViewValidate()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv421ArrowArrayViewComparePK14ArrowArrayViewPK14ArrowArrayView17ArrowCompareLevelPiP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowArrayViewCompare()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv419ArrowArrayViewResetP14ArrowArrayView"><code class="docutils
literal notranslate"><span
class="pre">ArrowArrayViewReset()</span></code></a></li>
diff --git a/main/searchindex.js b/main/searchindex.js
index 3f60b004..171e3017 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[8, null]], "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": [[5, "bitmap-
[...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[8, null]], "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": [[5, "bitmap-
[...]
\ No newline at end of file
