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 2018/05/18 07:47:20 UTC
[19/51] [partial] arrow-site git commit: Update API docs
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/c77df435/docs/cpp/io_2memory_8h_source.html
----------------------------------------------------------------------
diff --git a/docs/cpp/io_2memory_8h_source.html b/docs/cpp/io_2memory_8h_source.html
index 5c5684e..a10f286 100644
--- a/docs/cpp/io_2memory_8h_source.html
+++ b/docs/cpp/io_2memory_8h_source.html
@@ -70,14 +70,14 @@ $(function() {
<div class="title">memory.h</div> </div>
</div><!--header-->
<div class="contents">
-<a href="io_2memory_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 cl
ass="lineno"> 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 distribute
d 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">// Public API for different memory sharing / IO mechanisms</span></div><div class="line"><a name="l000
19"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_IO_MEMORY_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IO_MEMORY_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 <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="interfaces_8h.html">arrow/io/interfaces.h</a>"</span></div><
div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>Buffer;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>ResizableBuffer;</div><div class="line"><a name="l00034"></a><span class="li
neno"> 34</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>io {</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> <span class="comment">// \brief An output stream that writes to a resizable buffer</span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_output_stream.html"> 39</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html">BufferOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_output_stream.html">OutputStream</a> {</div><div class="line"><a name="l00040"></a>
<span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html">BufferOutputStream</a>(<span class="keyword">const</span> std::shared_ptr<ResizableBuffer>& buffer);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Create(int64_t initial_capacity, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  std::shared_ptr<BufferOutputStream>* out);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </
div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  ~<a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html">BufferOutputStream</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Implement the OutputStream interface</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classarrow_1_1_status.htm
l">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Finish(std::shared_ptr<Buffer>* result);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// Ensures there is sufficient space available to write nbytes</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Reserve(int64_t nbytes);</div><div c
lass="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  std::shared_ptr<ResizableBuffer> buffer_;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">bool</span> is_open_;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  int64_t capacity_;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  int64_t position_;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  uint8_t* mutable_data_;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> };</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// \brief A helper class to tracks the size of allocations</span><
/div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_mock_output_stream.html"> 68</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_mock_output_stream.html">MockOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_output_stream.html">OutputStream</a> {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_mock_output_stream.html#aeffcb55e9b83be6037d8596d116f183b"> 70</a></span>  <a class="code" href="classarrow_1_1io_1_1_mock_output_stream.html#aeffcb55e9b83be6037d8596d116f183b">MockOutputStream</a>() : extent_bytes_written_(0) {}</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l0
0072"></a><span class="lineno"> 72</span>  <span class="comment">// Implement the OutputStream interface</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classarrow_
1_1io_1_1_mock_output_stream.html#a38536d0cd4808fd6af4f23326145cffe"> 77</a></span>  int64_t <a class="code" href="classarrow_1_1io_1_1_mock_output_stream.html#a38536d0cd4808fd6af4f23326145cffe">GetExtentBytesWritten</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> extent_bytes_written_; }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  int64_t extent_bytes_written_;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> };</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html"> 84</a></span> <span class
="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">FixedSizeBufferWriter</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_writeable_file.html">WriteableFile</a> {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">FixedSizeBufferWriter</a>(<span class="keyword">const</span> std::shared_ptr<Buffer>& buffer);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  ~<a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">FixedSizeBufferWriter</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div
><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="cod
e" href="classarrow_1_1_status.html">Status</a> WriteAt(int64_t position, <span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> set_memcopy_threads(<span class="keywordtype">int</span> num_threads);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> set_memcopy_blocksize(int64_t blocksize);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">void</span> set_memcopy_threshold(int64_t threshold);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class=
"keyword">protected</span>:</div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a03fe73b61469276c535aa3fef56db5c3"> 101</a></span>  <span class="keyword">class </span>FixedSizeBufferWriterImpl;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  std::unique_ptr<FixedSizeBufferWriterImpl> <a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a03fe73b61469276c535aa3fef56db5c3">impl_</a>;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> };</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html"> 107</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader</a> : <span c
lass="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">RandomAccessFile</a> {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader</a>(<span class="keyword">const</span> std::shared_ptr<Buffer>& buffer);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a>& buffer);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader<
/a>(<span class="keyword">const</span> uint8_t* data, int64_t size);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, int64_t* bytes_read, <span class="keywordtype">void</span>* buffer) <span class="keyword">override</span>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&
#160; <span class="comment">// Zero copy read</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, int64_t* bytes_read,</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, std::shared_ptr<Buffer>* out) <spa
n class="keyword">override</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> GetSize(int64_t* size) <span class="keyword">override</span>;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</span>;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1
_1_buffer_reader.html#aa1491beffa2e6b2bc025e25c67886492"> 130</a></span>  std::shared_ptr<Buffer> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#aa1491beffa2e6b2bc025e25c67886492">buffer</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> buffer_; }</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a245edeff7186cc5f173cda2c1e925314"> 133</a></span>  std::shared_ptr<Buffer> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a245edeff7186cc5f173cda2c1e925314">buffer_</a>;</div><div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a7884a6f59fa0db820f86a861ef
6851cc"> 134</a></span>  <span class="keyword">const</span> uint8_t* <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a7884a6f59fa0db820f86a861ef6851cc">data_</a>;</div><div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a3f1655cf6afa7e0799f6c6914fe570e6"> 135</a></span>  int64_t <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a3f1655cf6afa7e0799f6c6914fe570e6">size_</a>;</div><div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a38c69e817deb97bbaf521824f46e2961"> 136</a></span>  int64_t <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a38c69e817deb97bbaf521824f46e2961">position_</a>;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> };</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00
139"></a><span class="lineno"> 139</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">#endif // ARROW_IO_MEMORY_H</span></div><div class="ttc" id="classarrow_1_1io_1_1_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:111</div></div>
-<div class="ttc" id="classarrow_1_1io_1_1_writeable_file_html"><div class="ttname"><a href="classarrow_1_1io_1_1_writeable_file.html">arrow::io::WriteableFile</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:163</div></div>
-<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_aa1491beffa2e6b2bc025e25c67886492"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#aa1491beffa2e6b2bc025e25c67886492">arrow::io::BufferReader::buffer</a></div><div class="ttdeci">std::shared_ptr< Buffer > buffer() const</div><div class="ttdef"><b>Definition:</b> memory.h:130</div></div>
+<a href="io_2memory_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 cl
ass="lineno"> 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 distribute
d 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">// Public API for different memory sharing / IO mechanisms</span></div><div class="line"><a name="l000
19"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_IO_MEMORY_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IO_MEMORY_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 <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="interfaces_8h.html">arrow/io/interfaces.h</a>"</span></div><
div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>Buffer;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>ResizableBuffer;</div><div class="line"><a name="l00034"></a><span class="li
neno"> 34</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>io {</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> <span class="comment">// \brief An output stream that writes to a resizable buffer</span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_output_stream.html"> 39</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html">BufferOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_output_stream.html">OutputStream</a> {</div><div class="line"><a name="l00040"></a>
<span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html">BufferOutputStream</a>(<span class="keyword">const</span> std::shared_ptr<ResizableBuffer>& buffer);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Create(int64_t initial_capacity, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  std::shared_ptr<BufferOutputStream>* out);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </
div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  ~<a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html">BufferOutputStream</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Implement the OutputStream interface</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classarrow_1_1_status.htm
l">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Finish(std::shared_ptr<Buffer>* result);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// Ensures there is sufficient space available to write nbytes</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Reserve(int64_t nbytes);</div><div c
lass="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  std::shared_ptr<ResizableBuffer> buffer_;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">bool</span> is_open_;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  int64_t capacity_;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  int64_t position_;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  uint8_t* mutable_data_;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> };</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// \brief A helper class to tracks the size of allocations</span><
/div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_mock_output_stream.html"> 68</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_mock_output_stream.html">MockOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_output_stream.html">OutputStream</a> {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_mock_output_stream.html#aeffcb55e9b83be6037d8596d116f183b"> 70</a></span>  <a class="code" href="classarrow_1_1io_1_1_mock_output_stream.html#aeffcb55e9b83be6037d8596d116f183b">MockOutputStream</a>() : extent_bytes_written_(0) {}</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l0
0072"></a><span class="lineno"> 72</span>  <span class="comment">// Implement the OutputStream interface</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classarrow_
1_1io_1_1_mock_output_stream.html#a38536d0cd4808fd6af4f23326145cffe"> 77</a></span>  int64_t <a class="code" href="classarrow_1_1io_1_1_mock_output_stream.html#a38536d0cd4808fd6af4f23326145cffe">GetExtentBytesWritten</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> extent_bytes_written_; }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  int64_t extent_bytes_written_;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> };</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html"> 84</a></span> <span class
="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">FixedSizeBufferWriter</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_writeable_file.html">WriteableFile</a> {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">FixedSizeBufferWriter</a>(<span class="keyword">const</span> std::shared_ptr<Buffer>& buffer);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  ~<a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">FixedSizeBufferWriter</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div
><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="cod
e" href="classarrow_1_1_status.html">Status</a> WriteAt(int64_t position, <span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> set_memcopy_threads(<span class="keywordtype">int</span> num_threads);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> set_memcopy_blocksize(int64_t blocksize);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">void</span> set_memcopy_threshold(int64_t threshold);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class=
"keyword">protected</span>:</div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a03fe73b61469276c535aa3fef56db5c3"> 101</a></span>  <span class="keyword">class </span>FixedSizeBufferWriterImpl;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  std::unique_ptr<FixedSizeBufferWriterImpl> <a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a03fe73b61469276c535aa3fef56db5c3">impl_</a>;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> };</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html"> 107</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader</a> : <span c
lass="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">RandomAccessFile</a> {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader</a>(<span class="keyword">const</span> std::shared_ptr<Buffer>& buffer);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a>& buffer);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader<
/a>(<span class="keyword">const</span> uint8_t* data, int64_t size);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, int64_t* bytes_read, <span class="keywordtype">void</span>* buffer) <span class="keyword">override</span>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="comment">// Zero copy read</span></div><div class="line"><a name
="l00117"></a><span class="lineno"> 117</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, int64_t* bytes_read,</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00122"></a><span
class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> GetSize(int64_t* size) <span class="keyword">override</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</span>;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#aa1491beffa2e6b2bc025e25c67886492"> 128</a></span>  std
::shared_ptr<Buffer> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#aa1491beffa2e6b2bc025e25c67886492">buffer</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> buffer_; }</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a245edeff7186cc5f173cda2c1e925314"> 131</a></span>  std::shared_ptr<Buffer> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a245edeff7186cc5f173cda2c1e925314">buffer_</a>;</div><div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a7884a6f59fa0db820f86a861ef6851cc"> 132</a></span>  <span class="keyword">const</span> uint8_t* <a class
="code" href="classarrow_1_1io_1_1_buffer_reader.html#a7884a6f59fa0db820f86a861ef6851cc">data_</a>;</div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a3f1655cf6afa7e0799f6c6914fe570e6"> 133</a></span>  int64_t <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a3f1655cf6afa7e0799f6c6914fe570e6">size_</a>;</div><div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a38c69e817deb97bbaf521824f46e2961"> 134</a></span>  int64_t <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a38c69e817deb97bbaf521824f46e2961">position_</a>;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> };</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> } <span class="comment">// namespac
e io</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="preprocessor">#endif // ARROW_IO_MEMORY_H</span></div><div class="ttc" id="classarrow_1_1io_1_1_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:111</div></div>
+<div class="ttc" id="classarrow_1_1io_1_1_writeable_file_html"><div class="ttname"><a href="classarrow_1_1io_1_1_writeable_file.html">arrow::io::WriteableFile</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:165</div></div>
+<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_aa1491beffa2e6b2bc025e25c67886492"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#aa1491beffa2e6b2bc025e25c67886492">arrow::io::BufferReader::buffer</a></div><div class="ttdeci">std::shared_ptr< Buffer > buffer() const</div><div class="ttdef"><b>Definition:</b> memory.h:128</div></div>
<div class="ttc" id="classarrow_1_1io_1_1_random_access_file_html"><div class="ttname"><a href="classarrow_1_1io_1_1_random_access_file.html">arrow::io::RandomAccessFile</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:121</div></div>
<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html">arrow::io::BufferReader</a></div><div class="ttdoc">Random access zero-copy reads on an arrow::Buffer. </div><div class="ttdef"><b>Definition:</b> memory.h:107</div></div>
<div class="ttc" id="classarrow_1_1io_1_1_buffer_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_output_stream.html">arrow::io::BufferOutputStream</a></div><div class="ttdef"><b>Definition:</b> memory.h:39</div></div>
-<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a7884a6f59fa0db820f86a861ef6851cc"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a7884a6f59fa0db820f86a861ef6851cc">arrow::io::BufferReader::data_</a></div><div class="ttdeci">const uint8_t * data_</div><div class="ttdef"><b>Definition:</b> memory.h:134</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:106</div></div>
+<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a7884a6f59fa0db820f86a861ef6851cc"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a7884a6f59fa0db820f86a861ef6851cc">arrow::io::BufferReader::data_</a></div><div class="ttdeci">const uint8_t * data_</div><div class="ttdef"><b>Definition:</b> memory.h:132</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="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="classarrow_1_1io_1_1_mock_output_stream_html_aeffcb55e9b83be6037d8596d116f183b"><div class="ttname"><a href="classarrow_1_1io_1_1_mock_output_stream.html#aeffcb55e9b83be6037d8596d116f183b">arrow::io::MockOutputStream::MockOutputStream</a></div><div class="ttdeci">MockOutputStream()</div><div class="ttdef"><b>Definition:</b> memory.h:70</div></div>
@@ -85,12 +85,12 @@ $(function() {
<div class="ttc" id="classarrow_1_1io_1_1_mock_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_mock_output_stream.html">arrow::io::MockOutputStream</a></div><div class="ttdef"><b>Definition:</b> memory.h:68</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> adapter.h:32</div></div>
<div class="ttc" id="classarrow_1_1io_1_1_fixed_size_buffer_writer_html_a03fe73b61469276c535aa3fef56db5c3"><div class="ttname"><a href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a03fe73b61469276c535aa3fef56db5c3">arrow::io::FixedSizeBufferWriter::impl_</a></div><div class="ttdeci">std::unique_ptr< FixedSizeBufferWriterImpl > impl_</div><div class="ttdef"><b>Definition:</b> memory.h:101</div></div>
-<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a245edeff7186cc5f173cda2c1e925314"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a245edeff7186cc5f173cda2c1e925314">arrow::io::BufferReader::buffer_</a></div><div class="ttdeci">std::shared_ptr< Buffer > buffer_</div><div class="ttdef"><b>Definition:</b> memory.h:133</div></div>
+<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a245edeff7186cc5f173cda2c1e925314"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a245edeff7186cc5f173cda2c1e925314">arrow::io::BufferReader::buffer_</a></div><div class="ttdeci">std::shared_ptr< Buffer > buffer_</div><div class="ttdef"><b>Definition:</b> memory.h:131</div></div>
<div class="ttc" id="classarrow_1_1_memory_pool_html"><div class="ttname"><a href="classarrow_1_1_memory_pool.html">arrow::MemoryPool</a></div><div class="ttdoc">Base class for memory allocation. </div><div class="ttdef"><b>Definition:</b> memory_pool.h:34</div></div>
<div class="ttc" id="classarrow_1_1io_1_1_fixed_size_buffer_writer_html"><div class="ttname"><a href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">arrow::io::FixedSizeBufferWriter</a></div><div class="ttdoc">Enables random writes into a fixed-size mutable buffer. </div><div class="ttdef"><b>Definition:</b> memory.h:84</div></div>
<div class="ttc" id="classarrow_1_1_buffer_html"><div class="ttname"><a href="classarrow_1_1_buffer.html">arrow::Buffer</a></div><div class="ttdoc">Object containing a pointer to a piece of contiguous memory with a particular size. </div><div class="ttdef"><b>Definition:</b> buffer.h:48</div></div>
-<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a38c69e817deb97bbaf521824f46e2961"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a38c69e817deb97bbaf521824f46e2961">arrow::io::BufferReader::position_</a></div><div class="ttdeci">int64_t position_</div><div class="ttdef"><b>Definition:</b> memory.h:136</div></div>
-<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a3f1655cf6afa7e0799f6c6914fe570e6"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a3f1655cf6afa7e0799f6c6914fe570e6">arrow::io::BufferReader::size_</a></div><div class="ttdeci">int64_t size_</div><div class="ttdef"><b>Definition:</b> memory.h:135</div></div>
+<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a38c69e817deb97bbaf521824f46e2961"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a38c69e817deb97bbaf521824f46e2961">arrow::io::BufferReader::position_</a></div><div class="ttdeci">int64_t position_</div><div class="ttdef"><b>Definition:</b> memory.h:134</div></div>
+<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a3f1655cf6afa7e0799f6c6914fe570e6"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a3f1655cf6afa7e0799f6c6914fe570e6">arrow::io::BufferReader::size_</a></div><div class="ttdeci">int64_t size_</div><div class="ttdef"><b>Definition:</b> memory.h:133</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/c77df435/docs/cpp/iterators_8h.html
----------------------------------------------------------------------
diff --git a/docs/cpp/iterators_8h.html b/docs/cpp/iterators_8h.html
new file mode 100644
index 0000000..121e1d1
--- /dev/null
+++ b/docs/cpp/iterators_8h.html
@@ -0,0 +1,97 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.14"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/iterators.h File Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">Apache Arrow (C++)
+ </div>
+ <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.14 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div id="nav-path" class="navpath">
+ <ul>
+<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4f683177589ce7b8fe2ef6d807198da3.html">arrow</a></li><li class="navelem"><a class="el" href="dir_fe25ba37dfe21fed8dcc297696dcf71e.html">python</a></li> </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+ <div class="summary">
+<a href="#namespaces">Namespaces</a> </div>
+ <div class="headertitle">
+<div class="title">iterators.h File Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include <utility></code><br />
+<code>#include "<a class="el" href="arrow_2python_2common_8h_source.html">arrow/python/common.h</a>"</code><br />
+<code>#include "<a class="el" href="numpy-internal_8h_source.html">arrow/python/numpy-internal.h</a>"</code><br />
+</div>
+<p><a href="iterators_8h_source.html">Go to the source code of this file.</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
+Namespaces</h2></td></tr>
+<tr class="memitem:namespacearrow"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html">arrow</a></td></tr>
+<tr class="memdesc:namespacearrow"><td class="mdescLeft"> </td><td class="mdescRight">Top-level namespace for Apache Arrow C++ API. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:namespacearrow_1_1py"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html">arrow::py</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by  <a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.14
+</small></address>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/c77df435/docs/cpp/iterators_8h_source.html
----------------------------------------------------------------------
diff --git a/docs/cpp/iterators_8h_source.html b/docs/cpp/iterators_8h_source.html
new file mode 100644
index 0000000..3c3686b
--- /dev/null
+++ b/docs/cpp/iterators_8h_source.html
@@ -0,0 +1,89 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.14"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/iterators.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">Apache Arrow (C++)
+ </div>
+ <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.14 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div id="nav-path" class="navpath">
+ <ul>
+<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4f683177589ce7b8fe2ef6d807198da3.html">arrow</a></li><li class="navelem"><a class="el" href="dir_fe25ba37dfe21fed8dcc297696dcf71e.html">python</a></li> </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+ <div class="headertitle">
+<div class="title">iterators.h</div> </div>
+</div><!--header-->
+<div class="contents">
+<a href="iterators_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 cla
ss="lineno"> 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="preprocessor">#ifndef ARROW_PYTHON_ITERATORS_H</span></div><div class="line"><a name="l00019"></a><span class="l
ineno"> 19</span> <span class="preprocessor">#define ARROW_PYTHON_ITERATORS_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <utility></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="arrow_2python_2common_8h.html">arrow/python/common.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="numpy-internal_8h.html">arrow/python/numpy-internal.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span
> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span>py {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>internal {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// Visit the Python sequence, calling the given callable on each element.</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// If the callable returns a non-OK status, iteration stops and the status is returned.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">template</span> <<span class="keyword">class</span> UnaryF
unction></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">inline</span> Status VisitSequence(PyObject* obj, UnaryFunction&& func) {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">if</span> (PyArray_Check(obj)) {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  PyArrayObject* arr_obj = <span class="keyword">reinterpret_cast<</span>PyArrayObject*<span class="keyword">></span>(obj);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">if</span> (PyArray_NDIM(arr_obj) != 1) {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#aaaa6c0ddc3021415c238ab07353f3195">Status::Invalid</a>(<span class="stringliteral">"Only 1D arrays acc
epted"</span>);</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> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">if</span> (PyArray_DESCR(arr_obj)->type_num == NPY_OBJECT) {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// It's an array object, we can fetch object pointers directly</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">const</span> Ndarray1DIndexer<PyObject*> objects(arr_obj);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">for</span> (int64_t i = 0; i < objects.size(); ++i) {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a
class="code" href="status_8h.html#a0a03bcf7fdbd9a96c67afa05fc0a545d">RETURN_NOT_OK</a>(func(objects[i]));</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// It's a non-object array, fall back on regular sequence access.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// (note PyArray_GETITEM() is slightly different: it returns standard</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment
">// Python types, not Numpy scalar types)</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// This code path is inefficient: callers should implement dedicated</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// logic for non-object arrays.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">if</span> (PySequence_Check(obj)) {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">if</span> (PyList_Check(obj) || PyTuple_Check(obj)) {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// Use fast item access</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57
</span>  <span class="keyword">const</span> Py_ssize_t size = PySequence_Fast_GET_SIZE(obj);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">for</span> (Py_ssize_t i = 0; i < size; ++i) {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  PyObject* value = PySequence_Fast_GET_ITEM(obj, i);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="status_8h.html#a0a03bcf7fdbd9a96c67afa05fc0a545d">RETURN_NOT_OK</a>(func(value));</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// Regular sequence: avoid making a potentially large copy</
span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> Py_ssize_t size = PySequence_Size(obj);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>();</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">for</span> (Py_ssize_t i = 0; i < size; ++i) {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  OwnedRef value_ref(PySequence_ITEM(obj, i));</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>();</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="status_8h
.html#a0a03bcf7fdbd9a96c67afa05fc0a545d">RETURN_NOT_OK</a>(func(value_ref.obj()));</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#ac618ef5553ac7bd7243461fe3418ce8a">Status::TypeError</a>(<span class="stringliteral">"Object is not a sequence"</span>);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Stat
us::OK</a>();</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// Like IterateSequence, but accepts any generic iterable (including</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">// non-restartable iterators, e.g. generators).</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">template</span> <<span class="keyword">class</span> UnaryFunction></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">inline</span> Status VisitIterable(PyObject* obj, UnaryFunction&& func) {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflo
w">if</span> (PySequence_Check(obj)) {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// Numpy arrays fall here as well</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> VisitSequence(obj, std::forward<UnaryFunction>(func));</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">// Fall back on the iterator protocol</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  OwnedRef iter_ref(PyObject_GetIter(obj));</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  PyObject* iter = iter_ref.obj();</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <a class="code" href="arrow_2python_2common_8h.html
#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>();</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  PyObject* value;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">while</span> ((value = PyIter_Next(iter))) {</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  OwnedRef value_ref(value);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="status_8h.html#a0a03bcf7fdbd9a96c67afa05fc0a545d">RETURN_NOT_OK</a>(func(value_ref.obj()));</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>(); <span class="comment">// __next__() might have raised</span></div><div class="
line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> } <span class="comment">// namespace internal</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#endif // ARROW_PYTHO
N_ITERATORS_H</span></div><div class="ttc" id="arrow_2python_2common_8h_html"><div class="ttname"><a href="arrow_2python_2common_8h.html">common.h</a></div></div>
+<div class="ttc" id="arrow_2python_2common_8h_html_ad99052ac0ced9d8a858bd49d5bfd2ebd"><div class="ttname"><a href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a></div><div class="ttdeci">#define RETURN_IF_PYERROR()</div><div class="ttdef"><b>Definition:</b> common.h:53</div></div>
+<div class="ttc" id="status_8h_html_a0a03bcf7fdbd9a96c67afa05fc0a545d"><div class="ttname"><a href="status_8h.html#a0a03bcf7fdbd9a96c67afa05fc0a545d">RETURN_NOT_OK</a></div><div class="ttdeci">#define RETURN_NOT_OK(s)</div><div class="ttdef"><b>Definition:</b> status.h:43</div></div>
+<div class="ttc" id="classarrow_1_1_status_html_a5c0b0031db6eeec3dcc70485d24cfe03"><div class="ttname"><a href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">arrow::Status::OK</a></div><div class="ttdeci">static Status OK()</div><div class="ttdef"><b>Definition:</b> status.h:106</div></div>
+<div class="ttc" id="numpy-internal_8h_html"><div class="ttname"><a href="numpy-internal_8h.html">numpy-internal.h</a></div></div>
+<div class="ttc" id="classarrow_1_1_status_html_aaaa6c0ddc3021415c238ab07353f3195"><div class="ttname"><a href="classarrow_1_1_status.html#aaaa6c0ddc3021415c238ab07353f3195">arrow::Status::Invalid</a></div><div class="ttdeci">static Status Invalid(const std::string &msg)</div><div class="ttdef"><b>Definition:</b> status.h:129</div></div>
+<div class="ttc" id="classarrow_1_1_status_html_ac618ef5553ac7bd7243461fe3418ce8a"><div class="ttname"><a href="classarrow_1_1_status.html#ac618ef5553ac7bd7243461fe3418ce8a">arrow::Status::TypeError</a></div><div class="ttdeci">static Status TypeError(const std::string &msg)</div><div class="ttdef"><b>Definition:</b> status.h:117</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> adapter.h:32</div></div>
+</div><!-- fragment --></div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by  <a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.14
+</small></address>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/c77df435/docs/cpp/kernel_8h_source.html
----------------------------------------------------------------------
diff --git a/docs/cpp/kernel_8h_source.html b/docs/cpp/kernel_8h_source.html
index 5f52759..cd124ba 100644
--- a/docs/cpp/kernel_8h_source.html
+++ b/docs/cpp/kernel_8h_source.html
@@ -78,7 +78,7 @@ $(function() {
<div class="ttc" id="structarrow_1_1compute_1_1_datum_html_a3fce98fa0a734b9f40d050d15b58ba30"><div class="ttname"><a href="structarrow_1_1compute_1_1_datum.html#a3fce98fa0a734b9f40d050d15b58ba30">arrow::compute::Datum::Datum</a></div><div class="ttdeci">Datum(const Datum &other) noexcept</div><div class="ttdef"><b>Definition:</b> kernel.h:79</div></div>
<div class="ttc" id="structarrow_1_1compute_1_1_datum_html_aad87489fb4ef280f2c8d965bf856178d"><div class="ttname"><a href="structarrow_1_1compute_1_1_datum.html#aad87489fb4ef280f2c8d965bf856178d">arrow::compute::Datum::Datum</a></div><div class="ttdeci">Datum(const std::shared_ptr< Array > &value)</div><div class="ttdef"><b>Definition:</b> kernel.h:67</div></div>
<div class="ttc" id="structarrow_1_1compute_1_1_datum_html_aa7d5faca8e15b9b6227a21966b04ac08"><div class="ttname"><a href="structarrow_1_1compute_1_1_datum.html#aa7d5faca8e15b9b6227a21966b04ac08">arrow::compute::Datum::Datum</a></div><div class="ttdeci">Datum(const std::vector< Datum > &value)</div><div class="ttdef"><b>Definition:</b> kernel.h:75</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:106</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="structarrow_1_1compute_1_1_datum_html_a42149c2e161aead5ae7ba424d3bf67ad"><div class="ttname"><a href="structarrow_1_1compute_1_1_datum.html#a42149c2e161aead5ae7ba424d3bf67ad">arrow::compute::Datum::~Datum</a></div><div class="ttdeci">~Datum()</div><div class="ttdef"><b>Definition:</b> kernel.h:77</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="array_8h_html"><div class="ttname"><a href="array_8h.html">array.h</a></div></div>
@@ -99,7 +99,7 @@ $(function() {
<div class="ttc" id="structarrow_1_1compute_1_1_datum_html_ae1164fc67b6c27e5f39a7064fafd2ee6a93a8e6ae66bd39e6f66623732190c7ad"><div class="ttname"><a href="structarrow_1_1compute_1_1_datum.html#ae1164fc67b6c27e5f39a7064fafd2ee6a93a8e6ae66bd39e6f66623732190c7ad">arrow::compute::Datum::NONE</a></div><div class="ttdef"><b>Definition:</b> kernel.h:53</div></div>
<div class="ttc" id="structarrow_1_1compute_1_1_datum_html_a536b5c89243aeabb156881d3032ba8fc"><div class="ttname"><a href="structarrow_1_1compute_1_1_datum.html#a536b5c89243aeabb156881d3032ba8fc">arrow::compute::Datum::Datum</a></div><div class="ttdeci">Datum(const std::shared_ptr< RecordBatch > &value)</div><div class="ttdef"><b>Definition:</b> kernel.h:71</div></div>
<div class="ttc" id="structarrow_1_1compute_1_1_datum_html_ab9678f366e0ffc7416b5b8c6148913b5"><div class="ttname"><a href="structarrow_1_1compute_1_1_datum.html#ab9678f366e0ffc7416b5b8c6148913b5">arrow::compute::Datum::Datum</a></div><div class="ttdeci">Datum(const std::shared_ptr< Scalar > &value)</div><div class="ttdef"><b>Definition:</b> kernel.h:63</div></div>
-<div class="ttc" id="classarrow_1_1util_1_1variant_html"><div class="ttname"><a href="classarrow_1_1util_1_1variant.html">arrow::util::variant</a></div><div class="ttdef"><b>Definition:</b> variant.h:594</div></div>
+<div class="ttc" id="classarrow_1_1util_1_1variant_html"><div class="ttname"><a href="classarrow_1_1util_1_1variant.html">arrow::util::variant</a></div><div class="ttdef"><b>Definition:</b> variant.h:581</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="structarrow_1_1compute_1_1_datum_html_ae1164fc67b6c27e5f39a7064fafd2ee6afaf77078cf2a26f90d518f266c0ee02e"><div class="ttname"><a href="structarrow_1_1compute_1_1_datum.html#ae1164fc67b6c27e5f39a7064fafd2ee6afaf77078cf2a26f90d518f266c0ee02e">arrow::compute::Datum::CHUNKED_ARRAY</a></div><div class="ttdef"><b>Definition:</b> kernel.h:53</div></div>
<div class="ttc" id="structarrow_1_1compute_1_1_datum_html_adcb3aa98cf8a42819bb252d9e158e1dd"><div class="ttname"><a href="structarrow_1_1compute_1_1_datum.html#adcb3aa98cf8a42819bb252d9e158e1dd">arrow::compute::Datum::kind</a></div><div class="ttdeci">Datum::type kind() const</div><div class="ttdef"><b>Definition:</b> kernel.h:81</div></div>