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 20233da update documentation for tag dev
20233da is described below
commit 20233daf87f3aa4972ca3dd1544e6cbb2abc1549
Author: GitHub Actions <[email protected]>
AuthorDate: Fri Dec 2 16:15:10 2022 +0000
update documentation for tag dev
---
dev/c.html | 12 ++++++++++++
dev/genindex.html | 8 ++++++--
dev/objects.inv | Bin 11402 -> 11467 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/index.html | 8 ++++----
...noarrow_build_id.html => nanoarrow_version.html} | 10 +++++-----
dev/r/search.json | 2 +-
dev/r/sitemap.xml | 4 ++--
dev/searchindex.js | 2 +-
11 files changed, 35 insertions(+), 19 deletions(-)
diff --git a/dev/c.html b/dev/c.html
index ecc339f..41a2d3a 100644
--- a/dev/c.html
+++ b/dev/c.html
@@ -1604,6 +1604,18 @@
<dd><p>Return the build id against which the library was compiled. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv421ArrowNanoarrowVersionv">
+<span id="_CPPv321ArrowNanoarrowVersionv"></span><span
id="_CPPv221ArrowNanoarrowVersionv"></span><span
id="ArrowNanoarrowVersion"></span><span class="target"
id="group__nanoarrow-utils_1gadfbd3a7cfe179522a05f1629b8dacc94"></span><span
class="k"><span class="pre">const</span></span><span class="w"> </span><span
class="kt"><span class="pre">char</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span class="n"><span class [...]
+<dd><p>Return a version string in the form “major.minor.patch”. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv424ArrowNanoarrowVersionIntv">
+<span id="_CPPv324ArrowNanoarrowVersionIntv"></span><span
id="_CPPv224ArrowNanoarrowVersionIntv"></span><span
id="ArrowNanoarrowVersionInt"></span><span class="target"
id="group__nanoarrow-utils_1ga7c33bbfd2b0895dc2972adf5468e8ae0"></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">ArrowNanoarrowVersionInt</span></span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span><a [...]
+<dd><p>Return an integer that can be used to compare versions sequentially.
</p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv415ArrowLayoutInitP11ArrowLayout9ArrowType">
<span id="_CPPv315ArrowLayoutInitP11ArrowLayout9ArrowType"></span><span
id="_CPPv215ArrowLayoutInitP11ArrowLayout9ArrowType"></span><span
id="ArrowLayoutInit__ArrowLayoutP.ArrowType"></span><span class="target"
id="group__nanoarrow-utils_1gac1954fef441ad60b50e688b58ee04280"></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">ArrowLayoutInit</span></span></span><span class="sig-paren">(</span
[...]
diff --git a/dev/genindex.html b/dev/genindex.html
index 5b5df70..0fe79ab 100644
--- a/dev/genindex.html
+++ b/dev/genindex.html
@@ -530,10 +530,10 @@
</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>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="c.html#_CPPv4N15ArrowBufferView7n_bytesE">ArrowBufferView::n_bytes (C++
member)</a>
</li>
<li><a href="c.html#_CPPv413ArrowCharViewPKc">ArrowCharView (C++
function)</a>
@@ -589,6 +589,10 @@
<li><a href="c.html#_CPPv419ArrowMetadataSizeOfPKc">ArrowMetadataSizeOf
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv421ArrowNanoarrowBuildIdv">ArrowNanoarrowBuildId (C++
function)</a>
+</li>
+ <li><a
href="c.html#_CPPv421ArrowNanoarrowVersionv">ArrowNanoarrowVersion (C++
function)</a>
+</li>
+ <li><a
href="c.html#_CPPv424ArrowNanoarrowVersionIntv">ArrowNanoarrowVersionInt (C++
function)</a>
</li>
<li><a href="c.html#_CPPv412ArrowReallocPv7int64_t">ArrowRealloc (C++
function)</a>
</li>
diff --git a/dev/objects.inv b/dev/objects.inv
index 7cc9020..88ef2fb 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 a60ce98..16df15d 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-02T13:44Z
+last_built: 2022-12-02T16:14Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index 99854be..6abb03f 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 0x55e5324556e8></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x56397282b1e8></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 0x55e53365dfc8></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x563974c7e118></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 0371043..2e051f1 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 0x55e533086378></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x563974fcf8b8></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/index.html b/dev/r/reference/index.html
index 8ecac96..ab9014c 100644
--- a/dev/r/reference/index.html
+++ b/dev/r/reference/index.html
@@ -83,14 +83,14 @@
<dd>Infer an R vector prototype</dd>
</dl><dl><dt>
- <code><a
href="nanoarrow_build_id.html">nanoarrow_build_id()</a></code>
+ <code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_is_valid()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_dbl()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_chr()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_pretty()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_release()</a></code>
<code><a href="nanoarrow_pointer_is_vali [...]
</dt>
- <dd>Underlying 'nanoarrow' C library build</dd>
+ <dd>Danger zone: low-level pointer operations</dd>
</dl><dl><dt>
- <code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_is_valid()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_dbl()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_chr()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_pretty()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_release()</a></code>
<code><a href="nanoarrow_pointer_is_vali [...]
+ <code><a
href="nanoarrow_version.html">nanoarrow_version()</a></code>
</dt>
- <dd>Danger zone: low-level pointer operations</dd>
+ <dd>Underlying 'nanoarrow' C library build</dd>
</dl></div>
</main></div>
diff --git a/dev/r/reference/nanoarrow_build_id.html
b/dev/r/reference/nanoarrow_version.html
similarity index 53%
rename from dev/r/reference/nanoarrow_build_id.html
rename to dev/r/reference/nanoarrow_version.html
index e2cc0fd..35cc764 100644
--- a/dev/r/reference/nanoarrow_build_id.html
+++ b/dev/r/reference/nanoarrow_version.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta
http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta
charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta
name="viewport" content="width=device-width, initial-scale=1,
shrink-to-fit=no"><meta name="description" content="Underlying 'nanoarrow' C
library build"><title>Underlying 'nanoarrow' C library build —
nanoarrow_build_id • nanoarrow</title><script src="../deps/jquery-3.6. [...]
+<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta
http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta
charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta
name="viewport" content="width=device-width, initial-scale=1,
shrink-to-fit=no"><meta name="description" content="Underlying 'nanoarrow' C
library build"><title>Underlying 'nanoarrow' C library build —
nanoarrow_version • nanoarrow</title><script src="../deps/jquery-3.6.0 [...]
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js";></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script>
<![endif]--></head><body>
@@ -39,7 +39,7 @@
<main id="main" class="col-md-9"><div class="page-header">
<img src="" class="logo" alt=""><h1>Underlying 'nanoarrow' C library
build</h1>
<small class="dont-index">Source: <a
href="https://github.com/apache/arrow-nanoarrow/blob/HEAD/R/nanoarrow-package.R";
class="external-link"><code>R/nanoarrow-package.R</code></a></small>
- <div class="d-none name"><code>nanoarrow_build_id.Rd</code></div>
+ <div class="d-none name"><code>nanoarrow_version.Rd</code></div>
</div>
<div class="ref-description section level2">
@@ -48,7 +48,7 @@
<div class="section level2">
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor"
href="#ref-usage"></a></h2>
- <div class="sourceCode"><pre class="sourceCode r"><code><span><span
class="fu">nanoarrow_build_id</span><span class="op">(</span>runtime <span
class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span></code></pre></div>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span
class="fu">nanoarrow_version</span><span class="op">(</span>runtime <span
class="op">=</span> <span class="cn">TRUE</span><span
class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
@@ -68,8 +68,8 @@ was compiled against.</p>
<div class="section level2">
<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="fu">nanoarrow_build_id</span><span
class="op">(</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "N8uQ5DsuAD"</span>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="fu">nanoarrow_version</span><span
class="op">(</span><span class="op">)</span></span></span>
+<span class="r-out co"><span class="r-pr">#></span> [1]
"0.1.0-SNAPSHOT"</span>
<span class="r-in"><span></span></span>
</code></pre></div>
</div>
diff --git a/dev/r/search.json b/dev/r/search.json
index a359adf..fc3cf37 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/r/sitemap.xml b/dev/r/sitemap.xml
index 932c5ac..15dab6d 100644
--- a/dev/r/sitemap.xml
+++ b/dev/r/sitemap.xml
@@ -37,9 +37,9 @@
<loc>/reference/nanoarrow-package.html</loc>
</url>
<url>
- <loc>/reference/nanoarrow_build_id.html</loc>
+ <loc>/reference/nanoarrow_pointer_is_valid.html</loc>
</url>
<url>
- <loc>/reference/nanoarrow_pointer_is_valid.html</loc>
+ <loc>/reference/nanoarrow_version.html</loc>
</url>
</urlset>
diff --git a/dev/searchindex.js b/dev/searchindex.js
index ce8a241..ddf474d 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
