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 382cde9e update documentation for tag main
382cde9e is described below
commit 382cde9ec866b065ae43cc442ad31a8d8e0be3cd
Author: GitHub Actions <[email protected]>
AuthorDate: Wed Nov 20 21:52:48 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1516063 -> 1519107 bytes
main/.doctrees/reference/c.doctree | Bin 1190063 -> 1194153 bytes
main/genindex.html | 8 ++++++--
main/objects.inv | Bin 25006 -> 25071 bytes
main/r/pkgdown.yml | 2 +-
main/reference/c.html | 18 +++++++++++++++---
main/searchindex.js | 2 +-
7 files changed, 23 insertions(+), 7 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index a55b4a40..d30f55c0 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 e684ae93..3d8b2cb9 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 cda3858b..463740b0 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -834,10 +834,10 @@
</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>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv431ArrowDeviceBasicArrayStreamInitP22ArrowDeviceArrayStreamP16ArrowArrayStreamP11ArrowDevice">ArrowDeviceBasicArrayStreamInit
(C++ function)</a>
</li>
<li><a
href="reference/device.html#_CPPv421ArrowDeviceBufferCopyP11ArrowDevice15ArrowBufferViewP11ArrowDevice15ArrowBufferView">ArrowDeviceBufferCopy
(C++ function)</a>
@@ -1227,6 +1227,10 @@
<li><a
href="reference/c.html#_CPPv4N9ArrowType25NANOARROW_TYPE_DECIMAL128E">ArrowType::NANOARROW_TYPE_DECIMAL128
(C++ enumerator)</a>
</li>
<li><a
href="reference/c.html#_CPPv4N9ArrowType25NANOARROW_TYPE_DECIMAL256E">ArrowType::NANOARROW_TYPE_DECIMAL256
(C++ enumerator)</a>
+</li>
+ <li><a
href="reference/c.html#_CPPv4N9ArrowType24NANOARROW_TYPE_DECIMAL32E">ArrowType::NANOARROW_TYPE_DECIMAL32
(C++ enumerator)</a>
+</li>
+ <li><a
href="reference/c.html#_CPPv4N9ArrowType24NANOARROW_TYPE_DECIMAL64E">ArrowType::NANOARROW_TYPE_DECIMAL64
(C++ enumerator)</a>
</li>
<li><a
href="reference/c.html#_CPPv4N9ArrowType26NANOARROW_TYPE_DENSE_UNIONE">ArrowType::NANOARROW_TYPE_DENSE_UNION
(C++ enumerator)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index a94b9b4c..c51a1a23 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 1191bd1a..3699d607 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-11-20T04:17Z
+last_built: 2024-11-20T21:52Z
diff --git a/main/reference/c.html b/main/reference/c.html
index d4db32fb..b79d4006 100644
--- a/main/reference/c.html
+++ b/main/reference/c.html
@@ -438,7 +438,7 @@
<dt class="sig sig-object cpp"
id="_CPPv425ArrowSchemaSetTypeDecimalP11ArrowSchema9ArrowType7int32_t7int32_t">
<span
id="_CPPv325ArrowSchemaSetTypeDecimalP11ArrowSchema9ArrowType7int32_t7int32_t"></span><span
id="_CPPv225ArrowSchemaSetTypeDecimalP11ArrowSchema9ArrowType7int32_t7int32_t"></span><span
id="ArrowSchemaSetTypeDecimal__ArrowSchemaP.ArrowType.int32_t.int32_t"></span><span
class="target"
id="group__nanoarrow-schema_1gac929a2a27c4b336f31aa3adc6e9a70ee"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorCod [...]
<dd><p>Set the format field of a decimal schema. </p>
-<p>Returns EINVAL for scale <= 0 or for type that is not
NANOARROW_TYPE_DECIMAL128 or NANOARROW_TYPE_DECIMAL256. Schema must have been
initialized using <a class="reference internal"
href="#group__nanoarrow-schema_1ga4d0f9b69f912b9316ee4201b974d7b6a"><span
class="std std-ref">ArrowSchemaInit()</span></a> or <a class="reference
internal"
href="#group__nanoarrow-schema_1gac1a2699e005030333c05bff130590c33"><span
class="std std-ref">ArrowSchemaDeepCopy()</span></a>. </p>
+<p>Returns EINVAL for scale <= 0 or for type that is not
NANOARROW_TYPE_DECIMAL32, NANOARROW_TYPE_DECIMAL64, NANOARROW_TYPE_DECIMAL128
or NANOARROW_TYPE_DECIMAL256. Schema must have been initialized using <a
class="reference internal"
href="#group__nanoarrow-schema_1ga4d0f9b69f912b9316ee4201b974d7b6a"><span
class="std std-ref">ArrowSchemaInit()</span></a> or <a class="reference
internal"
href="#group__nanoarrow-schema_1gac1a2699e005030333c05bff130590c33"><span
class="std std-ref">Arro [...]
</dd></dl>
<dl class="cpp function">
@@ -2010,6 +2010,16 @@
<span id="_CPPv3N9ArrowType26NANOARROW_TYPE_STRING_VIEWE"></span><span
id="_CPPv2N9ArrowType26NANOARROW_TYPE_STRING_VIEWE"></span><span class="target"
id="group__nanoarrow-utils_1ggae040d7d64b46dd1dc796225aa77c2112a42c3dbc96e365ed4e28773d750aa47d7"></span><span
class="k"><span class="pre">enumerator</span></span><span class="w">
</span><span class="sig-name descname"><span class="n"><span
class="pre">NANOARROW_TYPE_STRING_VIEW</span></span></span><a
class="headerlink" href="#_CPPv4N9Arro [...]
<dd></dd></dl>
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp"
id="_CPPv4N9ArrowType24NANOARROW_TYPE_DECIMAL32E">
+<span id="_CPPv3N9ArrowType24NANOARROW_TYPE_DECIMAL32E"></span><span
id="_CPPv2N9ArrowType24NANOARROW_TYPE_DECIMAL32E"></span><span class="target"
id="group__nanoarrow-utils_1ggae040d7d64b46dd1dc796225aa77c2112af40a70369b65b37f0034db22bb4218f5"></span><span
class="k"><span class="pre">enumerator</span></span><span class="w">
</span><span class="sig-name descname"><span class="n"><span
class="pre">NANOARROW_TYPE_DECIMAL32</span></span></span><a class="headerlink"
href="#_CPPv4N9ArrowType2 [...]
+<dd></dd></dl>
+
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp"
id="_CPPv4N9ArrowType24NANOARROW_TYPE_DECIMAL64E">
+<span id="_CPPv3N9ArrowType24NANOARROW_TYPE_DECIMAL64E"></span><span
id="_CPPv2N9ArrowType24NANOARROW_TYPE_DECIMAL64E"></span><span class="target"
id="group__nanoarrow-utils_1ggae040d7d64b46dd1dc796225aa77c2112aaa68e6f79aa2b79cbf2bec1f24f1dd4c"></span><span
class="k"><span class="pre">enumerator</span></span><span class="w">
</span><span class="sig-name descname"><span class="n"><span
class="pre">NANOARROW_TYPE_DECIMAL64</span></span></span><a class="headerlink"
href="#_CPPv4N9ArrowType2 [...]
+<dd></dd></dl>
+
</dd></dl>
<dl class="cpp enum">
@@ -2306,7 +2316,7 @@
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N12ArrowDecimal5wordsE">
<span id="_CPPv3N12ArrowDecimal5wordsE"></span><span
id="_CPPv2N12ArrowDecimal5wordsE"></span><span
id="ArrowDecimal::words__uint64_tA"></span><span class="target"
id="struct_arrow_decimal_1aca665738c134dae7f1cb545b48d1ebb8"></span><span
class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">words</span></span></span><span class="p"><span
class="pre">[</span></span><span class="m"><span class="pre">4</sp [...]
-<dd><p>An array of 64-bit integers of n_words length defined in native-endian
order. </p>
+<dd><p>An array of 64-bit integers of n_words length defined in native-endian
order. For a 32-bit decimal value, index 0 will be a 32-bit integer value. </p>
</dd></dl>
<dl class="cpp var">
@@ -2324,7 +2334,7 @@
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N12ArrowDecimal7n_wordsE">
<span id="_CPPv3N12ArrowDecimal7n_wordsE"></span><span
id="_CPPv2N12ArrowDecimal7n_wordsE"></span><span
id="ArrowDecimal::n_words__i"></span><span class="target"
id="struct_arrow_decimal_1a6c70dd46548980ab26e411f6051c5e96"></span><span
class="kt"><span class="pre">int</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">n_words</span></span></span><a class="headerlink"
href="#_CPPv4N12ArrowDecimal7n_wordsE" title="Link to this definition" [...]
-<dd><p>The number of words in the words array. </p>
+<dd><p>The number of 64-bit words in the words array. For the special case of
a 32-bit decimal value, this will be 0. </p>
</dd></dl>
<dl class="cpp var">
@@ -2899,6 +2909,8 @@
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N9ArrowType30NANOARROW_TYPE_RUN_END_ENCODEDE"><code
class="docutils literal notranslate"><span
class="pre">ArrowType::NANOARROW_TYPE_RUN_END_ENCODED</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N9ArrowType26NANOARROW_TYPE_BINARY_VIEWE"><code class="docutils
literal notranslate"><span
class="pre">ArrowType::NANOARROW_TYPE_BINARY_VIEW</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N9ArrowType26NANOARROW_TYPE_STRING_VIEWE"><code class="docutils
literal notranslate"><span
class="pre">ArrowType::NANOARROW_TYPE_STRING_VIEW</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N9ArrowType24NANOARROW_TYPE_DECIMAL32E"><code class="docutils
literal notranslate"><span
class="pre">ArrowType::NANOARROW_TYPE_DECIMAL32</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N9ArrowType24NANOARROW_TYPE_DECIMAL64E"><code class="docutils
literal notranslate"><span
class="pre">ArrowType::NANOARROW_TYPE_DECIMAL64</span></code></a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv413ArrowTimeUnit"><code class="docutils literal notranslate"><span
class="pre">ArrowTimeUnit</span></code></a><ul class="nav section-nav
flex-column">
diff --git a/main/searchindex.js b/main/searchindex.js
index 16f0061d..02060f3c 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
