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 d0e6c83 update documentation for tag dev
d0e6c83 is described below
commit d0e6c83884c8325905b0e4d8ff3e6e663556e299
Author: GitHub Actions <[email protected]>
AuthorDate: Thu Dec 8 20:03:21 2022 +0000
update documentation for tag dev
---
dev/c.html | 25 +++++++++++++++++++++++++
dev/genindex.html | 12 ++++++++++--
dev/objects.inv | Bin 12069 -> 12248 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, 41 insertions(+), 8 deletions(-)
diff --git a/dev/c.html b/dev/c.html
index 5e50935..133e26c 100644
--- a/dev/c.html
+++ b/dev/c.html
@@ -786,6 +786,24 @@
<dd><p>Check for a null element in an <a class="reference internal"
href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a>. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv425ArrowArrayViewUnionTypeIdP14ArrowArrayView7int64_t">
+<span
id="_CPPv325ArrowArrayViewUnionTypeIdP14ArrowArrayView7int64_t"></span><span
id="_CPPv225ArrowArrayViewUnionTypeIdP14ArrowArrayView7int64_t"></span><span
id="ArrowArrayViewUnionTypeId__ArrowArrayViewP.int64_t"></span><span
class="target"
id="group__nanoarrow-array-view_1gadceccfb2edf264393b88a2e1985e264e"></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"> [...]
+<dd><p>Get the type id of a union array element. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv429ArrowArrayViewUnionChildIndexP14ArrowArrayView7int64_t">
+<span
id="_CPPv329ArrowArrayViewUnionChildIndexP14ArrowArrayView7int64_t"></span><span
id="_CPPv229ArrowArrayViewUnionChildIndexP14ArrowArrayView7int64_t"></span><span
id="ArrowArrayViewUnionChildIndex__ArrowArrayViewP.int64_t"></span><span
class="target"
id="group__nanoarrow-array-view_1gae4c2175417c784f950113b5d2874033b"></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><spa
[...]
+<dd><p>Get the child index of a union array element. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv430ArrowArrayViewUnionChildOffsetP14ArrowArrayView7int64_t">
+<span
id="_CPPv330ArrowArrayViewUnionChildOffsetP14ArrowArrayView7int64_t"></span><span
id="_CPPv230ArrowArrayViewUnionChildOffsetP14ArrowArrayView7int64_t"></span><span
id="ArrowArrayViewUnionChildOffset__ArrowArrayViewP.int64_t"></span><span
class="target"
id="group__nanoarrow-array-view_1gad69ea697c65b3a3c4f31f823cf3e84dd"></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>< [...]
+<dd><p>Get the index to use into the relevant union child array. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv426ArrowArrayViewGetIntUnsafeP14ArrowArrayView7int64_t">
<span
id="_CPPv326ArrowArrayViewGetIntUnsafeP14ArrowArrayView7int64_t"></span><span
id="_CPPv226ArrowArrayViewGetIntUnsafeP14ArrowArrayView7int64_t"></span><span
id="ArrowArrayViewGetIntUnsafe__ArrowArrayViewP.int64_t"></span><span
class="target"
id="group__nanoarrow-array-view_1ga116de101807afd81b0b5949f0141c785"></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=" [...]
@@ -868,6 +886,13 @@
<dd><p>Pointers to views of this array’s children. </p>
</dd></dl>
+<dl class="cpp var">
+<dt class="sig sig-object cpp"
id="_CPPv4N14ArrowArrayView17union_type_id_mapE">
+<span id="_CPPv3N14ArrowArrayView17union_type_id_mapE"></span><span
id="_CPPv2N14ArrowArrayView17union_type_id_mapE"></span><span
id="ArrowArrayView::union_type_id_map__int8_tP"></span><span class="target"
id="struct_arrow_array_view_1a67e002d726250ad0d9ed0cd84d8cb263"></span><span
class="n"><span class="pre">int8_t</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span class="n"><span class="pre">union_type_id_map</spa [...]
+<dd><p>Union type id to child index mapping. </p>
+<p>If storage_type is a union type, a 256-byte <a class="reference internal"
href="#group__nanoarrow-malloc_1gab05bc897baadee2d140b5bea9a846f7b"><span
class="std std-ref">ArrowMalloc()</span></a>ed buffer such that child_index ==
union_type_id_map[type_id] and type_id == union_type_id_map[128 + child_index]
</p>
+</dd></dl>
+
</div>
</dd></dl>
diff --git a/dev/genindex.html b/dev/genindex.html
index bc4dc19..294eefd 100644
--- a/dev/genindex.html
+++ b/dev/genindex.html
@@ -403,6 +403,8 @@
<li><a
href="c.html#_CPPv4N14ArrowArrayView10n_childrenE">ArrowArrayView::n_children
(C++ member)</a>
</li>
<li><a
href="c.html#_CPPv4N14ArrowArrayView12storage_typeE">ArrowArrayView::storage_type
(C++ member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N14ArrowArrayView17union_type_id_mapE">ArrowArrayView::union_type_id_map
(C++ member)</a>
</li>
<li><a
href="c.html#_CPPv430ArrowArrayViewAllocateChildrenP14ArrowArrayView7int64_t">ArrowArrayViewAllocateChildren
(C++ function)</a>
</li>
@@ -429,6 +431,12 @@
<li><a
href="c.html#_CPPv422ArrowArrayViewSetArrayP14ArrowArrayViewP10ArrowArrayP10ArrowError">ArrowArrayViewSetArray
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv423ArrowArrayViewSetLengthP14ArrowArrayView7int64_t">ArrowArrayViewSetLength
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv429ArrowArrayViewUnionChildIndexP14ArrowArrayView7int64_t">ArrowArrayViewUnionChildIndex
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv430ArrowArrayViewUnionChildOffsetP14ArrowArrayView7int64_t">ArrowArrayViewUnionChildOffset
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv425ArrowArrayViewUnionTypeIdP14ArrowArrayView7int64_t">ArrowArrayViewUnionTypeId
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv413ArrowBitClearP7uint8_t7int64_t">ArrowBitClear (C++
function)</a>
</li>
@@ -542,12 +550,12 @@
</li>
<li><a
href="c.html#_CPPv4N15ArrowBufferType34NANOARROW_BUFFER_TYPE_UNION_OFFSETE">ArrowBufferType::NANOARROW_BUFFER_TYPE_UNION_OFFSET
(C++ enumerator)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<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>
- </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>
diff --git a/dev/objects.inv b/dev/objects.inv
index 453020d..29b4aa0 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 fe33c00..a2e444a 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-07T20:41Z
+last_built: 2022-12-08T20:03Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index 92263d0..44827d8 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 0x5573bebab868></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x564b7de17868></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 0x5573bed5fd78></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x564b7e71a148></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 b069f06..8132aa3 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 0x5573bf162cd8></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x564b7e3c8b38></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 9671898..abdf87f 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 8f0541c..84ad802 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
