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 77c0da6 update documentation for tag dev 77c0da6 is described below commit 77c0da6be76d60b5e4bf7280c7754bb4e4f03c66 Author: GitHub Actions <acti...@github.com> AuthorDate: Thu Jul 20 16:32:13 2023 +0000 update documentation for tag dev --- dev/genindex.html | 20 +++++++++++++++++-- dev/objects.inv | Bin 19171 -> 19464 bytes dev/r/pkgdown.yml | 2 +- dev/reference/c.html | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++ dev/searchindex.js | 2 +- 5 files changed, 74 insertions(+), 4 deletions(-) diff --git a/dev/genindex.html b/dev/genindex.html index 330deca..2d2f497 100644 --- a/dev/genindex.html +++ b/dev/genindex.html @@ -387,6 +387,8 @@ document.write(` <li><a href="reference/c.html#_CPPv421ArrowArrayAppendEmptyP10ArrowArray7int64_t">ArrowArrayAppendEmpty (C++ function)</a> </li> <li><a href="reference/c.html#_CPPv419ArrowArrayAppendIntP10ArrowArray7int64_t">ArrowArrayAppendInt (C++ function)</a> +</li> + <li><a href="reference/c.html#_CPPv424ArrowArrayAppendIntervalP10ArrowArrayP13ArrowInterval">ArrowArrayAppendInterval (C++ function)</a> </li> <li><a href="reference/c.html#_CPPv420ArrowArrayAppendNullP10ArrowArray7int64_t">ArrowArrayAppendNull (C++ function)</a> </li> @@ -704,14 +706,14 @@ document.write(` </li> <li><a href="reference/device.html#_CPPv420ArrowDeviceArrayView">ArrowDeviceArrayView (C++ struct)</a> </li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> <li><a href="reference/device.html#_CPPv424ArrowDeviceArrayViewCopyP20ArrowDeviceArrayViewP11ArrowDeviceP16ArrowDeviceArray">ArrowDeviceArrayViewCopy (C++ function)</a> </li> <li><a href="reference/device.html#_CPPv424ArrowDeviceArrayViewInitP20ArrowDeviceArrayView">ArrowDeviceArrayViewInit (C++ function)</a> </li> <li><a href="reference/device.html#_CPPv425ArrowDeviceArrayViewResetP20ArrowDeviceArrayView">ArrowDeviceArrayViewReset (C++ function)</a> </li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li><a href="reference/device.html#_CPPv428ArrowDeviceArrayViewSetArrayP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError">ArrowDeviceArrayViewSetArray (C++ function)</a> </li> <li><a href="reference/device.html#_CPPv435ArrowDeviceArrayViewSetArrayMinimalP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError">ArrowDeviceArrayViewSetArrayMinimal (C++ function)</a> @@ -747,6 +749,20 @@ document.write(` <li><a href="reference/c.html#_CPPv413ArrowErrorSetP10ArrowErrorPKcz">ArrowErrorSet (C++ function)</a> </li> <li><a href="reference/c.html#_CPPv49ArrowFreePv">ArrowFree (C++ function)</a> +</li> + <li><a href="reference/c.html#_CPPv413ArrowInterval">ArrowInterval (C++ struct)</a> +</li> + <li><a href="reference/c.html#_CPPv4N13ArrowInterval4daysE">ArrowInterval::days (C++ member)</a> +</li> + <li><a href="reference/c.html#_CPPv4N13ArrowInterval6monthsE">ArrowInterval::months (C++ member)</a> +</li> + <li><a href="reference/c.html#_CPPv4N13ArrowInterval2msE">ArrowInterval::ms (C++ member)</a> +</li> + <li><a href="reference/c.html#_CPPv4N13ArrowInterval2nsE">ArrowInterval::ns (C++ member)</a> +</li> + <li><a href="reference/c.html#_CPPv4N13ArrowInterval4typeE">ArrowInterval::type (C++ member)</a> +</li> + <li><a href="reference/c.html#_CPPv417ArrowIntervalInitP13ArrowInterval9ArrowType">ArrowIntervalInit (C++ function)</a> </li> <li><a href="reference/ipc.html#_CPPv429ArrowIpcArrayStreamReaderInitP16ArrowArrayStreamP19ArrowIpcInputStreamP32ArrowIpcArrayStreamReaderOptions">ArrowIpcArrayStreamReaderInit (C++ function)</a> </li> diff --git a/dev/objects.inv b/dev/objects.inv index c14351c..4105141 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 0b78f14..9a77295 100644 --- a/dev/r/pkgdown.yml +++ b/dev/r/pkgdown.yml @@ -2,5 +2,5 @@ pandoc: 2.9.2.1 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2023-07-20T16:28Z +last_built: 2023-07-20T16:31Z diff --git a/dev/reference/c.html b/dev/reference/c.html index c80c5d0..6847613 100644 --- a/dev/reference/c.html +++ b/dev/reference/c.html @@ -744,6 +744,13 @@ document.write(` <p>Returns NANOARROW_OK if value can be exactly represented by the underlying storage type or EINVAL otherwise (e.g., the underlying array is not a string or large string array). </p> </dd></dl> +<dl class="cpp function"> +<dt class="sig sig-object cpp" id="_CPPv424ArrowArrayAppendIntervalP10ArrowArrayP13ArrowInterval"> +<span id="_CPPv324ArrowArrayAppendIntervalP10ArrowArrayP13ArrowInterval"></span><span id="_CPPv224ArrowArrayAppendIntervalP10ArrowArrayP13ArrowInterval"></span><span id="ArrowArrayAppendInterval__ArrowArrayP.ArrowIntervalP"></span><span class="target" id="group__nanoarrow-array_1gaaed70f1ac0c6ed1402dafb4157eed4f7"></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="ref [...] +<dd><p>Append a Interval to an array. </p> +<p>Returns NANOARROW_OK if value can be exactly represented by the underlying storage type or EINVAL otherwise. </p> +</dd></dl> + <dl class="cpp function"> <dt class="sig sig-object cpp" id="_CPPv423ArrowArrayAppendDecimalP10ArrowArrayP12ArrowDecimal"> <span id="_CPPv323ArrowArrayAppendDecimalP10ArrowArrayP12ArrowDecimal"></span><span id="_CPPv223ArrowArrayAppendDecimalP10ArrowArrayP12ArrowDecimal"></span><span id="ArrowArrayAppendDecimal__ArrowArrayP.ArrowDecimalP"></span><span class="target" id="group__nanoarrow-array_1gaa224decd739a8941991588cb94860386"></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 [...] @@ -1897,6 +1904,12 @@ document.write(` <p>Returns NULL for invalid values for time_unit </p> </dd></dl> +<dl class="cpp function"> +<dt class="sig sig-object cpp" id="_CPPv417ArrowIntervalInitP13ArrowInterval9ArrowType"> +<span id="_CPPv317ArrowIntervalInitP13ArrowInterval9ArrowType"></span><span id="_CPPv217ArrowIntervalInitP13ArrowInterval9ArrowType"></span><span id="ArrowIntervalInit__ArrowIntervalP.ArrowType"></span><span class="target" id="group__nanoarrow-utils_1ga0442d4f415da195b9548f687bbe785c1"></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="kt"><span class="pre">void</s [...] +<dd><p>Zero initialize an Interval with a given unit. </p> +</dd></dl> + <dl class="cpp function"> <dt class="sig sig-object cpp" id="_CPPv416ArrowDecimalInitP12ArrowDecimal7int32_t7int32_t7int32_t"> <span id="_CPPv316ArrowDecimalInitP12ArrowDecimal7int32_t7int32_t7int32_t"></span><span id="_CPPv216ArrowDecimalInitP12ArrowDecimal7int32_t7int32_t7int32_t"></span><span id="ArrowDecimalInit__ArrowDecimalP.int32_t.int32_t.int32_t"></span><span class="target" id="group__nanoarrow-utils_1ga07178a7a7ccc9339d129d717bcec88c9"></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 [...] @@ -2013,6 +2026,47 @@ document.write(` </div> </dd></dl> +<dl class="cpp struct"> +<dt class="sig sig-object cpp" id="_CPPv413ArrowInterval"> +<span id="_CPPv313ArrowInterval"></span><span id="_CPPv213ArrowInterval"></span><span id="ArrowInterval"></span><span class="target" id="struct_arrow_interval"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ArrowInterval</span></span></span><a class="headerlink" href="#_CPPv413ArrowInterval" title="Permalink to this definition">#</a><br /></dt> +<dd><div class="docutils container"> +<em>#include <nanoarrow_types.h></em></div> +<p>A representation of an interval. </p> +<div class="breathe-sectiondef docutils container"> +<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> +<dl class="cpp var"> +<dt class="sig sig-object cpp" id="_CPPv4N13ArrowInterval4typeE"> +<span id="_CPPv3N13ArrowInterval4typeE"></span><span id="_CPPv2N13ArrowInterval4typeE"></span><span id="ArrowInterval::type__ArrowType"></span><span class="target" id="struct_arrow_interval_1a7dc9d4034864c2c9f3f42b27a3281af2"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv49ArrowType" title="ArrowType"><span class="n"><span class="pre">ArrowType</span></span></a><span class="w"> </span><span class="sig-name des [...] +<dd><p>The type of interval being used. </p> +</dd></dl> + +<dl class="cpp var"> +<dt class="sig sig-object cpp" id="_CPPv4N13ArrowInterval6monthsE"> +<span id="_CPPv3N13ArrowInterval6monthsE"></span><span id="_CPPv2N13ArrowInterval6monthsE"></span><span id="ArrowInterval::months__int32_t"></span><span class="target" id="struct_arrow_interval_1a6bfd62f1ede83b0c53f4a34b849d134d"></span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">months</span></span></span><a class="headerlink" href="#_CPPv4N13ArrowInterval6monthsE" title="Permalink to th [...] +<dd><p>The number of months represented by the interval. </p> +</dd></dl> + +<dl class="cpp var"> +<dt class="sig sig-object cpp" id="_CPPv4N13ArrowInterval4daysE"> +<span id="_CPPv3N13ArrowInterval4daysE"></span><span id="_CPPv2N13ArrowInterval4daysE"></span><span id="ArrowInterval::days__int32_t"></span><span class="target" id="struct_arrow_interval_1abb6d828b58ad73f1d3e32322027229e1"></span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">days</span></span></span><a class="headerlink" href="#_CPPv4N13ArrowInterval4daysE" title="Permalink to this definit [...] +<dd><p>The number of days represented by the interval. </p> +</dd></dl> + +<dl class="cpp var"> +<dt class="sig sig-object cpp" id="_CPPv4N13ArrowInterval2msE"> +<span id="_CPPv3N13ArrowInterval2msE"></span><span id="_CPPv2N13ArrowInterval2msE"></span><span id="ArrowInterval::ms__int32_t"></span><span class="target" id="struct_arrow_interval_1a190895b648291795b90a00d56d8b6e6e"></span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ms</span></span></span><a class="headerlink" href="#_CPPv4N13ArrowInterval2msE" title="Permalink to this definition">#</a> [...] +<dd><p>The number of ms represented by the interval. </p> +</dd></dl> + +<dl class="cpp var"> +<dt class="sig sig-object cpp" id="_CPPv4N13ArrowInterval2nsE"> +<span id="_CPPv3N13ArrowInterval2nsE"></span><span id="_CPPv2N13ArrowInterval2nsE"></span><span id="ArrowInterval::ns__int64_t"></span><span class="target" id="struct_arrow_interval_1ae407e759217c83fb611af7d3c2237bb0"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ns</span></span></span><a class="headerlink" href="#_CPPv4N13ArrowInterval2nsE" title="Permalink to this definition">#</a> [...] +<dd><p>The number of ns represented by the interval. </p> +</dd></dl> + +</div> +</dd></dl> + <dl class="cpp struct"> <dt class="sig sig-object cpp" id="_CPPv412ArrowDecimal"> <span id="_CPPv312ArrowDecimal"></span><span id="_CPPv212ArrowDecimal"></span><span id="ArrowDecimal"></span><span class="target" id="struct_arrow_decimal"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ArrowDecimal</span></span></span><a class="headerlink" href="#_CPPv412ArrowDecimal" title="Permalink to this definition">#</a><br /></dt> diff --git a/dev/searchindex.js b/dev/searchindex.js index 4f879b2..216eeef 100644 --- a/dev/searchindex.js +++ b/dev/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["getting-started", "getting-started_generated", "index", "reference/c", "reference/cpp", "reference/device", "reference/index", "reference/ipc", "reference/r"], "filenames": ["getting-started.rst", "getting-started_generated.rst", "index.rst", "reference/c.rst", "reference/cpp.rst", "reference/device.rst", "reference/index.rst", "reference/ipc.rst", "reference/r.rst"], "titles": ["Getting started with nanoarrow", "Getting started with nanoarrow", "nanoarrow" [...] \ No newline at end of file +Search.setIndex({"docnames": ["getting-started", "getting-started_generated", "index", "reference/c", "reference/cpp", "reference/device", "reference/index", "reference/ipc", "reference/r"], "filenames": ["getting-started.rst", "getting-started_generated.rst", "index.rst", "reference/c.rst", "reference/cpp.rst", "reference/device.rst", "reference/index.rst", "reference/ipc.rst", "reference/r.rst"], "titles": ["Getting started with nanoarrow", "Getting started with nanoarrow", "nanoarrow" [...] \ No newline at end of file