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 41fce27 update documentation for tag dev
41fce27 is described below
commit 41fce279a9df6c4b93d0a1b74b61fb76a9f0c505
Author: GitHub Actions <[email protected]>
AuthorDate: Wed Mar 29 12:08:27 2023 +0000
update documentation for tag dev
---
dev/c.html | 8 +++++++-
dev/genindex.html | 2 ++
dev/objects.inv | Bin 12211 -> 12267 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, 17 insertions(+), 9 deletions(-)
diff --git a/dev/c.html b/dev/c.html
index 378c093..3e9c8f7 100644
--- a/dev/c.html
+++ b/dev/c.html
@@ -820,6 +820,12 @@ document.write(`
<dd><p>Set buffer sizes and data pointers from an <a class="reference
internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a>. </p>
</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>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv419ArrowArrayViewResetP14ArrowArrayView">
<span id="_CPPv319ArrowArrayViewResetP14ArrowArrayView"></span><span
id="_CPPv219ArrowArrayViewResetP14ArrowArrayView"></span><span
id="ArrowArrayViewReset__ArrowArrayViewP"></span><span class="target"
id="group__nanoarrow-array-view_1ga983106893cf481272d96fb91dc6d724c"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">ArrowArrayViewReset</span></span></span><span
class="sig-paren">(</span [...]
@@ -936,7 +942,7 @@ document.write(`
<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>
+<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].
This value may be NULL in the case where child_id == type_id. </p>
</dd></dl>
</div>
diff --git a/dev/genindex.html b/dev/genindex.html
index 6291cb3..3de0b53 100644
--- a/dev/genindex.html
+++ b/dev/genindex.html
@@ -453,6 +453,8 @@ document.write(`
<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#_CPPv426ArrowArrayViewValidateFullP14ArrowArrayViewP10ArrowError">ArrowArrayViewValidateFull
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv413ArrowBitClearP7uint8_t7int64_t">ArrowBitClear (C++
function)</a>
</li>
diff --git a/dev/objects.inv b/dev/objects.inv
index ce2af51..7eaf887 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 4700b9e..b5cf613 100644
--- a/dev/r/pkgdown.yml
+++ b/dev/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.19.2
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-03-28T14:57Z
+last_built: 2023-03-29T12:08Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index dac85a6..8a07dab 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 0x55ed0b751698></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55f25704b9f8></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 0x55ed0b357d58></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55f25787ff98></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 63370b8..d9c31c9 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 0x55ed0bfe3e58></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55f2577e1c68></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 691cce2..3238043 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 0x55ed0e264618></span>
+<span class="r-out co"><span class="r-pr">#></span>
<nanoarrow_buffer_data_int32[16 b] at 0x55f2598a8bc8></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 0x55ed0e38d718></span>
+<span class="r-out co"><span class="r-pr">#></span> <nanoarrow_buffer[20
b] at 0x55f259b795c8></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 90d5c67..f91886b 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 d620d4d..de86586 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
