This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 7d46a82 update documentation for tag dev
7d46a82 is described below
commit 7d46a82c7a3e603876ff94a8b2d8ca6a80e1e210
Author: GitHub Actions <[email protected]>
AuthorDate: Thu May 25 01:36:45 2023 +0000
update documentation for tag dev
---
dev/c.html | 33 +++++++++++++++++++------
dev/genindex.html | 12 ++++++---
dev/objects.inv | Bin 16277 -> 16373 bytes
dev/r/pkgdown.yml | 2 +-
dev/r/reference/as_nanoarrow_array.html | 4 +--
dev/r/reference/as_nanoarrow_array_stream.html | 2 +-
dev/r/reference/as_nanoarrow_buffer.html | 4 +--
dev/r/search.json | 2 +-
dev/searchindex.js | 2 +-
9 files changed, 43 insertions(+), 18 deletions(-)
diff --git a/dev/c.html b/dev/c.html
index 9bb2583..595b33a 100644
--- a/dev/c.html
+++ b/dev/c.html
@@ -815,7 +815,7 @@ document.write(`
<dl>
<dt class="sig sig-object cpp">
<span class="target" id="group__nanoarrow-array-view"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow-array-view</span></span></dt>
-<dd><p>These functions read and validate the contents <a class="reference
internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> structures </p>
+<dd><p>These functions read and validate the contents <a class="reference
internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> structures. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
@@ -897,9 +897,10 @@ document.write(`
</dd></dl>
<dl class="cpp function">
-<dt class="sig sig-object cpp"
id="_CPPv426ArrowArrayViewValidateFullP14ArrowArrayViewP10ArrowError">
-<span
id="_CPPv326ArrowArrayViewValidateFullP14ArrowArrayViewP10ArrowError"></span><span
id="_CPPv226ArrowArrayViewValidateFullP14ArrowArrayViewP10ArrowError"></span><span
id="ArrowArrayViewValidateFull__ArrowArrayViewP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array-view_1ga5bca185fdd0f63fbd3e36ad0ecad6088"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span [...]
-<dd><p>Performs extra checks on the array that was set via <a class="reference
internal"
href="#group__nanoarrow-array-view_1gada04cd33265cf33ded2701fb1e365648"><span
class="std std-ref">ArrowArrayViewSetArray()</span></a></p>
+<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><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><s [...]
+<dd><p>Performs checks on the content of an <a class="reference internal"
href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a>. </p>
+<p>If using <a class="reference internal"
href="#group__nanoarrow-array-view_1gada04cd33265cf33ded2701fb1e365648"><span
class="std std-ref">ArrowArrayViewSetArray()</span></a> to back array_view with
an <a class="reference internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a>, the buffer sizes and some content (fist and
last offset) have already been validated at the “default” level. If setting the
buffer pointers and sizes otherwise, you may wish to perfor [...]
</dd></dl>
<dl class="cpp function">
@@ -981,13 +982,31 @@ document.write(`
<dd><div class="docutils container">
<em>#include <nanoarrow_types.h></em></div>
<p>A non-owning view of an <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>. </p>
-<p>This data structure provides access to the values contained within an <a
class="reference internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> with fields provided in a more
readily-extractible form. You can re-use an <a class="reference internal"
href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> for multiple ArrowArrays with the same
storage type, or use it to represent a hypothetical <a class="reference
internal" href [...]
+<p>This data structure provides access to the values contained within an <a
class="reference internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> with fields provided in a more
readily-extractible form. You can re-use an <a class="reference internal"
href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> for multiple ArrowArrays with the same
storage type, use it to represent a hypothetical <a class="reference internal"
href="# [...]
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N14ArrowArrayView5arrayE">
<span id="_CPPv3N14ArrowArrayView5arrayE"></span><span
id="_CPPv2N14ArrowArrayView5arrayE"></span><span
id="ArrowArrayView::array__ArrowArrayP"></span><span class="target"
id="struct_arrow_array_view_1a3035bf0a4b816cf1ea002575fe1f7182"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv410ArrowArray" title="ArrowArray"><span
class="n"><span class="pre">ArrowArray</span></span></a><span class="w">
</span><span cla [...]
-<dd><p>The underlying <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a> or
NULL if it has not been set. </p>
+<dd><p>The underlying <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a> or
NULL if it has not been set or if the buffers in this <a class="reference
internal" href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> are not backed by an <a class="reference
internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a>. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N14ArrowArrayView6offsetE">
+<span id="_CPPv3N14ArrowArrayView6offsetE"></span><span
id="_CPPv2N14ArrowArrayView6offsetE"></span><span
id="ArrowArrayView::offset__int64_t"></span><span class="target"
id="struct_arrow_array_view_1ab45c8f3ebbcb199d374bcc9b4e42cf7b"></span><span
class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">offset</span></span></span><a class="headerlink"
href="#_CPPv4N14ArrowArrayView6offsetE" title="Permalink [...]
+<dd><p>The number of elements from the physical start of the buffers. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N14ArrowArrayView6lengthE">
+<span id="_CPPv3N14ArrowArrayView6lengthE"></span><span
id="_CPPv2N14ArrowArrayView6lengthE"></span><span
id="ArrowArrayView::length__int64_t"></span><span class="target"
id="struct_arrow_array_view_1a805ba1ff0745735b4eb8b63f34a515c0"></span><span
class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">length</span></span></span><a class="headerlink"
href="#_CPPv4N14ArrowArrayView6lengthE" title="Permalink [...]
+<dd><p>The number of elements in this view. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N14ArrowArrayView10null_countE">
+<span id="_CPPv3N14ArrowArrayView10null_countE"></span><span
id="_CPPv2N14ArrowArrayView10null_countE"></span><span
id="ArrowArrayView::null_count__int64_t"></span><span class="target"
id="struct_arrow_array_view_1afc995e6f9d9e4d7141c6e3ec145f7e46"></span><span
class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">null_count</span></span></span><a class="headerlink"
href="#_CPPv4N14ArrowArrayView10null_c [...]
+<dd><p>A cached null count or -1 to indicate that this value is unknown. </p>
</dd></dl>
<dl class="cpp var">
@@ -1946,7 +1965,7 @@ document.write(`
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N15ArrowBufferView4dataE">
-<span id="_CPPv3N15ArrowBufferView4dataE"></span><span
id="_CPPv2N15ArrowBufferView4dataE"></span><span class="target"
id="struct_arrow_buffer_view_1ae833e1df12c16e394e495dcb5e46a446"></span><span
class="k"><span class="pre">union</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv415ArrowBufferView"
title="ArrowBufferView"><span class="n"><span
class="pre">ArrowBufferView</span></span></a><span class="p"><span
class="pre">::</span></span><span class="n"><span [...]
+<span id="_CPPv3N15ArrowBufferView4dataE"></span><span
id="_CPPv2N15ArrowBufferView4dataE"></span><span
id="ArrowBufferView::data__ArrowBufferViewData"></span><span class="target"
id="struct_arrow_buffer_view_1a0eb1861e51c3d44a79449841abdff7cf"></span><span
class="k"><span class="pre">union</span></span><span class="w"> </span><span
class="n"><span class="pre">ArrowBufferViewData</span></span><span class="w">
</span><span class="sig-name descname"><span class="n"><span class="pre">data</
[...]
<dd><p>A pointer to the start of the buffer. </p>
<p>If size_bytes is 0, this value may be NULL. </p>
</dd></dl>
diff --git a/dev/genindex.html b/dev/genindex.html
index 0361f8d..62f5b11 100644
--- a/dev/genindex.html
+++ b/dev/genindex.html
@@ -455,8 +455,14 @@ document.write(`
<li><a
href="c.html#_CPPv4N14ArrowArrayView8childrenE">ArrowArrayView::children (C++
member)</a>
</li>
<li><a
href="c.html#_CPPv4N14ArrowArrayView6layoutE">ArrowArrayView::layout (C++
member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N14ArrowArrayView6lengthE">ArrowArrayView::length (C++
member)</a>
</li>
<li><a
href="c.html#_CPPv4N14ArrowArrayView10n_childrenE">ArrowArrayView::n_children
(C++ member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N14ArrowArrayView10null_countE">ArrowArrayView::null_count
(C++ member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N14ArrowArrayView6offsetE">ArrowArrayView::offset (C++
member)</a>
</li>
<li><a
href="c.html#_CPPv4N14ArrowArrayView12storage_typeE">ArrowArrayView::storage_type
(C++ member)</a>
</li>
@@ -496,7 +502,7 @@ document.write(`
</li>
<li><a
href="c.html#_CPPv425ArrowArrayViewUnionTypeIdP14ArrowArrayView7int64_t">ArrowArrayViewUnionTypeId
(C++ function)</a>
</li>
- <li><a
href="c.html#_CPPv426ArrowArrayViewValidateFullP14ArrowArrayViewP10ArrowError">ArrowArrayViewValidateFull
(C++ function)</a>
+ <li><a
href="c.html#_CPPv422ArrowArrayViewValidateP14ArrowArrayView20ArrowValidationLevelP10ArrowError">ArrowArrayViewValidate
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv413ArrowBitClearP7uint8_t7int64_t">ArrowBitClear (C++
function)</a>
</li>
@@ -676,12 +682,12 @@ document.write(`
</li>
<li><a
href="ipc.html#_CPPv4N23ArrowIpcCompressionType35NANOARROW_IPC_COMPRESSION_TYPE_ZSTDE">ArrowIpcCompressionType::NANOARROW_IPC_COMPRESSION_TYPE_ZSTD
(C++ enumerator)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ipc.html#_CPPv415ArrowIpcDecoder">ArrowIpcDecoder (C++
struct)</a>
</li>
<li><a
href="ipc.html#_CPPv4N15ArrowIpcDecoder15body_size_bytesE">ArrowIpcDecoder::body_size_bytes
(C++ member)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="ipc.html#_CPPv4N15ArrowIpcDecoder5codecE">ArrowIpcDecoder::codec (C++
member)</a>
</li>
<li><a
href="ipc.html#_CPPv4N15ArrowIpcDecoder10endiannessE">ArrowIpcDecoder::endianness
(C++ member)</a>
diff --git a/dev/objects.inv b/dev/objects.inv
index f2dd6e5..603727a 100644
Binary files a/dev/objects.inv and b/dev/objects.inv differ
diff --git a/dev/r/pkgdown.yml b/dev/r/pkgdown.yml
index af2222c..8ed1be2 100644
--- a/dev/r/pkgdown.yml
+++ b/dev/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.9.2.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-05-24T17:19Z
+last_built: 2023-05-25T01:36Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index 9874505..9fd2eed 100644
--- a/dev/r/reference/as_nanoarrow_array.html
+++ b/dev/r/reference/as_nanoarrow_array.html
@@ -97,7 +97,7 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<span class="r-out co"><span class="r-pr">#></span> $ offset : int
0</span>
<span class="r-out co"><span class="r-pr">#></span> $ buffers :List of
2</span>
<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_validity[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55b03b28fe28></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x564bd2c31a98></span>
<span class="r-out co"><span class="r-pr">#></span> $ dictionary:
NULL</span>
<span class="r-out co"><span class="r-pr">#></span> $ children :
list()</span>
<span class="r-in"><span><span class="fu"><a
href="https://rdrr.io/r/base/vector.html";
class="external-link">as.vector</a></span><span class="op">(</span><span
class="va">array</span><span class="op">)</span></span></span>
@@ -117,7 +117,7 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<span class="r-out co"><span class="r-pr">#></span> .. ..$ offset :
int 0</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ buffers
:List of 2</span>
<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_validity[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55b03be03c48></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x564bd34f3778></span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ dictionary:
NULL</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ children :
list()</span>
<span class="r-out co"><span class="r-pr">#></span> $ dictionary:
NULL</span>
diff --git a/dev/r/reference/as_nanoarrow_array_stream.html
b/dev/r/reference/as_nanoarrow_array_stream.html
index 2310e4e..c84c637 100644
--- a/dev/r/reference/as_nanoarrow_array_stream.html
+++ b/dev/r/reference/as_nanoarrow_array_stream.html
@@ -133,7 +133,7 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<span class="r-out co"><span class="r-pr">#></span> .. ..$ offset :
int 0</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ buffers
:List of 2</span>
<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_validity[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55b03d17c608></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x564bd485f1a8></span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ dictionary:
NULL</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ children :
list()</span>
<span class="r-out co"><span class="r-pr">#></span> $ dictionary:
NULL</span>
diff --git a/dev/r/reference/as_nanoarrow_buffer.html
b/dev/r/reference/as_nanoarrow_buffer.html
index 91f0ed1..b5ee54e 100644
--- a/dev/r/reference/as_nanoarrow_buffer.html
+++ b/dev/r/reference/as_nanoarrow_buffer.html
@@ -72,12 +72,12 @@
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor"
href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="va">array</span> <span class="op"><-</span>
<span class="fu"><a
href="as_nanoarrow_array.html">as_nanoarrow_array</a></span><span
class="op">(</span><span class="fl">1</span><span class="op">:</span><span
class="fl">4</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">array</span><span
class="op">$</span><span class="va">buffers</span><span
class="op">[[</span><span class="fl">2</span><span class="op">]</span><span
class="op">]</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span>
<nanoarrow_buffer_data_int32[16 b] at 0x55b03b9d8f68></span>
+<span class="r-out co"><span class="r-pr">#></span>
<nanoarrow_buffer_data_int32[16 b] at 0x564bd27d0dd8></span>
<span class="r-in"><span><span class="fu"><a
href="https://rdrr.io/r/base/raw.html";
class="external-link">as.raw</a></span><span class="op">(</span><span
class="va">array</span><span class="op">$</span><span
class="va">buffers</span><span class="op">[[</span><span
class="fl">2</span><span class="op">]</span><span class="op">]</span><span
class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> [1] 01 00 00 00 02 00
00 00 03 00 00 00 04 00 00 00</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="fu">as_nanoarrow_buffer</span><span
class="op">(</span><span class="fl">1</span><span class="op">:</span><span
class="fl">5</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> <nanoarrow_buffer[20
b] at 0x55b03bf8cbf8></span>
+<span class="r-out co"><span class="r-pr">#></span> <nanoarrow_buffer[20
b] at 0x564bd308b418></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">buffer</span> <span
class="op"><-</span> <span class="fu">as_nanoarrow_buffer</span><span
class="op">(</span><span class="cn">NULL</span><span
class="op">)</span></span></span>
<span class="r-in"><span></span></span>
diff --git a/dev/r/search.json b/dev/r/search.json
index f6b4e94..ed98b4a 100644
--- a/dev/r/search.json
+++ b/dev/r/search.json
@@ -1 +1 @@
-[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections 1 9 [...]
+[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections 1 9 [...]
diff --git a/dev/searchindex.js b/dev/searchindex.js
index a310e13..a034504 100644
--- a/dev/searchindex.js
+++ b/dev/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["c", "cpp", "getting-started",
"getting-started_generated", "index", "ipc"], "filenames": ["c.rst", "cpp.rst",
"getting-started.rst", "getting-started_generated.rst", "index.rst",
"ipc.rst"], "titles": ["C API Reference", "C++ API Reference", "Getting started
with nanoarrow", "Getting started with nanoarrow", "nanoarrow", "IPC Extension
Reference"], "terms": {"group": [0, 1, 5], "nanoarrow": [0, 1, 5], "except":
[0, 1, 2, 3, 5], "where": [0, 1, 4, 5], "note" [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["c", "cpp", "getting-started",
"getting-started_generated", "index", "ipc"], "filenames": ["c.rst", "cpp.rst",
"getting-started.rst", "getting-started_generated.rst", "index.rst",
"ipc.rst"], "titles": ["C API Reference", "C++ API Reference", "Getting started
with nanoarrow", "Getting started with nanoarrow", "nanoarrow", "IPC Extension
Reference"], "terms": {"group": [0, 1, 5], "nanoarrow": [0, 1, 5], "except":
[0, 1, 2, 3, 5], "where": [0, 1, 4, 5], "note" [...]
\ No newline at end of file
