You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by uw...@apache.org on 2017/11/04 10:38:06 UTC
[48/51] [partial] arrow-site git commit: API doc update
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/api_8h.html
----------------------------------------------------------------------
diff --git a/docs/cpp/api_8h.html b/docs/cpp/api_8h.html
index 234055f..5b84adb 100644
--- a/docs/cpp/api_8h.html
+++ b/docs/cpp/api_8h.html
@@ -77,6 +77,7 @@ $(function() {
<code>#include "<a class="el" href="pretty__print_8h_source.html">arrow/pretty_print.h</a>"</code><br />
<code>#include "<a class="el" href="status_8h_source.html">arrow/status.h</a>"</code><br />
<code>#include "<a class="el" href="table_8h_source.html">arrow/table.h</a>"</code><br />
+<code>#include "<a class="el" href="table__builder_8h_source.html">arrow/table_builder.h</a>"</code><br />
<code>#include "<a class="el" href="tensor_8h_source.html">arrow/tensor.h</a>"</code><br />
<code>#include "<a class="el" href="type_8h_source.html">arrow/type.h</a>"</code><br />
<code>#include "<a class="el" href="visitor_8h_source.html">arrow/visitor.h</a>"</code><br />
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/api_8h_source.html
----------------------------------------------------------------------
diff --git a/docs/cpp/api_8h_source.html b/docs/cpp/api_8h_source.html
index 74ca637..e8a728e 100644
--- a/docs/cpp/api_8h_source.html
+++ b/docs/cpp/api_8h_source.html
@@ -67,10 +67,10 @@ $(function() {
<div class="title">api.h</div> </div>
</div><!--header-->
<div class="contents">
-<a href="api_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class="li
neno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed under
the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Coarse public API while the library is in development</span></div><div class="line"><a name="l00019"></a><
span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_API_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_API_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="array_8h.html">arrow/array.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="buffer_8h.html">arrow/buffer.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="builder_8h.html">arrow/builder.h</a>"</span></div><div class
="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="compare_8h.html">arrow/compare.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="memory__pool_8h.html">arrow/memory_pool.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="pretty__print_8h.html">arrow/pretty_print.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="table_8h.html">arrow/table.h</a>"</span></div><div cla
ss="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="tensor_8h.html">arrow/tensor.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="type_8h.html">arrow/type.h</a>"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="visitor_8h.html">arrow/visitor.h</a>"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {}</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>
0;<span class="preprocessor">#endif // ARROW_API_H</span></div><div class="ttc" id="array_8h_html"><div class="ttname"><a href="array_8h.html">array.h</a></div></div>
+<a href="api_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class="li
neno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed under
the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Coarse public API while the library is in development</span></div><div class="line"><a name="l00019"></a><
span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_API_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_API_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="array_8h.html">arrow/array.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="buffer_8h.html">arrow/buffer.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="builder_8h.html">arrow/builder.h</a>"</span></div><div class
="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="compare_8h.html">arrow/compare.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="memory__pool_8h.html">arrow/memory_pool.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="pretty__print_8h.html">arrow/pretty_print.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="table_8h.html">arrow/table.h</a>"</span></div><div cla
ss="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="table__builder_8h.html">arrow/table_builder.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="tensor_8h.html">arrow/tensor.h</a>"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="type_8h.html">arrow/type.h</a>"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "<a class="code" href="visitor_8h.html">arrow/visitor.h</a>"</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span><a class="c
ode" href="namespacearrow.html">arrow</a> {}</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#endif // ARROW_API_H</span></div><div class="ttc" id="array_8h_html"><div class="ttname"><a href="array_8h.html">array.h</a></div></div>
<div class="ttc" id="tensor_8h_html"><div class="ttname"><a href="tensor_8h.html">tensor.h</a></div></div>
<div class="ttc" id="memory__pool_8h_html"><div class="ttname"><a href="memory__pool_8h.html">memory_pool.h</a></div></div>
-<div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> allocator.h:28</div></div>
+<div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> allocator.h:29</div></div>
<div class="ttc" id="visitor_8h_html"><div class="ttname"><a href="visitor_8h.html">visitor.h</a></div></div>
<div class="ttc" id="pretty__print_8h_html"><div class="ttname"><a href="pretty__print_8h.html">pretty_print.h</a></div></div>
<div class="ttc" id="builder_8h_html"><div class="ttname"><a href="builder_8h.html">builder.h</a></div></div>
@@ -78,6 +78,7 @@ $(function() {
<div class="ttc" id="buffer_8h_html"><div class="ttname"><a href="buffer_8h.html">buffer.h</a></div></div>
<div class="ttc" id="compare_8h_html"><div class="ttname"><a href="compare_8h.html">compare.h</a></div></div>
<div class="ttc" id="table_8h_html"><div class="ttname"><a href="table_8h.html">table.h</a></div></div>
+<div class="ttc" id="table__builder_8h_html"><div class="ttname"><a href="table__builder_8h.html">table_builder.h</a></div></div>
<div class="ttc" id="type_8h_html"><div class="ttname"><a href="type_8h.html">type.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/array_8h.html
----------------------------------------------------------------------
diff --git a/docs/cpp/array_8h.html b/docs/cpp/array_8h.html
index 4e29015..edeff77 100644
--- a/docs/cpp/array_8h.html
+++ b/docs/cpp/array_8h.html
@@ -144,14 +144,12 @@ Functions</h2></td></tr>
<tr class="memitem:afb8595b074fc27a018140f07a26ac23e"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#afb8595b074fc27a018140f07a26ac23e">arrow::MakeArray</a> (const std::shared_ptr< ArrayData > &data, std::shared_ptr< Array > *out)</td></tr>
<tr class="memdesc:afb8595b074fc27a018140f07a26ac23e"><td class="mdescLeft"> </td><td class="mdescRight">Create a strongly-typed <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> instance from generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a>. <a href="namespacearrow.html#afb8595b074fc27a018140f07a26ac23e">More...</a><br /></td></tr>
<tr class="separator:afb8595b074fc27a018140f07a26ac23e"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a7edcc7f88dec3ddcfcd8ccf1882cb833"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< Array > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a7edcc7f88dec3ddcfcd8ccf1882cb833">arrow::MakeArray</a> (const std::shared_ptr< ArrayData > &data)</td></tr>
+<tr class="memdesc:a7edcc7f88dec3ddcfcd8ccf1882cb833"><td class="mdescLeft"> </td><td class="mdescRight">Create a strongly-typed <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> instance from generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a>. <a href="namespacearrow.html#a7edcc7f88dec3ddcfcd8ccf1882cb833">More...</a><br /></td></tr>
+<tr class="separator:a7edcc7f88dec3ddcfcd8ccf1882cb833"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d7f9de4d0e093f54ec24db3fc64102d"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a7d7f9de4d0e093f54ec24db3fc64102d">arrow::ValidateArray</a> (const Array &array)</td></tr>
<tr class="memdesc:a7d7f9de4d0e093f54ec24db3fc64102d"><td class="mdescLeft"> </td><td class="mdescRight">Perform any validation checks to determine obvious inconsistencies with the array's internal data. <a href="namespacearrow.html#a7d7f9de4d0e093f54ec24db3fc64102d">More...</a><br /></td></tr>
<tr class="separator:a7d7f9de4d0e093f54ec24db3fc64102d"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a5d3f7c3c7754a7509f4a8d2777be1718"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a5d3f7c3c7754a7509f4a8d2777be1718">arrow::MakePrimitiveArray</a> (const std::shared_ptr< DataType > &type, int64_t length, const std::shared_ptr< Buffer > &data, const std::shared_ptr< Buffer > &null_bitmap, int64_t null_count, int64_t offset, std::shared_ptr< Array > *out)</td></tr>
-<tr class="memdesc:a5d3f7c3c7754a7509f4a8d2777be1718"><td class="mdescLeft"> </td><td class="mdescRight">Create new arrays for logical types that are backed by primitive arrays. <a href="namespacearrow.html#a5d3f7c3c7754a7509f4a8d2777be1718">More...</a><br /></td></tr>
-<tr class="separator:a5d3f7c3c7754a7509f4a8d2777be1718"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a04982a7ef335f7cb4b351230b88eb9cd"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a04982a7ef335f7cb4b351230b88eb9cd">arrow::MakePrimitiveArray</a> (const std::shared_ptr< DataType > &type, const std::vector< std::shared_ptr< Buffer >> &buffers, int64_t length, int64_t null_count, int64_t offset, std::shared_ptr< Array > *out)</td></tr>
-<tr class="separator:a04982a7ef335f7cb4b351230b88eb9cd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>