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 12883bda update documentation for tag main
12883bda is described below
commit 12883bda08e8553630bb3a3590bb69e325a571b6
Author: GitHub Actions <[email protected]>
AuthorDate: Tue Jun 11 16:40:15 2024 +0000
update documentation for tag main
---
main/_sources/reference/device.rst.txt | 6 +++---
main/_sources/reference/ipc.rst.txt | 4 ++--
main/r/pkgdown.yml | 2 +-
main/reference/device.html | 16 ++++++++--------
4 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/main/_sources/reference/device.rst.txt
b/main/_sources/reference/device.rst.txt
index 8313d5fc..56cc5428 100644
--- a/main/_sources/reference/device.rst.txt
+++ b/main/_sources/reference/device.rst.txt
@@ -22,20 +22,20 @@ C API
------------------------
.. doxygengroup:: nanoarrow_device
- :project: nanoarrow_device
+ :project: nanoarrow_c
:members:
C++ Helpers
------------------------
.. doxygengroup:: nanoarrow_device_hpp-unique
- :project: nanoarrow_device
+ :project: nanoarrow_c
:members:
Arrow C Device Interface
------------------------
.. doxygengroup:: nanoarrow_device-arrow-cdata
- :project: nanoarrow_device
+ :project: nanoarrow_c
:members:
:undoc-members:
diff --git a/main/_sources/reference/ipc.rst.txt
b/main/_sources/reference/ipc.rst.txt
index fb009c1a..7d3ae1e1 100644
--- a/main/_sources/reference/ipc.rst.txt
+++ b/main/_sources/reference/ipc.rst.txt
@@ -22,12 +22,12 @@ C API
------------------------
.. doxygengroup:: nanoarrow_ipc
- :project: nanoarrow_ipc
+ :project: nanoarrow_c
:members:
C++ Helpers
------------------------
.. doxygengroup:: nanoarrow_ipc_hpp-unique
- :project: nanoarrow_ipc
+ :project: nanoarrow_c
:members:
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index b3059f7a..e123798b 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.3
pkgdown: 2.0.9
pkgdown_sha: ~
articles: {}
-last_built: 2024-06-11T13:25Z
+last_built: 2024-06-11T16:40Z
diff --git a/main/reference/device.html b/main/reference/device.html
index cf3d8120..d74e2368 100644
--- a/main/reference/device.html
+++ b/main/reference/device.html
@@ -422,7 +422,7 @@ document.write(`
<dt class="sig sig-object cpp"
id="_CPPv420ArrowDeviceArrayInitP11ArrowDeviceP16ArrowDeviceArrayP10ArrowArrayPv">
<span
id="_CPPv320ArrowDeviceArrayInitP11ArrowDeviceP16ArrowDeviceArrayP10ArrowArrayPv"></span><span
id="_CPPv220ArrowDeviceArrayInitP11ArrowDeviceP16ArrowDeviceArrayP10ArrowArrayPv"></span><span
id="ArrowDeviceArrayInit__ArrowDeviceP.ArrowDeviceArrayP.ArrowArrayP.voidP"></span><span
class="target"
id="group__nanoarrow__device_1ga85120fd1cf551bb84a1c63260dbc0208"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class=" [...]
<dd><p>Initialize an <a class="reference internal"
href="#struct_arrow_device_array"><span class="std
std-ref">ArrowDeviceArray</span></a>. </p>
-<p>Given an ArrowArray whose buffers/release callback has been set
appropriately, initialize an <a class="reference internal"
href="#struct_arrow_device_array"><span class="std
std-ref">ArrowDeviceArray</span></a>. </p>
+<p>Given an <a class="reference internal"
href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> whose buffers/release callback has been set
appropriately, initialize an <a class="reference internal"
href="#struct_arrow_device_array"><span class="std
std-ref">ArrowDeviceArray</span></a>. </p>
</dd></dl>
<dl class="cpp function">
@@ -435,20 +435,20 @@ document.write(`
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv425ArrowDeviceArrayViewResetP20ArrowDeviceArrayView">
<span
id="_CPPv325ArrowDeviceArrayViewResetP20ArrowDeviceArrayView"></span><span
id="_CPPv225ArrowDeviceArrayViewResetP20ArrowDeviceArrayView"></span><span
id="ArrowDeviceArrayViewReset__ArrowDeviceArrayViewP"></span><span
class="target"
id="group__nanoarrow__device_1ga76e2f742a6c6dc703c7ce43cf785a111"></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">ArrowDeviceArrayViewReset</span></span [...]
-<dd><p>Release the underlying ArrowArrayView. </p>
+<dd><p>Release the underlying <a class="reference internal"
href="c.html#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="_CPPv435ArrowDeviceArrayViewSetArrayMinimalP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError">
<span
id="_CPPv335ArrowDeviceArrayViewSetArrayMinimalP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError"></span><span
id="_CPPv235ArrowDeviceArrayViewSetArrayMinimalP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError"></span><span
id="ArrowDeviceArrayViewSetArrayMinimal__ArrowDeviceArrayViewP.ArrowDeviceArrayP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__device_1ga713f654c4040013531b86b88f5fd67ac"></span><a
class="reference internal" href="c.html#_CPPv414ArrowE [...]
-<dd><p>Set minimal ArrowArrayView buffer information from a device array. </p>
-<p>A thin wrapper around ArrowArrayViewSetArrayMinimal() that does not attempt
to resolve buffer sizes of variable-length buffers by copying data from the
device. </p>
+<dd><p>Set minimal <a class="reference internal"
href="c.html#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> buffer information from a device array. </p>
+<p>A thin wrapper around <a class="reference internal"
href="c.html#group__nanoarrow-array-view_1ga2fe4b6714bae3e201891d11b82819e4f"><span
class="std std-ref">ArrowArrayViewSetArrayMinimal()</span></a> that does not
attempt to resolve buffer sizes of variable-length buffers by copying data from
the device. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv428ArrowDeviceArrayViewSetArrayP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError">
<span
id="_CPPv328ArrowDeviceArrayViewSetArrayP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError"></span><span
id="_CPPv228ArrowDeviceArrayViewSetArrayP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError"></span><span
id="ArrowDeviceArrayViewSetArray__ArrowDeviceArrayViewP.ArrowDeviceArrayP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__device_1ga10307f3b1f121df50e532e0cb389a29d"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode" title="Arro
[...]
-<dd><p>Set ArrowArrayView buffer information from a device array. </p>
+<dd><p>Set <a class="reference internal"
href="c.html#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> buffer information from a device array. </p>
<p>Runs <a class="reference internal"
href="#group__nanoarrow__device_1ga713f654c4040013531b86b88f5fd67ac"><span
class="std std-ref">ArrowDeviceArrayViewSetArrayMinimal()</span></a> but also
sets buffer sizes for variable-length buffers by copying data from the device.
This function will block on the device_array’s sync_event. </p>
</dd></dl>
@@ -502,8 +502,8 @@ document.write(`
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv431ArrowDeviceBasicArrayStreamInitP22ArrowDeviceArrayStreamP16ArrowArrayStreamP11ArrowDevice">
<span
id="_CPPv331ArrowDeviceBasicArrayStreamInitP22ArrowDeviceArrayStreamP16ArrowArrayStreamP11ArrowDevice"></span><span
id="_CPPv231ArrowDeviceBasicArrayStreamInitP22ArrowDeviceArrayStreamP16ArrowArrayStreamP11ArrowDevice"></span><span
id="ArrowDeviceBasicArrayStreamInit__ArrowDeviceArrayStreamP.ArrowArrayStreamP.ArrowDeviceP"></span><span
class="target"
id="group__nanoarrow__device_1gae63a6fbbab26018a0be8d5587adefb12"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErro [...]
-<dd><p>Initialize an <a class="reference internal"
href="#struct_arrow_device_array_stream"><span class="std
std-ref">ArrowDeviceArrayStream</span></a> from an existing ArrowArrayStream.
</p>
-<p>Wrap an ArrowArrayStream of <a class="reference internal"
href="#struct_arrow_device_array"><span class="std
std-ref">ArrowDeviceArray</span></a> objects already allocated by the specified
device as an <a class="reference internal"
href="#struct_arrow_device_array_stream"><span class="std
std-ref">ArrowDeviceArrayStream</span></a>. This function moves the ownership
of array_stream to the device_array_stream. If this function returns
NANOARROW_OK, the caller is responsible for releasin [...]
+<dd><p>Initialize an <a class="reference internal"
href="#struct_arrow_device_array_stream"><span class="std
std-ref">ArrowDeviceArrayStream</span></a> from an existing <a class="reference
internal" href="c.html#struct_arrow_array_stream"><span class="std
std-ref">ArrowArrayStream</span></a>. </p>
+<p>Wrap an <a class="reference internal"
href="c.html#struct_arrow_array_stream"><span class="std
std-ref">ArrowArrayStream</span></a> of <a class="reference internal"
href="#struct_arrow_device_array"><span class="std
std-ref">ArrowDeviceArray</span></a> objects already allocated by the specified
device as an <a class="reference internal"
href="#struct_arrow_device_array_stream"><span class="std
std-ref">ArrowDeviceArrayStream</span></a>. This function moves the ownership
of array_strea [...]
</dd></dl>
</div>
@@ -531,7 +531,7 @@ document.write(`
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N11ArrowDevice10array_initE">
<span id="_CPPv3N11ArrowDevice10array_initE"></span><span
id="_CPPv2N11ArrowDevice10array_initE"></span><span class="target"
id="struct_arrow_device_1a874b0ab38b5b392b9f805c575e5bf67d"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span><span
class="p"><span class="pre">(</span></span><span class="p"><span
class="pre">*</span></span><span class="sig-name [...]
-<dd><p>Initialize an <a class="reference internal"
href="#struct_arrow_device_array"><span class="std
std-ref">ArrowDeviceArray</span></a> from a previously allocated ArrowArray.
</p>
+<dd><p>Initialize an <a class="reference internal"
href="#struct_arrow_device_array"><span class="std
std-ref">ArrowDeviceArray</span></a> from a previously allocated <a
class="reference internal" href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a>. </p>
<p>Given a device and an uninitialized device_array, populate the fields of
the device_array (including sync_event) appropriately. If NANOARROW_OK is
returned, ownership of array is transferred to device_array. This function must
allocate the appropriate sync_event and make its address available as
device_array->sync_event (if sync_event applies to this device type). </p>
</dd></dl>
