http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/arrow_2python_2io_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2python_2io_8h_source.html b/docs/cpp/arrow_2python_2io_8h_source.html index 0af39fe..b9eea40 100644 --- a/docs/cpp/arrow_2python_2io_8h_source.html +++ b/docs/cpp/arrow_2python_2io_8h_source.html @@ -70,20 +70,21 @@ $(function() { <div class="title">io.h</div> </div> </div><!--header--> <div class="contents"> -<a href="arrow_2python_2io_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a>< span class="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 dis tributed 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 PYARROW_IO_H</span></div><div class="line"><a name="l00019"></a><span class="linen o"> 19</span> <span class="preprocessor">#define PYARROW_IO_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 "<a class="code" href="interfaces_8h.html">arrow/io/interfaces.h</a>"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="io_2memory_8h.html">arrow/io/memory.h</a>"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="co de" href="arrow_2python_2config_8h.html">arrow/python/config.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</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="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>MemoryPool;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class=" lineno"> 33</span> <span class="keyword">namespace </span>py {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="namespacearrow_1_1py.html#ae397fd327253f5ed91ba845863abb948"> 35</a></span> <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> <a class="code" href="namespacearrow_1_1py.html#ae397fd327253f5ed91ba845863abb948">PythonFile</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_readable_file.html"> 37</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_py_readable_file.html">PyReadableFile</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_ 1io_1_1_random_access_file.html">io::RandomAccessFile</a> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1py_1_1_py_readable_file.html">PyReadableFile</a>(PyObject* file);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1py_1_1_py_readable_file.html">PyReadableFile</a>();</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="li ne"><a name="l00044"></a><span class="lineno"> 44</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>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</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="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// Thread-safe version</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</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="l00049"></a><span class="lineno"> 49</sp an>  <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// Thread-safe version</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</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="l00053"></a><span class="lineno"> 53</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> GetSize(int64_t* size) <span class="keyword">override</span>;</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>  <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="l00057"></a><span class="lineno"> 57</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> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</span>;</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="keyword">private</span>:</div><div class="line"><a name="l00063">< /a><span class="lineno"> 63</span>  std::unique_ptr<PythonFile> file_;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> };</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_output_stream.html"> 66</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_py_output_stream.html">PyOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1py_1_1_py_output_stream.html">PyOutputStream</a>(PyO bject* file);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1py_1_1_py_output_stream.html">PyOutputStream</a>();</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>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</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="l00073"></a><span class="lineno"> 73</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="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  std::unique_ptr<PythonFile> file_;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  int64_t position_;</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> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// A zero-copy reader backed by a PyBuffer object</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_bytes_reader.html"> 81</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href=" classarrow_1_1py_1_1_py_bytes_reader.html">PyBytesReader</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">io::BufferReader</a> {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1py_1_1_py_bytes_reader.html">PyBytesReader</a>(PyObject* obj);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1py_1_1_py_bytes_reader.html">PyBytesReader</a>();</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> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span c lass="comment">// TODO(wesm): seekable output files</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif // PYARROW_IO_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> +<a href="arrow_2python_2io_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a>< span class="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 dis tributed 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 PYARROW_IO_H</span></div><div class="line"><a name="l00019"></a><span class="linen o"> 19</span> <span class="preprocessor">#define PYARROW_IO_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 <memory></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="interfaces_8h.html">arrow/io/interfaces.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="io_2memory_8h.html">arrow/io/memory.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</sp an></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="arrow_2python_2config_8h.html">arrow/python/config.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="preprocessor">#include "<a class="code" href="arrow_2python_2common_8h.html">arrow/python/common.h</a>"</span></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">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><s pan class="lineno"> 33</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>py {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="namespacearrow_1_1py.html#ae397fd327253f5ed91ba845863abb948"> 37</a></span> <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> <a class="code" href="namespacearrow_1_1py.html#ae397fd327253f5ed91ba845863abb948">PythonFile</a>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_readable_file.html"> 39</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_py_readable_file.html">PyReadableFile</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</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_1py_1_1_py_readable_file.html">PyReadableFile</a>(PyObject* file);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  ~<a class="code" href="classarrow_1_1py_1_1_py_readable_file.html">PyReadableFile</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44 </span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</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_1_status.html">Status</a> Read(int64_t nbytes, int64_t* bytes_read, <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</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="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// Thread-safe version</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> ReadAt(int64_t position, int64_t nbytes, int64_t* bytes_read,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// Thread-safe version</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> ReadAt(int64_t position, int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</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>  <a class="c ode" href="classarrow_1_1_status.html">Status</a> GetSize(int64_t* size) <span class="keyword">override</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</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> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</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="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</span>;</div><div class="line "><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  std::unique_ptr<PythonFile> file_;</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> </div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_output_stream.html"> 68</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_py_output_stream.html">PyOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::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"> 70</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1py_1_1_py_output_stream.html">PyOutputStream</a>(PyObject* file);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  ~<a class="code" href="classarrow_1_1py_1_1_py_output_stream.html">PyOutputStream</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</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 cla ss="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"> 77</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  std::unique_ptr<PythonFile> file_;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  int64_t position_;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> };</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> <span class="comment">// TODO(wesm): seekable output files</span></div><di v class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// A Buffer subclass that keeps a PyObject reference throughout its</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// lifetime, such that the Python object is kept alive as long as the</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// C++ buffer is still needed.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// Keeping the reference in a Python wrapper would be incorrect as</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// the Python wrapper can get destroyed even though the wrapped C++</span></div><div class="line"><a name="l00089"></a><span class=" lineno"> 89</span> <span class="comment">// buffer is still alive (ARROW-2270).</span></div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_foreign_buffer.html"> 90</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_py_foreign_buffer.html">PyForeignBuffer</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a> {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Make(<span class="keyword">const</span> uint8_t* data, int64_t size, PyObject* base,</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  std::shared_ptr<Bu ffer>* out);</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>  <span class="keyword">private</span>:</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classarrow_1_1py_1_1_py_foreign_buffer.html">PyForeignBuffer</a>(<span class="keyword">const</span> uint8_t* data, int64_t size, PyObject* base)</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  : <a class="code" href="classarrow_1_1_buffer.html">Buffer</a>(data, size) {</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  Py_INCREF(base);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  base_.reset(base);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div><div class="line"><a name="l00101"></a><span class="lin eno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html">OwnedRefNoGIL</a> base_;</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="l00105"></a><span class="lineno"> 105</span> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#endif // PYARROW_IO_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="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="namespacearrow_1_1py_html_ae397fd327253f5ed91ba845863abb948"><div class="ttname"><a href="namespacearrow_1_1py.html#ae397fd327253f5ed91ba845863abb948">arrow::py::PythonFile</a></div><div class="ttdeci">class ARROW_NO_EXPORT PythonFile</div><div class="ttdef"><b>Definition:</b> io.h:35</div></div> +<div class="ttc" id="namespacearrow_1_1py_html_ae397fd327253f5ed91ba845863abb948"><div class="ttname"><a href="namespacearrow_1_1py.html#ae397fd327253f5ed91ba845863abb948">arrow::py::PythonFile</a></div><div class="ttdeci">class ARROW_NO_EXPORT PythonFile</div><div class="ttdef"><b>Definition:</b> io.h:37</div></div> <div class="ttc" id="visibility_8h_html_a843cb8dccea68a22a2b9995605cb5a74"><div class="ttname"><a href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a></div><div class="ttdeci">#define ARROW_NO_EXPORT</div><div class="ttdef"><b>Definition:</b> visibility.h:42</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_1py_1_1_py_readable_file_html"><div class="ttname"><a href="classarrow_1_1py_1_1_py_readable_file.html">arrow::py::PyReadableFile</a></div><div class="ttdef"><b>Definition:</b> io.h:37</div></div> +<div class="ttc" id="classarrow_1_1py_1_1_py_readable_file_html"><div class="ttname"><a href="classarrow_1_1py_1_1_py_readable_file.html">arrow::py::PyReadableFile</a></div><div class="ttdef"><b>Definition:</b> io.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:106</div></div> -<div class="ttc" id="classarrow_1_1py_1_1_py_bytes_reader_html"><div class="ttname"><a href="classarrow_1_1py_1_1_py_bytes_reader.html">arrow::py::PyBytesReader</a></div><div class="ttdef"><b>Definition:</b> io.h:81</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="io_2memory_8h_html"><div class="ttname"><a href="io_2memory_8h.html">memory.h</a></div></div> <div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div> -<div class="ttc" id="classarrow_1_1py_1_1_py_output_stream_html"><div class="ttname"><a href="classarrow_1_1py_1_1_py_output_stream.html">arrow::py::PyOutputStream</a></div><div class="ttdef"><b>Definition:</b> io.h:66</div></div> +<div class="ttc" id="classarrow_1_1py_1_1_owned_ref_no_g_i_l_html"><div class="ttname"><a href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html">arrow::py::OwnedRefNoGIL</a></div><div class="ttdef"><b>Definition:</b> common.h:101</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_1py_1_1_py_output_stream_html"><div class="ttname"><a href="classarrow_1_1py_1_1_py_output_stream.html">arrow::py::PyOutputStream</a></div><div class="ttdef"><b>Definition:</b> io.h:68</div></div> +<div class="ttc" id="classarrow_1_1py_1_1_py_foreign_buffer_html"><div class="ttname"><a href="classarrow_1_1py_1_1_py_foreign_buffer.html">arrow::py::PyForeignBuffer</a></div><div class="ttdef"><b>Definition:</b> io.h:90</div></div> <div class="ttc" id="arrow_2python_2config_8h_html"><div class="ttname"><a href="arrow_2python_2config_8h.html">config.h</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part -->
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/arrow__to__pandas_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow__to__pandas_8h.html b/docs/cpp/arrow__to__pandas_8h.html index 1c4edcc..a8dff89 100644 --- a/docs/cpp/arrow__to__pandas_8h.html +++ b/docs/cpp/arrow__to__pandas_8h.html @@ -77,6 +77,7 @@ $(function() { <div class="textblock"><code>#include "<a class="el" href="platform_8h_source.html">arrow/python/platform.h</a>"</code><br /> <code>#include <memory></code><br /> <code>#include <string></code><br /> +<code>#include <unordered_set></code><br /> <code>#include "<a class="el" href="visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br /> </div> <p><a href="arrow__to__pandas_8h_source.html">Go to the source code of this file.</a></p> @@ -102,6 +103,9 @@ Functions</h2></td></tr> <tr class="separator:a46c8b5a2dbbb6440e5b79ce0a3db999b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a19b4fb181177c22afb558f1711d3bd75"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a19b4fb181177c22afb558f1711d3bd75">arrow::py::ConvertTableToPandas</a> (PandasOptions options, const std::shared_ptr< Table > &table, int nthreads, MemoryPool *pool, PyObject **out)</td></tr> <tr class="separator:a19b4fb181177c22afb558f1711d3bd75"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad53b57d404b9851ae6be54bef37a9f8d"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#ad53b57d404b9851ae6be54bef37a9f8d">arrow::py::ConvertTableToPandas</a> (PandasOptions options, const std::unordered_set< std::string > &categorical_columns, const std::shared_ptr< Table > &table, int nthreads, MemoryPool *pool, PyObject **out)</td></tr> +<tr class="memdesc:ad53b57d404b9851ae6be54bef37a9f8d"><td class="mdescLeft"> </td><td class="mdescRight">Convert a whole table as efficiently as possible to a pandas.DataFrame. <a href="namespacearrow_1_1py.html#ad53b57d404b9851ae6be54bef37a9f8d">More...</a><br /></td></tr> +<tr class="separator:ad53b57d404b9851ae6be54bef37a9f8d"><td class="memSeparator" colspan="2"> </td></tr> </table> </div><!-- contents --> <!-- start footer part --> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/arrow__to__pandas_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow__to__pandas_8h_source.html b/docs/cpp/arrow__to__pandas_8h_source.html index 11588ba..aabb531 100644 --- a/docs/cpp/arrow__to__pandas_8h_source.html +++ b/docs/cpp/arrow__to__pandas_8h_source.html @@ -70,18 +70,19 @@ $(function() { <div class="title">arrow_to_pandas.h</div> </div> </div><!--header--> <div class="contents"> -<a href="arrow__to__pandas_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a>< span class="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 dis tributed 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">// Functions for converting between pandas's NumPy-based data representation</span></div><d iv class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// and Arrow data structures</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">#ifndef ARROW_PYTHON_ADAPTERS_PANDAS_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define ARROW_PYTHON_ADAPTERS_PANDAS_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="platform_8h.html">arrow/python/platform.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 clas s="preprocessor">#include <memory></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <string></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="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></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">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>Array;</div><div class="line"><a name="l00034"></a><s pan class="lineno"> 34</span> <span class="keyword">class </span>Column;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>DataType;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>Table;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="namespacearrow_1_1py.html"> 40</a></span> <span class="keyword">namespace </span>py {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lin eno"><a class="line" href="structarrow_1_1py_1_1_pandas_options.html"> 42</a></span> <span class="keyword">struct </span><a class="code" href="structarrow_1_1py_1_1_pandas_options.html">PandasOptions</a> {</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_pandas_options.html#aea24810361b67d93f00c68f41c5e7565"> 43</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#aea24810361b67d93f00c68f41c5e7565">strings_to_categorical</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_pandas_options.html#a5d742d6db2adb58422e64c314ff239a9"> 44</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#a5d742d6db2adb58422e64c314ff239a9">zero_copy_only</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </d iv><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_pandas_options.html#a7d138793326541a93ca485de042794d6"> 46</a></span>  <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#a7d138793326541a93ca485de042794d6">PandasOptions</a>() : <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#aea24810361b67d93f00c68f41c5e7565">strings_to_categorical</a>(false), <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#a5d742d6db2adb58422e64c314ff239a9">zero_copy_only</a>(false) {}</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> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> ARROW_EXPORT</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" hr ef="namespacearrow_1_1py.html#a50bc5feceac74c1959575d5680ba9f3b">ConvertArrayToPandas</a>(PandasOptions options, <span class="keyword">const</span> std::shared_ptr<Array>& arr,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  PyObject* py_ref, PyObject** out);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> ARROW_EXPORT</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a46c8b5a2dbbb6440e5b79ce0a3db999b">ConvertColumnToPandas</a>(PandasOptions options, <span class="keyword">const</span> std::shared_ptr<Column>& col,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  PyObject* py_ref, PyO bject** out);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// Convert a whole table as efficiently as possible to a pandas.DataFrame.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">//</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// The returned Python object is a list of tuples consisting of the exact 2D</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// BlockManager structure of the pandas.DataFrame used as of pandas 0.19.x.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">//</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> // tuple item: (indices: ndarray[int32], block: ndarray[TYPE, ndim=2])</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> ARROW_EXPORT</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a19b4fb181177c22afb558f1711d3bd75">ConvertTableToPandas</a>(PandasOptions options, <span class="keyword">const</span> std::shared_ptr<Table>& table,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">int</span> nthreads, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool, PyObject** out);</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">// namespace py</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#endif // ARROW_PYTHON_ADAPTERS_PANDAS_H</span></div><div class="ttc" id="platform_8h_html"><div class="ttname"><a href="platform_8h.html">platform.h</a></div></div> +<a href="arrow__to__pandas_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a>< span class="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 dis tributed 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">// Functions for converting between pandas's NumPy-based data representation</span></div><d iv class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// and Arrow data structures</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">#ifndef ARROW_PYTHON_ADAPTERS_PANDAS_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define ARROW_PYTHON_ADAPTERS_PANDAS_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="platform_8h.html">arrow/python/platform.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 clas s="preprocessor">#include <memory></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <unordered_set></span></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="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <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> </div><div class="line"> <a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Array;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>Column;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>DataType;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>Table;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespacearrow_1_1py.html"> 41</a></span> <span class="keyword">namespace </span>p y {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_pandas_options.html"> 43</a></span> <span class="keyword">struct </span><a class="code" href="structarrow_1_1py_1_1_pandas_options.html">PandasOptions</a> {</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_pandas_options.html#aea24810361b67d93f00c68f41c5e7565"> 45</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#aea24810361b67d93f00c68f41c5e7565">strings_to_categorical</a>;</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_pandas_options.html#a5d742d6db2adb58422e64c314ff239a9"> 46</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structarrow_1_1py_1_1_pandas_option s.html#a5d742d6db2adb58422e64c314ff239a9">zero_copy_only</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_pandas_options.html#aa0dfbe446eedc3bde8775491da3ff2d3"> 47</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#aa0dfbe446eedc3bde8775491da3ff2d3">integer_object_nulls</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_pandas_options.html#a7d138793326541a93ca485de042794d6"> 49</a></span>  <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#a7d138793326541a93ca485de042794d6">PandasOptions</a>()</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  : <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#aea24810361b67d93f00c68f41c5e7565">str ings_to_categorical</a>(false),</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#a5d742d6db2adb58422e64c314ff239a9">zero_copy_only</a>(false),</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="structarrow_1_1py_1_1_pandas_options.html#aa0dfbe446eedc3bde8775491da3ff2d3">integer_object_nulls</a>(false) {}</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> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> ARROW_EXPORT</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a50bc5feceac74c1959575d5680ba9f3b">ConvertArrayToPandas</a>(Panda sOptions options, <span class="keyword">const</span> std::shared_ptr<Array>& arr,</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  PyObject* py_ref, PyObject** out);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> ARROW_EXPORT</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a46c8b5a2dbbb6440e5b79ce0a3db999b">ConvertColumnToPandas</a>(PandasOptions options, <span class="keyword">const</span> std::shared_ptr<Column>& col,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  PyObject* py_ref, PyObject** out);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> 0;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// Convert a whole table as efficiently as possible to a pandas.DataFrame.</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">//</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// The returned Python object is a list of tuples consisting of the exact 2D</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">// BlockManager structure of the pandas.DataFrame used as of pandas 0.19.x.</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">//</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// tuple item: (indices: ndarray[int32], block: ndarray[TYPE, ndim=2])</span></div><div class=" line"><a name="l00069"></a><span class="lineno"> 69</span> ARROW_EXPORT</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a19b4fb181177c22afb558f1711d3bd75">ConvertTableToPandas</a>(PandasOptions options, <span class="keyword">const</span> std::shared_ptr<Table>& table,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">int</span> nthreads, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool, PyObject** out);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> ARROW_EXPORT</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <a class="code" href="classarrow_1_1_status.html">St atus</a> <a class="code" href="namespacearrow_1_1py.html#a19b4fb181177c22afb558f1711d3bd75">ConvertTableToPandas</a>(PandasOptions options,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">const</span> std::unordered_set<std::string>& categorical_columns,</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">const</span> std::shared_ptr<Table>& table, <span class="keywordtype">int</span> nthreads,</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool, PyObject** out);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> } <span class="comment">// namespace py< /span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> } <span class="comment">// namespace arrow</span></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="preprocessor">#endif // ARROW_PYTHON_ADAPTERS_PANDAS_H</span></div><div class="ttc" id="platform_8h_html"><div class="ttname"><a href="platform_8h.html">platform.h</a></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="structarrow_1_1py_1_1_pandas_options_html_a5d742d6db2adb58422e64c314ff239a9"><div class="ttname"><a href="structarrow_1_1py_1_1_pandas_options.html#a5d742d6db2adb58422e64c314ff239a9">arrow::py::PandasOptions::zero_copy_only</a></div><div class="ttdeci">bool zero_copy_only</div><div class="ttdef"><b>Definition:</b> arrow_to_pandas.h:44</div></div> -<div class="ttc" id="structarrow_1_1py_1_1_pandas_options_html"><div class="ttname"><a href="structarrow_1_1py_1_1_pandas_options.html">arrow::py::PandasOptions</a></div><div class="ttdef"><b>Definition:</b> arrow_to_pandas.h:42</div></div> +<div class="ttc" id="structarrow_1_1py_1_1_pandas_options_html_a5d742d6db2adb58422e64c314ff239a9"><div class="ttname"><a href="structarrow_1_1py_1_1_pandas_options.html#a5d742d6db2adb58422e64c314ff239a9">arrow::py::PandasOptions::zero_copy_only</a></div><div class="ttdeci">bool zero_copy_only</div><div class="ttdef"><b>Definition:</b> arrow_to_pandas.h:46</div></div> +<div class="ttc" id="structarrow_1_1py_1_1_pandas_options_html"><div class="ttname"><a href="structarrow_1_1py_1_1_pandas_options.html">arrow::py::PandasOptions</a></div><div class="ttdef"><b>Definition:</b> arrow_to_pandas.h:43</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="structarrow_1_1py_1_1_pandas_options_html_a7d138793326541a93ca485de042794d6"><div class="ttname"><a href="structarrow_1_1py_1_1_pandas_options.html#a7d138793326541a93ca485de042794d6">arrow::py::PandasOptions::PandasOptions</a></div><div class="ttdeci">PandasOptions()</div><div class="ttdef"><b>Definition:</b> arrow_to_pandas.h:46</div></div> +<div class="ttc" id="structarrow_1_1py_1_1_pandas_options_html_a7d138793326541a93ca485de042794d6"><div class="ttname"><a href="structarrow_1_1py_1_1_pandas_options.html#a7d138793326541a93ca485de042794d6">arrow::py::PandasOptions::PandasOptions</a></div><div class="ttdeci">PandasOptions()</div><div class="ttdef"><b>Definition:</b> arrow_to_pandas.h:49</div></div> <div class="ttc" id="namespacearrow_1_1py_html_a46c8b5a2dbbb6440e5b79ce0a3db999b"><div class="ttname"><a href="namespacearrow_1_1py.html#a46c8b5a2dbbb6440e5b79ce0a3db999b">arrow::py::ConvertColumnToPandas</a></div><div class="ttdeci">Status ConvertColumnToPandas(PandasOptions options, const std::shared_ptr< Column > &col, PyObject *py_ref, PyObject **out)</div></div> -<div class="ttc" id="structarrow_1_1py_1_1_pandas_options_html_aea24810361b67d93f00c68f41c5e7565"><div class="ttname"><a href="structarrow_1_1py_1_1_pandas_options.html#aea24810361b67d93f00c68f41c5e7565">arrow::py::PandasOptions::strings_to_categorical</a></div><div class="ttdeci">bool strings_to_categorical</div><div class="ttdef"><b>Definition:</b> arrow_to_pandas.h:43</div></div> +<div class="ttc" id="structarrow_1_1py_1_1_pandas_options_html_aea24810361b67d93f00c68f41c5e7565"><div class="ttname"><a href="structarrow_1_1py_1_1_pandas_options.html#aea24810361b67d93f00c68f41c5e7565">arrow::py::PandasOptions::strings_to_categorical</a></div><div class="ttdeci">bool strings_to_categorical</div><div class="ttdoc">If true, we will convert all string columns to categoricals. </div><div class="ttdef"><b>Definition:</b> arrow_to_pandas.h:45</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="namespacearrow_1_1py_html_a50bc5feceac74c1959575d5680ba9f3b"><div class="ttname"><a href="namespacearrow_1_1py.html#a50bc5feceac74c1959575d5680ba9f3b">arrow::py::ConvertArrayToPandas</a></div><div class="ttdeci">Status ConvertArrayToPandas(PandasOptions options, const std::shared_ptr< Array > &arr, PyObject *py_ref, PyObject **out)</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="namespacearrow_1_1py_html_a19b4fb181177c22afb558f1711d3bd75"><div class="ttname"><a href="namespacearrow_1_1py.html#a19b4fb181177c22afb558f1711d3bd75">arrow::py::ConvertTableToPandas</a></div><div class="ttdeci">Status ConvertTableToPandas(PandasOptions options, const std::shared_ptr< Table > &table, int nthreads, MemoryPool *pool, PyObject **out)</div></div> +<div class="ttc" id="structarrow_1_1py_1_1_pandas_options_html_aa0dfbe446eedc3bde8775491da3ff2d3"><div class="ttname"><a href="structarrow_1_1py_1_1_pandas_options.html#aa0dfbe446eedc3bde8775491da3ff2d3">arrow::py::PandasOptions::integer_object_nulls</a></div><div class="ttdeci">bool integer_object_nulls</div><div class="ttdef"><b>Definition:</b> arrow_to_pandas.h:47</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/4c7c2f1b/docs/cpp/bit-stream-utils_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/bit-stream-utils_8h_source.html b/docs/cpp/bit-stream-utils_8h_source.html index b5aba82..464e394 100644 --- a/docs/cpp/bit-stream-utils_8h_source.html +++ b/docs/cpp/bit-stream-utils_8h_source.html @@ -86,7 +86,7 @@ $(function() { <div class="ttc" id="classarrow_1_1_bit_writer_html_a2e764de1162c33a6aa41caad00322156"><div class="ttname"><a href="classarrow_1_1_bit_writer.html#a2e764de1162c33a6aa41caad00322156">arrow::BitWriter::PutZigZagVlqInt</a></div><div class="ttdeci">bool PutZigZagVlqInt(int32_t v)</div><div class="ttdef"><b>Definition:</b> bit-stream-utils.h:392</div></div> <div class="ttc" id="logging_8h_html"><div class="ttname"><a href="logging_8h.html">logging.h</a></div></div> <div class="ttc" id="macros_8h_html_a6f2ee7ad52872edb915cf48e163ac99c"><div class="ttname"><a href="macros_8h.html#a6f2ee7ad52872edb915cf48e163ac99c">ARROW_PREDICT_FALSE</a></div><div class="ttdeci">#define ARROW_PREDICT_FALSE(x)</div><div class="ttdef"><b>Definition:</b> macros.h:48</div></div> -<div class="ttc" id="logging_8h_html_ab62f5ed8f2d48e29802be0cbbcd1359a"><div class="ttname"><a href="logging_8h.html#ab62f5ed8f2d48e29802be0cbbcd1359a">DCHECK_LT</a></div><div class="ttdeci">#define DCHECK_LT(val1, val2)</div><div class="ttdef"><b>Definition:</b> logging.h:82</div></div> +<div class="ttc" id="logging_8h_html_ab62f5ed8f2d48e29802be0cbbcd1359a"><div class="ttname"><a href="logging_8h.html#ab62f5ed8f2d48e29802be0cbbcd1359a">DCHECK_LT</a></div><div class="ttdeci">#define DCHECK_LT(val1, val2)</div><div class="ttdef"><b>Definition:</b> logging.h:86</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_1_bit_writer_html_a5592cdd1db11520ea5ae0be95fb4732a"><div class="ttname"><a href="classarrow_1_1_bit_writer.html#a5592cdd1db11520ea5ae0be95fb4732a">arrow::BitWriter::buffer_len</a></div><div class="ttdeci">int buffer_len() const</div><div class="ttdef"><b>Definition:</b> bit-stream-utils.h:57</div></div> <div class="ttc" id="bpacking_8h_html"><div class="ttname"><a href="bpacking_8h.html">bpacking.h</a></div></div> @@ -96,11 +96,11 @@ $(function() { <div class="ttc" id="classarrow_1_1_bit_reader_html_a943f521c4855e418bc106e55fd2de8d3"><div class="ttname"><a href="classarrow_1_1_bit_reader.html#a943f521c4855e418bc106e55fd2de8d3">arrow::BitReader::bytes_left</a></div><div class="ttdeci">int bytes_left()</div><div class="ttdoc">Returns the number of bytes left in the stream, not including the current byte (i.e., there may be an additional fraction of a byte). </div><div class="ttdef"><b>Definition:</b> bit-stream-utils.h:150</div></div> <div class="ttc" id="classarrow_1_1_bit_writer_html_a2d5943b81c4340b54bfd019955a7d959"><div class="ttname"><a href="classarrow_1_1_bit_writer.html#a2d5943b81c4340b54bfd019955a7d959">arrow::BitWriter::GetNextBytePtr</a></div><div class="ttdeci">uint8_t * GetNextBytePtr(int num_bytes=1)</div><div class="ttdoc">Get a pointer to the next aligned byte and advance the underlying buffer by num_bytes. </div><div class="ttdef"><b>Definition:</b> bit-stream-utils.h:204</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="logging_8h_html_ae89df3243bbb8341130c7b3f44145ea0"><div class="ttname"><a href="logging_8h.html#ae89df3243bbb8341130c7b3f44145ea0">DCHECK_EQ</a></div><div class="ttdeci">#define DCHECK_EQ(val1, val2)</div><div class="ttdef"><b>Definition:</b> logging.h:79</div></div> +<div class="ttc" id="logging_8h_html_ae89df3243bbb8341130c7b3f44145ea0"><div class="ttname"><a href="logging_8h.html#ae89df3243bbb8341130c7b3f44145ea0">DCHECK_EQ</a></div><div class="ttdeci">#define DCHECK_EQ(val1, val2)</div><div class="ttdef"><b>Definition:</b> logging.h:83</div></div> <div class="ttc" id="classarrow_1_1_bit_writer_html_a028f9d7d77697df651ef82d2df52f53d"><div class="ttname"><a href="classarrow_1_1_bit_writer.html#a028f9d7d77697df651ef82d2df52f53d">arrow::BitWriter::PutVlqInt</a></div><div class="ttdeci">bool PutVlqInt(uint32_t v)</div><div class="ttdoc">Write a Vlq encoded int to the buffer. </div><div class="ttdef"><b>Definition:</b> bit-stream-utils.h:221</div></div> -<div class="ttc" id="logging_8h_html_ae17f8119c108cf3070bad3449c7e0006"><div class="ttname"><a href="logging_8h.html#ae17f8119c108cf3070bad3449c7e0006">DCHECK</a></div><div class="ttdeci">#define DCHECK(condition)</div><div class="ttdef"><b>Definition:</b> logging.h:78</div></div> +<div class="ttc" id="logging_8h_html_ae17f8119c108cf3070bad3449c7e0006"><div class="ttname"><a href="logging_8h.html#ae17f8119c108cf3070bad3449c7e0006">DCHECK</a></div><div class="ttdeci">#define DCHECK(condition)</div><div class="ttdef"><b>Definition:</b> logging.h:81</div></div> <div class="ttc" id="classarrow_1_1_bit_writer_html_a0462b6eb15d93162ee7d2c828309d612"><div class="ttname"><a href="classarrow_1_1_bit_writer.html#a0462b6eb15d93162ee7d2c828309d612">arrow::BitWriter::BitWriter</a></div><div class="ttdeci">BitWriter(uint8_t *buffer, int buffer_len)</div><div class="ttdoc">buffer: buffer to write bits to. </div><div class="ttdef"><b>Definition:</b> bit-stream-utils.h:41</div></div> -<div class="ttc" id="logging_8h_html_a4395e95bab44e222cb2e77251017a0e2"><div class="ttname"><a href="logging_8h.html#a4395e95bab44e222cb2e77251017a0e2">DCHECK_LE</a></div><div class="ttdeci">#define DCHECK_LE(val1, val2)</div><div class="ttdef"><b>Definition:</b> logging.h:81</div></div> +<div class="ttc" id="logging_8h_html_a4395e95bab44e222cb2e77251017a0e2"><div class="ttname"><a href="logging_8h.html#a4395e95bab44e222cb2e77251017a0e2">DCHECK_LE</a></div><div class="ttdeci">#define DCHECK_LE(val1, val2)</div><div class="ttdef"><b>Definition:</b> logging.h:85</div></div> <div class="ttc" id="classarrow_1_1_bit_reader_html_a714971e13b725100437484becf9b8ae4"><div class="ttname"><a href="classarrow_1_1_bit_reader.html#a714971e13b725100437484becf9b8ae4">arrow::BitReader::BitReader</a></div><div class="ttdeci">BitReader(const uint8_t *buffer, int buffer_len)</div><div class="ttdoc">&#39;buffer&#39; is the buffer to read from. The buffer&#39;s length is &#39;buffer_len&#39;. </div><div class="ttdef"><b>Definition:</b> bit-stream-utils.h:106</div></div> <div class="ttc" id="classarrow_1_1_bit_reader_html_ac6f91e5030fb8cc87d27baa58dce66d3"><div class="ttname"><a href="classarrow_1_1_bit_reader.html#ac6f91e5030fb8cc87d27baa58dce66d3">arrow::BitReader::GetZigZagVlqInt</a></div><div class="ttdeci">bool GetZigZagVlqInt(int32_t *v)</div><div class="ttdef"><b>Definition:</b> bit-stream-utils.h:397</div></div> <div class="ttc" id="classarrow_1_1_bit_reader_html_a93bcd15198d511bf77a3980e4a9d343d"><div class="ttname"><a href="classarrow_1_1_bit_reader.html#a93bcd15198d511bf77a3980e4a9d343d">arrow::BitReader::GetVlqInt</a></div><div class="ttdeci">bool GetVlqInt(int32_t *v)</div><div class="ttdoc">Reads a vlq encoded int from the stream. </div><div class="ttdef"><b>Definition:</b> bit-stream-utils.h:378</div></div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/bit-util_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/bit-util_8h.html b/docs/cpp/bit-util_8h.html index 49abc73..59ae73e 100644 --- a/docs/cpp/bit-util_8h.html +++ b/docs/cpp/bit-util_8h.html @@ -78,6 +78,7 @@ $(function() { <code>#include <cstdint></code><br /> <code>#include <limits></code><br /> <code>#include <memory></code><br /> +<code>#include <type_traits></code><br /> <code>#include <vector></code><br /> <code>#include "<a class="el" href="macros_8h_source.html">arrow/util/macros.h</a>"</code><br /> <code>#include "<a class="el" href="util_2type__traits_8h_source.html">arrow/util/type_traits.h</a>"</code><br />
