http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/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 7e2854c..0abcabd 100644 --- a/docs/cpp/arrow_2python_2io_8h_source.html +++ b/docs/cpp/arrow_2python_2io_8h_source.html @@ -67,12 +67,12 @@ $(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"> 35</span> <span class="comment">// A common interface to a Python file-like object. Must acquire GIL before</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// calling any methods</span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_python_file.html"> 37</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_python_file.html">PythonFile</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_python_file.html">PythonFile</a>(PyObject* file);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  ~<a class="code" href="classarrow_1_1py_1_1_python_file.html">PythonFile</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();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position, <span class="keywordtype">int</span> whence);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, PyObject** out);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" hr ef="classarrow_1_1_status.html">Status</a> Tell(int64_t* position);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> uint8_t* data, int64_t nbytes);</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="keyword">private</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  PyObject* file_;</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> </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_readable_file.html"> 52</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarro w_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="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</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="l00055"></a><span class="lineno"> 55</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="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="ke yword">override</span>;</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>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, int64_t* bytes_read, uint8_t* out) <span class="keyword">override</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> Read(int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">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>  <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="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name ="l00064"></a><span class="lineno"> 64</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="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">override</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"> 68</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</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="keyword">private</span>:</div><div class="line"><a name="l00071"></a><sp an class="lineno"> 71</span>  std::unique_ptr<PythonFile> file_;</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> </div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_output_stream.html"> 74</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="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</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="l00077"></a><span class="lineno"> 77</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="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">override</span>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> uint8_t* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00 082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  std::unique_ptr<PythonFile> file_;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  int64_t position_;</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> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// A zero-copy reader backed by a PyBuffer object</span></div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_bytes_reader.html"> 89</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="l00090"></a><span class="lineno"> >90</span>  <span class="keyword">public</span>:</div><div >class="line"><a name="l00091"></a><span class="lineno"> 91</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="l00092"></a><span class="lineno"> >92</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="l00093"></a><span class="lineno"> >93</span> };</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="comment">// TODO(wesm): seekable out put files</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> } <span class="comment">// namespace arrow</span></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="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="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="ttdef"><b>Definition:</b> memory.h:116</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 "<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"> 35</span> <span class="comment">// A common interface to a Python file-like object. Must acquire GIL before</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// calling any methods</span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_python_file.html"> 37</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_python_file.html">PythonFile</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_python_file.html">PythonFile</a>(PyObject* file);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  ~<a class="code" href="classarrow_1_1py_1_1_python_file.html">PythonFile</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();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position, <span class="keywordtype">int</span> whence);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, PyObject** out);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" hr ef="classarrow_1_1_status.html">Status</a> Tell(int64_t* position);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> uint8_t* data, int64_t nbytes);</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="keyword">private</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  PyObject* file_;</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> </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_readable_file.html"> 52</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarro w_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="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</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="l00055"></a><span class="lineno"> 55</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="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="ke yword">override</span>;</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>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, int64_t* bytes_read, uint8_t* out) <span class="keyword">override</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> Read(int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">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>  <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="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name ="l00064"></a><span class="lineno"> 64</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="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</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="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</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="keyword">private</span>:</div><div class="line"><a name="l00071">< /a><span class="lineno"> 71</span>  std::unique_ptr<PythonFile> file_;</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> </div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_output_stream.html"> 74</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="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</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="l00077"></a><span class="lineno"> 77</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="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</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="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> uint8_t* data, int64_t nbytes) <span class="keyword">override</span>;</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="keyword">private</span>:</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  std::unique_ptr<PythonFile> file_;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  int64_t position_;</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> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// A zero-copy reader backed by a PyBuffer object</span></div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_bytes_reader.html"> 89</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="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</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="l00092"></a><span class="lineno"> 92</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="l00093"></a><span class="lineno"> 93</span> };</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="comment">// TODO(wesm): seekable output files</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> } <span class="comment">// namespace arrow</span></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="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:110</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:120</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:115</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:52</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:84</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:89</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>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/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 dccf78a..e1b8e70 100644 --- a/docs/cpp/arrow__to__pandas_8h_source.html +++ b/docs/cpp/arrow__to__pandas_8h_source.html @@ -68,7 +68,7 @@ $(function() { </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"> 44</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> ARROW_EXPORT</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href= "namespacearrow_1_1py.html#a50bc5feceac74c1959575d5680ba9f3b">ConvertArrayToPandas</a>(<a class="code" href="structarrow_1_1py_1_1_pandas_options.html">PandasOptions</a> options, <span class="keyword">const</span> std::shared_ptr<Array>& arr,</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  PyObject* py_ref, PyObject** out);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> ARROW_EXPORT</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a46c8b5a2dbbb6440e5b79ce0a3db999b">ConvertColumnToPandas</a>(<a class="code" href="structarrow_1_1py_1_1_pandas_options.html">PandasOptions</a> options, <span class="keyword">const</span> std::shared_ptr<Column>& col ,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  PyObject* py_ref, PyObject** out);</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="comment">// Convert a whole table as efficiently as possible to a pandas.DataFrame.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">//</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</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="l00057"></a><span class="lineno"> 57</span> <span class="comment">// BlockManager structure of the pandas.DataFrame used as of pandas 0.19.x.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <s pan class="comment">//</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// tuple item: (indices: ndarray[int32], block: ndarray[TYPE, ndim=2])</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> ARROW_EXPORT</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a19b4fb181177c22afb558f1711d3bd75">ConvertTableToPandas</a>(<a class="code" href="structarrow_1_1py_1_1_pandas_options.html">PandasOptions</a> options, <span class="keyword">const</span> std::shared_ptr<Table>& table,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</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="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> } <span class="comment">// namespace arrow</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="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:84</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"><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="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/arrow__to__python_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow__to__python_8h.html b/docs/cpp/arrow__to__python_8h.html new file mode 100644 index 0000000..813671c --- /dev/null +++ b/docs/cpp/arrow__to__python_8h.html @@ -0,0 +1,110 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/arrow/python/arrow_to_python.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.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</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> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">arrow_to_python.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include "<a class="el" href="platform_8h_source.html">arrow/python/platform.h</a>"</code><br /> +<code>#include <cstdint></code><br /> +<code>#include <memory></code><br /> +<code>#include <vector></code><br /> +<code>#include "<a class="el" href="python__to__arrow_8h_source.html">arrow/python/python_to_arrow.h</a>"</code><br /> +<code>#include "<a class="el" href="status_8h_source.html">arrow/status.h</a>"</code><br /> +<code>#include "<a class="el" href="visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br /> +</div> +<p><a href="arrow__to__python_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_1io"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1io.html">arrow::io</a></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><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a825cf78161c4a5a166aaa5345a2e869c"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a825cf78161c4a5a166aaa5345a2e869c">arrow::py::ReadSerializedObject</a> (io::RandomAccessFile *src, SerializedPyObject *out)</td></tr> +<tr class="memdesc:a825cf78161c4a5a166aaa5345a2e869c"><td class="mdescLeft"> </td><td class="mdescRight">Read serialized Python sequence from file interface using Arrow IPC. <a href="namespacearrow_1_1py.html#a825cf78161c4a5a166aaa5345a2e869c">More...</a><br /></td></tr> +<tr class="separator:a825cf78161c4a5a166aaa5345a2e869c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9ba31943394b96b470e7ae0536fa50d1"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a9ba31943394b96b470e7ae0536fa50d1">arrow::py::DeserializeObject</a> (PyObject *context, const SerializedPyObject &object, PyObject *base, PyObject **out)</td></tr> +<tr class="memdesc:a9ba31943394b96b470e7ae0536fa50d1"><td class="mdescLeft"> </td><td class="mdescRight">Reconstruct Python object from Arrow-serialized representation. <a href="namespacearrow_1_1py.html#a9ba31943394b96b470e7ae0536fa50d1">More...</a><br /></td></tr> +<tr class="separator:a9ba31943394b96b470e7ae0536fa50d1"><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.13 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/arrow__to__python_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow__to__python_8h_source.html b/docs/cpp/arrow__to__python_8h_source.html new file mode 100644 index 0000000..23c1d68 --- /dev/null +++ b/docs/cpp/arrow__to__python_8h_source.html @@ -0,0 +1,85 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/arrow/python/arrow_to_python.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.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</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">arrow_to_python.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="arrow__to__python_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 ARROW_PYTHON_ARROW_TO_PYTHON_H</span></div><div class="line"><a name="l00019"></a> <span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_PYTHON_ARROW_TO_PYTHON_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="platform_8h.html">arrow/python/platform.h</a>"</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> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </di v><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="python__to__arrow_8h.html">arrow/python/python_to_arrow.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</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>RecordBatch;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Tensor;</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="keyword">class </span>RandomAccessFile;</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="comment">// namespace io</span></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> <span class="keyword">namespace </span>py {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> ARROW_EXPORT</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> Status <a class="code" href="namespacearrow_1_1py.html#a825cf78161c4a5a166aaa5345a2e869c">ReadSerializedObject</a>(io::RandomAccessFile* src, SerializedPyObject* out);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</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> Status <a class="code" href="namespacearrow_1_1py.html#a9ba31943394b96b470e7ae0536fa50d1">DeserializeObject</a>(PyObject* context, <span class="keyword">const</span> SerializedPyObject& <span class="keywordtype"> object</span>,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  PyObject* base, 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_ARROW_TO_PYTHON_H</span></div><div class="ttc" id="namespacearrow_1_1py_html_a825cf78161c4a5a166aaa5345a2e869c"><div class="ttname"><a href="namespacearrow_1_1py.html#a825cf78161c4a5a166aaa5345a2e869c">arrow::py::ReadSerializedObject</a></div><div class="ttdeci">Status Read SerializedObject(io::RandomAccessFile *src, SerializedPyObject *out)</div><div class="ttdoc">Read serialized Python sequence from file interface using Arrow IPC. </div></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="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div> +<div class="ttc" id="python__to__arrow_8h_html"><div class="ttname"><a href="python__to__arrow_8h.html">python_to_arrow.h</a></div></div> +<div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> allocator.h:28</div></div> +<div class="ttc" id="status_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div> +<div class="ttc" id="namespacearrow_1_1py_html_a9ba31943394b96b470e7ae0536fa50d1"><div class="ttname"><a href="namespacearrow_1_1py.html#a9ba31943394b96b470e7ae0536fa50d1">arrow::py::DeserializeObject</a></div><div class="ttdeci">Status DeserializeObject(PyObject *context, const SerializedPyObject &object, PyObject *base, PyObject **out)</div><div class="ttdoc">Reconstruct Python object from Arrow-serialized representation. </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.13 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/bit-stream-utils_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/bit-stream-utils_8h.html b/docs/cpp/bit-stream-utils_8h.html index 361197a..9ba91ad 100644 --- a/docs/cpp/bit-stream-utils_8h.html +++ b/docs/cpp/bit-stream-utils_8h.html @@ -75,8 +75,8 @@ $(function() { <code>#include <cstdint></code><br /> <code>#include "<a class="el" href="bit-util_8h_source.html">arrow/util/bit-util.h</a>"</code><br /> <code>#include "<a class="el" href="bpacking_8h_source.html">arrow/util/bpacking.h</a>"</code><br /> -<code>#include "<a class="el" href="compiler-util_8h_source.html">arrow/util/compiler-util.h</a>"</code><br /> <code>#include "<a class="el" href="logging_8h_source.html">arrow/util/logging.h</a>"</code><br /> +<code>#include "<a class="el" href="macros_8h_source.html">arrow/util/macros.h</a>"</code><br /> </div> <p><a href="bit-stream-utils_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls">
