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 4e1759f update documentation for tag dev
4e1759f is described below
commit 4e1759fac79cdf4a9cbf542c46ccd790e42a5576
Author: GitHub Actions <[email protected]>
AuthorDate: Wed Dec 7 20:41:24 2022 +0000
update documentation for tag dev
---
dev/c.html | 15 ++++++++++++++-
dev/genindex.html | 8 ++++++--
dev/objects.inv | Bin 11971 -> 12069 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/search.json | 2 +-
dev/searchindex.js | 2 +-
8 files changed, 26 insertions(+), 9 deletions(-)
diff --git a/dev/c.html b/dev/c.html
index dad03e2..5e50935 100644
--- a/dev/c.html
+++ b/dev/c.html
@@ -521,7 +521,7 @@
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N15ArrowSchemaView14union_type_idsE">
-<span id="_CPPv3N15ArrowSchemaView14union_type_idsE"></span><span
id="_CPPv2N15ArrowSchemaView14union_type_idsE"></span><span
id="ArrowSchemaView::union_type_ids__ArrowStringView"></span><span
class="target"
id="struct_arrow_schema_view_1ab58d468e05f51aba4d4633b32853147a"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv415ArrowStringView"
title="ArrowStringView"><span class="n"><span class="pre">ArrowStringVie [...]
+<span id="_CPPv3N15ArrowSchemaView14union_type_idsE"></span><span
id="_CPPv2N15ArrowSchemaView14union_type_idsE"></span><span
id="ArrowSchemaView::union_type_ids__cCP"></span><span class="target"
id="struct_arrow_schema_view_1a9f60c668660bc392308e625e3bf47778"></span><span
class="k"><span class="pre">const</span></span><span class="w"> </span><span
class="kt"><span class="pre">char</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name [...]
<dd><p>Union type ids parameter. </p>
<p>This value is set when parsing a union type and represents type ids
parameter. The <a class="reference internal"
href="#struct_arrow_string_view"><span class="std
std-ref">ArrowStringView</span></a> points to data within the schema and the
value is undefined for other types. </p>
</dd></dl>
@@ -616,6 +616,12 @@
<dd><p>Append a null value to an array. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv421ArrowArrayAppendEmptyP10ArrowArray7int64_t">
+<span id="_CPPv321ArrowArrayAppendEmptyP10ArrowArray7int64_t"></span><span
id="_CPPv221ArrowArrayAppendEmptyP10ArrowArray7int64_t"></span><span
id="ArrowArrayAppendEmpty__ArrowArrayP.int64_t"></span><span class="target"
id="group__nanoarrow-array_1ga5b1a001a5ed966662a5c48bdc5f48ce6"></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><a
class="reference internal" href="#_CPPv414 [...]
+<dd><p>Append an empty, non-null value to an array. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv419ArrowArrayAppendIntP10ArrowArray7int64_t">
<span id="_CPPv319ArrowArrayAppendIntP10ArrowArray7int64_t"></span><span
id="_CPPv219ArrowArrayAppendIntP10ArrowArray7int64_t"></span><span
id="ArrowArrayAppendInt__ArrowArrayP.int64_t"></span><span class="target"
id="group__nanoarrow-array_1gac6b99a2b05db4c956def99131f803994"></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><a
class="reference internal" href="#_CPPv414ArrowE [...]
@@ -657,6 +663,13 @@
<p>Appends a non-null element to the array based on the first child’s current
length. Returns NANOARROW_OK if the item was successfully added or EINVAL if
the underlying storage type is not a struct, list, large list, or fixed-size
list, or if there was an attempt to add a struct or fixed-size list element
where the length of the child array(s) did not match the expected length. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv428ArrowArrayFinishUnionElementP10ArrowArray6int8_t">
+<span
id="_CPPv328ArrowArrayFinishUnionElementP10ArrowArray6int8_t"></span><span
id="_CPPv228ArrowArrayFinishUnionElementP10ArrowArray6int8_t"></span><span
id="ArrowArrayFinishUnionElement__ArrowArrayP.int8_t"></span><span
class="target"
id="group__nanoarrow-array_1ga5034d76e216e4ace59813f6232a587d2"></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><a
class="reference interna [...]
+<dd><p>Finish a union array element. </p>
+<p>Appends an element to the union type ids buffer and increments
array->length. For sparse unions, up to one element is added to non type-id
children. Returns EINVAL if the underlying storage type is not a union, if
type_id is not valid, or if child sizes after appending are inconsistent. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv421ArrowArrayShrinkToFitP10ArrowArray">
<span id="_CPPv321ArrowArrayShrinkToFitP10ArrowArray"></span><span
id="_CPPv221ArrowArrayShrinkToFitP10ArrowArray"></span><span
id="ArrowArrayShrinkToFit__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1gaa6e5c94f307218fcc22578cacf07cf81"></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><a
class="reference internal" href="#_CPPv414ArrowErrorCode" title="A [...]
diff --git a/dev/genindex.html b/dev/genindex.html
index 080ed5a..bc4dc19 100644
--- a/dev/genindex.html
+++ b/dev/genindex.html
@@ -339,6 +339,8 @@
<li><a
href="c.html#_CPPv421ArrowArrayAppendBytesP10ArrowArray15ArrowBufferView">ArrowArrayAppendBytes
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv422ArrowArrayAppendDoubleP10ArrowArrayd">ArrowArrayAppendDouble
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv421ArrowArrayAppendEmptyP10ArrowArray7int64_t">ArrowArrayAppendEmpty
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv419ArrowArrayAppendIntP10ArrowArray7int64_t">ArrowArrayAppendInt
(C++ function)</a>
</li>
@@ -353,6 +355,8 @@
<li><a
href="c.html#_CPPv424ArrowArrayFinishBuildingP10ArrowArrayP10ArrowError">ArrowArrayFinishBuilding
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv423ArrowArrayFinishElementP10ArrowArray">ArrowArrayFinishElement
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv428ArrowArrayFinishUnionElementP10ArrowArray6int8_t">ArrowArrayFinishUnionElement
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv424ArrowArrayInitFromSchemaP10ArrowArrayP11ArrowSchemaP10ArrowError">ArrowArrayInitFromSchema
(C++ function)</a>
</li>
@@ -541,11 +545,11 @@
<li><a
href="c.html#_CPPv4N15ArrowBufferType30NANOARROW_BUFFER_TYPE_VALIDITYE">ArrowBufferType::NANOARROW_BUFFER_TYPE_VALIDITY
(C++ enumerator)</a>
</li>
<li><a href="c.html#_CPPv415ArrowBufferView">ArrowBufferView (C++
struct)</a>
-</li>
- <li><a
href="c.html#_CPPv4N15ArrowBufferView4dataE">ArrowBufferView::data (C++
member)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a
href="c.html#_CPPv4N15ArrowBufferView4dataE">ArrowBufferView::data (C++
member)</a>
+</li>
<li><a
href="c.html#_CPPv4N15ArrowBufferView7n_bytesE">ArrowBufferView::n_bytes (C++
member)</a>
</li>
<li><a href="c.html#_CPPv413ArrowCharViewPKc">ArrowCharView (C++
function)</a>
diff --git a/dev/objects.inv b/dev/objects.inv
index 23e30d2..453020d 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 943b065..fe33c00 100644
--- a/dev/r/pkgdown.yml
+++ b/dev/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.19.2
pkgdown: 2.0.6
pkgdown_sha: ~
articles: {}
-last_built: 2022-12-06T14:58Z
+last_built: 2022-12-07T20:41Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index 65295ed..92263d0 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 0x556cffdcc5e8></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5573bebab868></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 0x556d005d2ed8></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5573bed5fd78></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 91ac254..b069f06 100644
--- a/dev/r/reference/as_nanoarrow_array_stream.html
+++ b/dev/r/reference/as_nanoarrow_array_stream.html
@@ -134,7 +134,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 0x556d003818e8></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5573bf162cd8></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/search.json b/dev/r/search.json
index c550c19..9671898 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":"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 [...]
+[{"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":"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 [...]
diff --git a/dev/searchindex.js b/dev/searchindex.js
index ed1f713..8f0541c 100644
--- a/dev/searchindex.js
+++ b/dev/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["c", "cpp", "index"], "filenames": ["c.rst",
"cpp.rst", "index.rst"], "titles": ["C API Reference", "C++ API Reference",
"nanoarrow"], "terms": {"group": [0, 1], "nanoarrow": [0, 1], "except": 0,
"where": [0, 2], "note": 0, "object": [0, 2], "ar": [0, 1], "thread": 0,
"safe": 0, "client": [0, 2], "should": [0, 2], "take": [0, 1], "care": 0,
"serial": 0, "access": [0, 1], "method": [0, 1], "becaus": 0, "thi": [0, 1, 2],
"librari": [0, 1], "i": [0, 1, 2], "int [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["c", "cpp", "index"], "filenames": ["c.rst",
"cpp.rst", "index.rst"], "titles": ["C API Reference", "C++ API Reference",
"nanoarrow"], "terms": {"group": [0, 1], "nanoarrow": [0, 1], "except": 0,
"where": [0, 2], "note": 0, "object": [0, 2], "ar": [0, 1], "thread": 0,
"safe": 0, "client": [0, 2], "should": [0, 2], "take": [0, 1], "care": 0,
"serial": 0, "access": [0, 1], "method": [0, 1], "becaus": 0, "thi": [0, 1, 2],
"librari": [0, 1], "i": [0, 1, 2], "int [...]
\ No newline at end of file
