You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by we...@apache.org on 2018/08/07 01:03:01 UTC

[46/51] [partial] arrow-site git commit: Update documentation for 0.10.0

http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7f9d5fdc/docs/cpp/adapter_8h_source.html
----------------------------------------------------------------------
diff --git a/docs/cpp/adapter_8h_source.html b/docs/cpp/adapter_8h_source.html
index 9d90f20..29bfa51 100644
--- a/docs/cpp/adapter_8h_source.html
+++ b/docs/cpp/adapter_8h_source.html
@@ -71,7 +71,7 @@ $(function() {
 </div><!--header-->
 <div class="contents">
 <a href="adapter_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>&#160;<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>&#160;<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>&#160;<span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<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>&#160;<span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class
 ="lineno">    6</span>&#160;<span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<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>&#160;<span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<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>&#160;<span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<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>&#160;<span class="comment">// software distributed u
 nder the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">// &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<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>&#160;<span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#ifndef ARROW_ORC_CONVERTER_H</span></div><div class="line"><a name="l00019"></a><span class="lineno
 ">   19</span>&#160;<span class="preprocessor">#define ARROW_ORC_CONVERTER_H</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="interfaces_8h.html">arrow/io/interfaces.h</a>&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#incl
 ude &quot;<a class="code" href="memory__pool_8h.html">arrow/memory_pool.h</a>&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="record__batch_8h.html">arrow/record_batch.h</a>&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="status_8h.html">arrow/status.h</a>&quot;</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="type_8h.html">arrow/type.h</a>&quot;</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>&quot;</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="lin
 e"><a name="l00032"></a><span class="lineno"><a class="line" href="namespacearrow.html">   32</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespacearrow_1_1adapters.html">   34</a></span>&#160;<span class="keyword">namespace </span>adapters {</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespacearrow_1_1adapters_1_1orc.html">   36</a></span>&#160;<span class="keyword">namespace </span>orc {</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html">   40</a><
 /span>&#160;<span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html">ORCFileReader</a> {</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  ~<a class="code" href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html">ORCFileReader</a>();</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr&lt;io::ReadableFileInterface&gt;&amp; file,</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;                     <a class="code" href="classarrow_1_1_memory_pool.html">Memo
 ryPool</a>* pool, std::unique_ptr&lt;ORCFileReader&gt;* reader);</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadSchema(std::shared_ptr&lt;Schema&gt;* out);</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(std::shared_ptr&lt;Table&gt;* out);</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(<span class="keyword">const</span> std::vector&lt;int&gt;&amp; include_indices, std::shared_ptr&lt;Table&gt;* out);</div><div class="line"><a name="
 l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadStripe(int64_t stripe, std::shared_ptr&lt;RecordBatch&gt;* out);</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadStripe(int64_t stripe, <span class="keyword">const</span> std::vector&lt;int&gt;&amp; include_indices,</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;                    std::shared_ptr&lt;RecordBatch&gt;* out);</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;  int64_t NumberOfStripes();</div><div class="line"><a name="l00089"></a><span cl
 ass="lineno">   89</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  int64_t NumberOfRows();</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;  <span class="keyword">class </span>Impl;</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;  std::unique_ptr&lt;Impl&gt; impl_;</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;  <a class="code" href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html">ORCFileReader</a>();</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;};</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div><div class="line"><a name="l00099"></a><spa
 n class="lineno">   99</span>&#160;}  <span class="comment">// namespace orc</span></div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;}  <span class="comment">// namespace adapters</span></div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;}  <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="preprocessor">#endif  // ARROW_ORC_CONVERTER_H</span></div><div class="ttc" id="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader_html"><div class="ttname"><a href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html">arrow::adapters::orc::ORCFileReader</a></div><div class="ttdoc">Read 
 an Arrow Table or RecordBatch from an ORC file. </div><div class="ttdef"><b>Definition:</b> adapter.h:40</div></div>
-<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:93</div></div>
+<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:94</div></div>
 <div class="ttc" id="interfaces_8h_html"><div class="ttname"><a href="interfaces_8h.html">interfaces.h</a></div></div>
 <div class="ttc" id="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.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>

http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7f9d5fdc/docs/cpp/allocator_8h_source.html
----------------------------------------------------------------------
diff --git a/docs/cpp/allocator_8h_source.html b/docs/cpp/allocator_8h_source.html
index 332d296..5cd78d1 100644
--- a/docs/cpp/allocator_8h_source.html
+++ b/docs/cpp/allocator_8h_source.html
@@ -78,8 +78,8 @@ $(function() {
 <div class="ttc" id="macros_8h_html_a3ef7eab8cd0e570b6586628cc9d5ccab"><div class="ttname"><a href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a></div><div class="ttdeci">#define NULLPTR</div><div class="ttdef"><b>Definition:</b> macros.h:69</div></div>
 <div class="ttc" id="classarrow_1_1stl__allocator_html_a2d0de6d0a6a43e2cca7b980a6fedc375"><div class="ttname"><a href="classarrow_1_1stl__allocator.html#a2d0de6d0a6a43e2cca7b980a6fedc375">arrow::stl_allocator::pointer</a></div><div class="ttdeci">T * pointer</div><div class="ttdef"><b>Definition:</b> allocator.h:35</div></div>
 <div class="ttc" id="classarrow_1_1stl__allocator_html_aa8a67276663a6f604bc1c34d7602e9df"><div class="ttname"><a href="classarrow_1_1stl__allocator.html#aa8a67276663a6f604bc1c34d7602e9df">arrow::stl_allocator::size_type</a></div><div class="ttdeci">std::size_t size_type</div><div class="ttdef"><b>Definition:</b> allocator.h:39</div></div>
-<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:93</div></div>
-<div class="ttc" id="classarrow_1_1_status_html_a2240d82ac632c582efc070af2fe9a5ec"><div class="ttname"><a href="classarrow_1_1_status.html#a2240d82ac632c582efc070af2fe9a5ec">arrow::Status::ok</a></div><div class="ttdeci">bool ok() const</div><div class="ttdef"><b>Definition:</b> status.h:162</div></div>
+<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:94</div></div>
+<div class="ttc" id="classarrow_1_1_status_html_a2240d82ac632c582efc070af2fe9a5ec"><div class="ttname"><a href="classarrow_1_1_status.html#a2240d82ac632c582efc070af2fe9a5ec">arrow::Status::ok</a></div><div class="ttdeci">bool ok() const</div><div class="ttdef"><b>Definition:</b> status.h:179</div></div>
 <div class="ttc" id="macros_8h_html"><div class="ttname"><a href="macros_8h.html">macros.h</a></div></div>
 <div class="ttc" id="classarrow_1_1stl__allocator_html_abcb413f5f18708e06fef91f20e20d2ab"><div class="ttname"><a href="classarrow_1_1stl__allocator.html#abcb413f5f18708e06fef91f20e20d2ab">arrow::stl_allocator::stl_allocator</a></div><div class="ttdeci">stl_allocator(const stl_allocator&lt; U &gt; &amp;rhs) noexcept</div><div class="ttdef"><b>Definition:</b> allocator.h:51</div></div>
 <div class="ttc" id="namespacearrow_html_aebe81d544faaf827b8f32c5a80b99820"><div class="ttname"><a href="namespacearrow.html#aebe81d544faaf827b8f32c5a80b99820">arrow::default_memory_pool</a></div><div class="ttdeci">MemoryPool * default_memory_pool()</div></div>