http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/metadata-internal_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/metadata-internal_8h_source.html b/docs/cpp/metadata-internal_8h_source.html index b7db14f..972f7a3 100644 --- a/docs/cpp/metadata-internal_8h_source.html +++ b/docs/cpp/metadata-internal_8h_source.html @@ -5,7 +5,7 @@ <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/ipc/metadata-internal.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/ipc/metadata-internal.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> @@ -68,7 +68,7 @@ $(function() { </div><!--header--> <div class="contents"> <a href="metadata-internal_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">// Internal metadata serialization matters</span></div><div class="line"><a name="l00019"></a>< span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_IPC_METADATA_INTERNAL_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IPC_METADATA_INTERNAL_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <vector></span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "arrow/ipc/Schema_generated.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="dictionary_8h.html">arrow/ipc/dictionary.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>Buffer;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>DataType;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>Schema;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>Tensor;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">namespace </span>flatbuf = org::apache::arrow::flatbuf;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="l ine"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">class </span>OutputStream;</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> } <span class="comment">// namespace io</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="keyword">namespace </span>ipc {</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="keyword">static</span> constexpr <a class="code" href="namespacearrow_1_1ipc.html#aa5d7ec68a8c707271bab98af9bc0ac77">flatbuf::MetadataVersion</a> kCurrentMetadataVersion =</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  flatbuf::Metadata Version_V3;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">static</span> constexpr <a class="code" href="namespacearrow_1_1ipc.html#aa5d7ec68a8c707271bab98af9bc0ac77">flatbuf::MetadataVersion</a> kMinMetadataVersion =</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  flatbuf::MetadataVersion_V3;</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> <span class="keyword">static</span> constexpr <span class="keyword">const</span> <span class="keywordtype">char</span>* kArrowMagicBytes = <span class="stringliteral">"ARROW1"</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="l ine" href="structarrow_1_1ipc_1_1_field_metadata.html"> 57</a></span> <span class="keyword">struct </span><a class="code" href="structarrow_1_1ipc_1_1_field_metadata.html">FieldMetadata</a> {</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structarrow_1_1ipc_1_1_field_metadata.html#a63ff616ae287c542ef0c3dfda6531b1b"> 58</a></span>  int64_t <a class="code" href="structarrow_1_1ipc_1_1_field_metadata.html#a63ff616ae287c542ef0c3dfda6531b1b">length</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structarrow_1_1ipc_1_1_field_metadata.html#abca970e08aa9f90451139d52a49ffb86"> 59</a></span>  int64_t <a class="code" href="structarrow_1_1ipc_1_1_field_metadata.html#abca970e08aa9f90451139d52a49ffb86">null_count</a>;</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structarrow_1_1ipc_1_1_field_metadata.html#ade643a1c4628139bb9feea157d897a97"> 60</a></ span>  int64_t <a class="code" href="structarrow_1_1ipc_1_1_field_metadata.html#ade643a1c4628139bb9feea157d897a97">offset</a>;</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> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structarrow_1_1ipc_1_1_buffer_metadata.html"> 63</a></span> <span class="keyword">struct </span><a class="code" href="structarrow_1_1ipc_1_1_buffer_metadata.html">BufferMetadata</a> {</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structarrow_1_1ipc_1_1_buffer_metadata.html#a5aaece22f9f14aeb1d98daf6c55adb11"> 65</a></span>  int32_t <a class="code" href="structarrow_1_1ipc_1_1_buffer_metadata.html#a5aaece22f9f14aeb1d98daf6c55adb11">page</a>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"> <a name="l00068"></a><span class="lineno"><a class="line" href="structarrow_1_1ipc_1_1_buffer_metadata.html#ad0ab2e3116ce6619de55507504fb1858"> 68</a></span>  int64_t <a class="code" href="structarrow_1_1ipc_1_1_buffer_metadata.html#ad0ab2e3116ce6619de55507504fb1858">offset</a>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structarrow_1_1ipc_1_1_buffer_metadata.html#a12d9e328f3ac8fbf4e26029ad33d0350"> 71</a></span>  int64_t <a class="code" href="structarrow_1_1ipc_1_1_buffer_metadata.html#a12d9e328f3ac8fbf4e26029ad33d0350">length</a>;</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="structarrow_1_1ipc_1_1_file_block.html"> 74</a></span>& #160;<span class="keyword">struct </span><a class="code" href="structarrow_1_1ipc_1_1_file_block.html">FileBlock</a> {</div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="structarrow_1_1ipc_1_1_file_block.html#aa8b2d60c43fc6c6afa22dcf5c2830f99"> 75</a></span>  int64_t <a class="code" href="structarrow_1_1ipc_1_1_file_block.html#aa8b2d60c43fc6c6afa22dcf5c2830f99">offset</a>;</div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="structarrow_1_1ipc_1_1_file_block.html#a5047e811c3d25c37c2398e63292c8e26"> 76</a></span>  int32_t <a class="code" href="structarrow_1_1ipc_1_1_file_block.html#a5047e811c3d25c37c2398e63292c8e26">metadata_length</a>;</div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structarrow_1_1ipc_1_1_file_block.html#ab0ea7d447b31d1e01a15bc6064bb6ee6"> 77</a></span>  int64_t <a class="code" href="structarrow_1_1ipc_1_1_file_block.html#ab0ea7d447b31 d1e01a15bc6064bb6ee6">body_length</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> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// Read interface classes. We do not fully deserialize the flatbuffers so that</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// individual fields metadata can be retrieved from very large schema without</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">//</span></div><div 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">// Retrieve a list of all the dictionary ids and types required by the schema for</span></div><div clas s="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// reconstruction. The presumption is that these will be loaded either from</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// the stream or file (or they may already be somewhere else in memory)</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a206b3e89811a8cba7f619d600193dbb8">GetDictionaryTypes</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* opaque_schema, <a class="code" href="namespacearrow_1_1ipc.html#a1a0b4525820946e0c01415d765c26ef5">DictionaryTypeMap</a>* id_to_field);</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">// Construct a complete Schema from the message. May be expensive for very</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">// large schemas if you are only interested in a few fields</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a588c4f02242330c9e16fc6b452c5acff">GetSchema</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* opaque_schema, <span class="keyword">const</span> <a class="code" href="classarrow_1_1ipc_1_1_dictionary_memo.html">DictionaryMemo</a>& dictionary_memo,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  std::shared_ptr<Schema>* out);</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> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a2480a87738d5e19fafc0563e70bd29b2">GetTensorMetadata</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a>& metadata, std::shared_ptr<DataType>* type,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::vector<int64_t>* shape, std::vector<int64_t>* strides,</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  std::vector<std::string>* dim_names);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a73a6008a1f54a9b18d8072d70 90e0689">WriteMessage</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a>& message, <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* file,</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  int32_t* message_length);</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">// Serialize arrow::Schema as a Flatbuffer</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">//</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">// \param[in] schema a Schema instance</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">// \param[inout] dictionary_mem o class for tracking dictionaries and assigning</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">// dictionary ids</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">// \param[out] out the serialized arrow::Buffer</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">// \return Status outcome</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#acbe9436de80fbc95e950ff3f1956fa1c">WriteSchemaMessage</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_schema.html">Schema</a>& <a class="code" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, <a class="code" href="classarrow_1_1ipc_1_1_dictionary_memo.html">Diction aryMemo</a>* dictionary_memo,</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a6b16f3888ae5067a5ad73ebd935f67e0">WriteRecordBatchMessage</a>(<span class="keyword">const</span> int64_t length, <span class="keyword">const</span> int64_t body_length,</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">const</span> std::vector<FieldMetadata>& nodes,</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">const</span> std::vector<BufferMetadata&g t;& buffers,</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a065f114babfba3b019019236c0d68cf4">WriteTensorMessage</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_tensor.html">Tensor</a>& tensor, <span class="keyword">const</span> int64_t buffer_start_offset,</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <a class ="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a36fb074d1ccd452428e2b65422c79e27">WriteFileFooter</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_schema.html">Schema</a>& <a class="code" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, <span class="keyword">const</span> std::vector<FileBlock>& dictionaries,</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">const</span> std::vector<FileBlock>& record_batches,</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classarrow_1_1ipc_1_1_dictionary_memo.html">DictionaryMemo</a>* dictionary_memo, <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* out);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span > </div><div class="line"><a name="l00127"></a><span class="lineno"> >127</span> <a class="code" href="classarrow_1_1_status.html">Status</a> ><a class="code" >href="namespacearrow_1_1ipc.html#a66696dc38979eece3c31b05620ef002f">WriteDictionaryMessage</a>(<span > class="keyword">const</span> int64_t <span class="keywordtype">id</span>, ><span class="keyword">const</span> int64_t length,</div><div class="line"><a >name="l00128"></a><span class="lineno"> 128</span>  > <span class="keyword">const</span> int64_t body_length,</div><div >class="line"><a name="l00129"></a><span class="lineno"> 129</span>  > <span class="keyword">const</span> >std::vector<FieldMetadata>& nodes,</div><div class="line"><a >name="l00130"></a><span class="lineno"> 130</span>  > <span class="keyword">const</span> >std::vector<BufferMetadata>& buffers,</div><div class="line"><a >name="l00131"></a>< span class="lineno"> 131</span>  std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> } <span class="comment">// namespace ipc</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#endif // ARROW_IPC_METADATA_H</span></div><div class="ttc" id="namespacearrow_1_1ipc_html_a66696dc38979eece3c31b05620ef002f"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a66696dc38979eece3c31b05620ef002f">arrow::ipc::WriteDictionaryMessage</a></div><div class="ttdeci">Status WriteDictionaryMessage(const int64_t id, const int64_t leng th, const int64_t body_length, const std::vector< FieldMetadata > &nodes, const std::vector< BufferMetadata > &buffers, std::shared_ptr< Buffer > *out)</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_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:115</div></div> <div class="ttc" id="structarrow_1_1ipc_1_1_buffer_metadata_html_a5aaece22f9f14aeb1d98daf6c55adb11"><div class="ttname"><a href="structarrow_1_1ipc_1_1_buffer_metadata.html#a5aaece22f9f14aeb1d98daf6c55adb11">arrow::ipc::BufferMetadata::page</a></div><div class="ttdeci">int32_t page</div><div class="ttdoc">The shared memory page id where to find this. Set to -1 if unused. </div><div class="ttdef"><b>Definition:</b> metadata-internal.h:65</div></div> <div class="ttc" id="namespacearrow_html_ae1692c648f5447a7f95ddbe2c4e9a5fc"><div class="ttname"><a href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">arrow::schema</a></div><div class="ttdeci">std::shared_ptr< Schema > schema(const std::vector< std::shared_ptr< Field >> &fields, const std::shared_ptr< const KeyValueMetadata > &metadata=nullptr)</div><div class="ttdoc">Create a Schema instance. </div></div> <div class="ttc" id="classarrow_1_1_tensor_html"><div class="ttname"><a href="classarrow_1_1_tensor.html">arrow::Tensor</a></div><div class="ttdef"><b>Definition:</b> tensor.h:53</div></div> @@ -83,7 +83,7 @@ $(function() { <div class="ttc" id="structarrow_1_1ipc_1_1_field_metadata_html_a63ff616ae287c542ef0c3dfda6531b1b"><div class="ttname"><a href="structarrow_1_1ipc_1_1_field_metadata.html#a63ff616ae287c542ef0c3dfda6531b1b">arrow::ipc::FieldMetadata::length</a></div><div class="ttdeci">int64_t length</div><div class="ttdef"><b>Definition:</b> metadata-internal.h:58</div></div> <div class="ttc" id="structarrow_1_1ipc_1_1_buffer_metadata_html"><div class="ttname"><a href="structarrow_1_1ipc_1_1_buffer_metadata.html">arrow::ipc::BufferMetadata</a></div><div class="ttdef"><b>Definition:</b> metadata-internal.h:63</div></div> <div class="ttc" id="namespacearrow_1_1ipc_html_a206b3e89811a8cba7f619d600193dbb8"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a206b3e89811a8cba7f619d600193dbb8">arrow::ipc::GetDictionaryTypes</a></div><div class="ttdeci">Status GetDictionaryTypes(const void *opaque_schema, DictionaryTypeMap *id_to_field)</div></div> -<div class="ttc" id="classarrow_1_1_schema_html"><div class="ttname"><a href="classarrow_1_1_schema.html">arrow::Schema</a></div><div class="ttdoc">Sequence of arrow::Field objects describing the columns of a record batch or table data structure...</div><div class="ttdef"><b>Definition:</b> type.h:716</div></div> +<div class="ttc" id="classarrow_1_1_schema_html"><div class="ttname"><a href="classarrow_1_1_schema.html">arrow::Schema</a></div><div class="ttdoc">Sequence of arrow::Field objects describing the columns of a record batch or table data structure...</div><div class="ttdef"><b>Definition:</b> type.h:718</div></div> <div class="ttc" id="structarrow_1_1ipc_1_1_field_metadata_html_ade643a1c4628139bb9feea157d897a97"><div class="ttname"><a href="structarrow_1_1ipc_1_1_field_metadata.html#ade643a1c4628139bb9feea157d897a97">arrow::ipc::FieldMetadata::offset</a></div><div class="ttdeci">int64_t offset</div><div class="ttdef"><b>Definition:</b> metadata-internal.h:60</div></div> <div class="ttc" id="structarrow_1_1ipc_1_1_field_metadata_html_abca970e08aa9f90451139d52a49ffb86"><div class="ttname"><a href="structarrow_1_1ipc_1_1_field_metadata.html#abca970e08aa9f90451139d52a49ffb86">arrow::ipc::FieldMetadata::null_count</a></div><div class="ttdeci">int64_t null_count</div><div class="ttdef"><b>Definition:</b> metadata-internal.h:59</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>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/mman_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/mman_8h.html b/docs/cpp/mman_8h.html index 95fc84c..f22463a 100644 --- a/docs/cpp/mman_8h.html +++ b/docs/cpp/mman_8h.html @@ -5,7 +5,7 @@ <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/io/mman.h File Reference</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/io/mman.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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/mman_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/mman_8h_source.html b/docs/cpp/mman_8h_source.html index 1fc9a07..6a712f3 100644 --- a/docs/cpp/mman_8h_source.html +++ b/docs/cpp/mman_8h_source.html @@ -5,7 +5,7 @@ <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/io/mman.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/io/mman.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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacearrow.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacearrow.html b/docs/cpp/namespacearrow.html index 9c6d277..09be8ea 100644 --- a/docs/cpp/namespacearrow.html +++ b/docs/cpp/namespacearrow.html @@ -2142,7 +2142,7 @@ Variables</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000018">Deprecated:</a></b></dt><dd>Since 0.7.0 </dd></dl> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd>Since 0.7.0 </dd></dl> </div> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacearrow_1_1compute.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacearrow_1_1compute.html b/docs/cpp/namespacearrow_1_1compute.html index 9838015..fea330a 100644 --- a/docs/cpp/namespacearrow_1_1compute.html +++ b/docs/cpp/namespacearrow_1_1compute.html @@ -141,11 +141,11 @@ Functions</h2></td></tr> <p>Cast from one array type to another. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td></td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">array</td><td></td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">to_type</td><td></td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td></td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td></td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>the <a class="el" href="classarrow_1_1compute_1_1_function_context.html" title="Container for variables and options used by function evaluation. ">FunctionContext</a> </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">array</td><td>array to cast </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">to_type</td><td>type to cast to </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>casting options </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>resulting array</td></tr> </table> </dd> </dl> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacearrow_1_1io.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacearrow_1_1io.html b/docs/cpp/namespacearrow_1_1io.html index bef73ee..86941ef 100644 --- a/docs/cpp/namespacearrow_1_1io.html +++ b/docs/cpp/namespacearrow_1_1io.html @@ -165,7 +165,7 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>Since 0.6.0 </dd></dl> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>Since 0.6.0 </dd></dl> </div> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacearrow_1_1ipc.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacearrow_1_1ipc.html b/docs/cpp/namespacearrow_1_1ipc.html index c7c3973..eb81c5f 100644 --- a/docs/cpp/namespacearrow_1_1ipc.html +++ b/docs/cpp/namespacearrow_1_1ipc.html @@ -592,7 +592,9 @@ Variables</h2></td></tr> <p>Read record batch as encapsulated IPC message with metadata size prefix and header. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname"></td><td></td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">schema</td><td>the record batch schema </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>the file where the batch is located </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the read record batch </td></tr> </table> </dd> </dl> @@ -640,7 +642,10 @@ Variables</h2></td></tr> <p>Read record batch from file given metadata and schema. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname"></td><td></td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">metadata</td><td>a <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> containing the record batch metadata </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">schema</td><td>the record batch schema </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>a random access file </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the read record batch </td></tr> </table> </dd> </dl> @@ -683,7 +688,7 @@ Variables</h2></td></tr> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>a message instance containing metadata and body </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">schema</td><td></td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">schema</td><td>the record batch schema </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the resulting <a class="el" href="classarrow_1_1_record_batch.html" title="Collection of equal-length arrays matching a particular Schema. ">RecordBatch</a> </td></tr> </table> </dd> @@ -739,7 +744,11 @@ Variables</h2></td></tr> <p>Read record batch from file given metadata and schema. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname"></td><td></td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">metadata</td><td>a <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> containing the record batch metadata </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">schema</td><td>the record batch schema </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>a random access file </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">max_recursion_depth</td><td>the maximum permitted nesting depth </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the read record batch </td></tr> </table> </dd> </dl> @@ -783,7 +792,7 @@ Variables</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>Since 0.7.0</dd></dl> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd>Since 0.7.0</dd></dl> <p>Deprecated in favor of more general InputStream-based API </p> </div> @@ -861,7 +870,9 @@ Variables</h2></td></tr> <p>EXPERIMENTAL: Read <a class="el" href="classarrow_1_1_tensor.html">arrow::Tensor</a> as encapsulated IPC message in file. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname"></td><td></td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>the file location of the start of the message </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>the file where the batch is located </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the read tensor </td></tr> </table> </dd> </dl> @@ -993,7 +1004,7 @@ Variables</h2></td></tr> <p>Serialize schema using stream writer as a sequence of one or more IPC messages. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">scheam</td><td>the schema to write </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">schema</td><td>the schema to write </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">pool</td><td>a <a class="el" href="classarrow_1_1_memory_pool.html" title="Base class for memory allocation. ">MemoryPool</a> to allocate memory from </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the serialized schema </td></tr> </table> @@ -1152,7 +1163,7 @@ Variables</h2></td></tr> </div><div class="memdoc"> <p>EXPERIMENTAL: Write <a class="el" href="classarrow_1_1_record_batch.html" title="Collection of equal-length arrays matching a particular Schema. ">RecordBatch</a> allowing lengths over INT32_MAX. </p> -<p>This data may not be readable by all Arrow implementations </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000012">Deprecated:</a></b></dt><dd>Since 0.7.0 </dd></dl> +<p>This data may not be readable by all Arrow implementations </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd>Since 0.7.0 </dd></dl> </div> </div> @@ -1261,10 +1272,15 @@ Variables</h2></td></tr> <p>Finally, the absolute offsets (relative to the start of the output stream) to the end of the body and end of the metadata / data header (suffixed by the header size) is returned in out-variables</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname"></td><td></td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">buffer_start_offset</td><td>the start offset to use in the buffer metadata, default should be 0 </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">allow_64bit</td><td>permit field lengths exceeding INT32_MAX. May not be readable by other Arrow implementations </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">metadata_length</td><td>the size of the length-prefixed flatbuffer including padding to a 64-byte boundary </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">body_length</td><td>the size of the contiguous buffer block plus padding bytes </td></tr> </table> </dd> </dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a></dd></dl> +<p>Low-level API </p> </div> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacearrow_1_1py.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacearrow_1_1py.html b/docs/cpp/namespacearrow_1_1py.html index 296673a..f584013 100644 --- a/docs/cpp/namespacearrow_1_1py.html +++ b/docs/cpp/namespacearrow_1_1py.html @@ -146,16 +146,6 @@ Functions</h2></td></tr> <tr class="separator:a5aeb2288cbab3189c357f1259769e842"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8949b2e5469221ad1b1eaf8665b9610b"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a8949b2e5469221ad1b1eaf8665b9610b">GetPrimitiveType</a> (<a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> type)</td></tr> <tr class="separator:a8949b2e5469221ad1b1eaf8665b9610b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a0d4e1e7cf205e8be31552d5d7b283fae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a0d4e1e7cf205e8be31552d5d7b283fae">ImportModule</a> (const std::string &module_name, <a class="el" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> *ref)</td></tr> -<tr class="separator:a0d4e1e7cf205e8be31552d5d7b283fae"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a9d82ea9a2d3de0d56579183cdb384082"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a9d82ea9a2d3de0d56579183cdb384082">ImportFromModule</a> (const <a class="el" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> &module, const std::string &module_name, <a class="el" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> *ref)</td></tr> -<tr class="separator:a9d82ea9a2d3de0d56579183cdb384082"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af3466f6420ace71354ac21e2f225b264"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#af3466f6420ace71354ac21e2f225b264">PythonDecimalToString</a> (PyObject *python_decimal, std::string *out)</td></tr> -<tr class="separator:af3466f6420ace71354ac21e2f225b264"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6b6b5a10ad414d6f8baf3b4cae02bee8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a6b6b5a10ad414d6f8baf3b4cae02bee8">InferDecimalPrecisionAndScale</a> (PyObject *python_decimal, int *precision=nullptr, int *scale=nullptr)</td></tr> -<tr class="separator:a6b6b5a10ad414d6f8baf3b4cae02bee8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa54a9b88b48f93c50fede512af945267"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#aa54a9b88b48f93c50fede512af945267">DecimalFromString</a> (PyObject *decimal_constructor, const std::string &decimal_string, PyObject **out)</td></tr> -<tr class="separator:aa54a9b88b48f93c50fede512af945267"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2dc076087e72fcc661e948407e631d44"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a2dc076087e72fcc661e948407e631d44">cast_npy_type_compat</a> (int type_num)</td></tr> <tr class="separator:a2dc076087e72fcc661e948407e631d44"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1d8a85306c0b562037827048b2db437e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a1d8a85306c0b562037827048b2db437e">is_contiguous</a> (PyObject *array)</td></tr> @@ -172,11 +162,9 @@ Functions</h2></td></tr> <tr class="separator:a6d731c1a770fd9042f71d1c79a359cac"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aed44255c90822cd2a6a0b2e6764dc2ac"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#aed44255c90822cd2a6a0b2e6764dc2ac">import_numpy</a> ()</td></tr> <tr class="separator:aed44255c90822cd2a6a0b2e6764dc2ac"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a83cc9cff9288b930ebc842e5d4795f09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a83cc9cff9288b930ebc842e5d4795f09">PandasToArrow</a> (<a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool, PyObject *ao, PyObject *mo, const std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > &type, std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > *out)</td></tr> -<tr class="separator:a83cc9cff9288b930ebc842e5d4795f09"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aab89ccbd0e890b97cb76fd01ad424de7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#aab89ccbd0e890b97cb76fd01ad424de7">PandasObjectsToArrow</a> (<a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool, PyObject *ao, PyObject *mo, const std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > &type, std::shared_ptr< <a class="el" href="classarrow_1_1_chunked_array.html">ChunkedArray</a> > *out)</td></tr> -<tr class="memdesc:aab89ccbd0e890b97cb76fd01ad424de7"><td class="mdescLeft"> </td><td class="mdescRight">Convert dtype=object arrays. <a href="#aab89ccbd0e890b97cb76fd01ad424de7">More...</a><br /></td></tr> -<tr class="separator:aab89ccbd0e890b97cb76fd01ad424de7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7e917e2ca4220b4d50c617d4f54ed5eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a7e917e2ca4220b4d50c617d4f54ed5eb">NdarrayToArrow</a> (<a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool, PyObject *ao, PyObject *mo, bool use_pandas_null_sentinels, const std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > &type, std::shared_ptr< <a class="el" href="classarrow_1_1_chunked_array.html">ChunkedArray</a> > *out)</td></tr> +<tr class="memdesc:a7e917e2ca4220b4d50c617d4f54ed5eb"><td class="mdescLeft"> </td><td class="mdescRight">Convert NumPy arrays to Arrow. <a href="#a7e917e2ca4220b4d50c617d4f54ed5eb">More...</a><br /></td></tr> +<tr class="separator:a7e917e2ca4220b4d50c617d4f54ed5eb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8c15948e1a75ba4908778cc942ded806"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a8c15948e1a75ba4908778cc942ded806">import_pyarrow</a> ()</td></tr> <tr class="separator:a8c15948e1a75ba4908778cc942ded806"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adb12f0ada1164958cbf5d25543577eaf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#adb12f0ada1164958cbf5d25543577eaf">is_buffer</a> (PyObject *buffer)</td></tr> @@ -596,40 +584,6 @@ Variables</h2></td></tr> </div> </div> -<a id="aa54a9b88b48f93c50fede512af945267"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aa54a9b88b48f93c50fede512af945267">◆ </a></span>DecimalFromString()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::DecimalFromString </td> - <td>(</td> - <td class="paramtype">PyObject * </td> - <td class="paramname"><em>decimal_constructor</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>decimal_string</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">PyObject ** </td> - <td class="paramname"><em>out</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> <a id="a9ba31943394b96b470e7ae0536fa50d1"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9ba31943394b96b470e7ae0536fa50d1">◆ </a></span>DeserializeObject()</h2> @@ -672,7 +626,7 @@ Variables</h2></td></tr> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>Serialization context which contains custom serialization and deserialization callbacks. Can be any Python object with a _serialize_callback method for serialization and a _deserialize_callback method for deserialization. If context is None, no custom serialization will be attempted. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">object</td><td></td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">object</td><td>object to deserialize </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">base</td><td>a Python object holding the underlying data that any NumPy arrays will reference, to avoid premature deallocation </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the returned object </td></tr> </table> @@ -815,68 +769,6 @@ Variables</h2></td></tr> </div> </div> -<a id="a9d82ea9a2d3de0d56579183cdb384082"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a9d82ea9a2d3de0d56579183cdb384082">◆ </a></span>ImportFromModule()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::ImportFromModule </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> & </td> - <td class="paramname"><em>module</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>module_name</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> * </td> - <td class="paramname"><em>ref</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a id="a0d4e1e7cf205e8be31552d5d7b283fae"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a0d4e1e7cf205e8be31552d5d7b283fae">◆ </a></span>ImportModule()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::ImportModule </td> - <td>(</td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>module_name</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> * </td> - <td class="paramname"><em>ref</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> <a id="a801e9b954f2b0c26a237efb5e8a94073"></a> <h2 class="memtitle"><span class="permalink"><a href="#a801e9b954f2b0c26a237efb5e8a94073">◆ </a></span>InferArrowSize()</h2> @@ -967,40 +859,6 @@ Variables</h2></td></tr> </div> </div> -<a id="a6b6b5a10ad414d6f8baf3b4cae02bee8"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a6b6b5a10ad414d6f8baf3b4cae02bee8">◆ </a></span>InferDecimalPrecisionAndScale()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::InferDecimalPrecisionAndScale </td> - <td>(</td> - <td class="paramtype">PyObject * </td> - <td class="paramname"><em>python_decimal</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int * </td> - <td class="paramname"><em>precision</em> = <code>nullptr</code>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int * </td> - <td class="paramname"><em>scale</em> = <code>nullptr</code> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> <a id="a0c8f3c97e27d6a38d25c01c7939f04c1"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0c8f3c97e27d6a38d25c01c7939f04c1">◆ </a></span>InvalidConversion()</h2> @@ -1215,14 +1073,14 @@ Variables</h2></td></tr> </div> </div> -<a id="acf548283df305290d6797233eb10ea8f"></a> -<h2 class="memtitle"><span class="permalink"><a href="#acf548283df305290d6797233eb10ea8f">◆ </a></span>NdarrayToTensor()</h2> +<a id="a7e917e2ca4220b4d50c617d4f54ed5eb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7e917e2ca4220b4d50c617d4f54ed5eb">◆ </a></span>NdarrayToArrow()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::NdarrayToTensor </td> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::NdarrayToArrow </td> <td>(</td> <td class="paramtype"><a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> * </td> <td class="paramname"><em>pool</em>, </td> @@ -1236,70 +1094,14 @@ Variables</h2></td></tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_tensor.html">Tensor</a> > * </td> - <td class="paramname"><em>out</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a id="a9d0ba3df1922f37090d3de6db967aa72"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a9d0ba3df1922f37090d3de6db967aa72">◆ </a></span>NumPyDtypeToArrow()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::NumPyDtypeToArrow </td> - <td>(</td> - <td class="paramtype">PyObject * </td> - <td class="paramname"><em>dtype</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > * </td> - <td class="paramname"><em>out</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a id="aab89ccbd0e890b97cb76fd01ad424de7"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aab89ccbd0e890b97cb76fd01ad424de7">◆ </a></span>PandasObjectsToArrow()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::PandasObjectsToArrow </td> - <td>(</td> - <td class="paramtype"><a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> * </td> - <td class="paramname"><em>pool</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> <td class="paramtype">PyObject * </td> - <td class="paramname"><em>ao</em>, </td> + <td class="paramname"><em>mo</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">PyObject * </td> - <td class="paramname"><em>mo</em>, </td> + <td class="paramtype">bool </td> + <td class="paramname"><em>use_pandas_null_sentinels</em>, </td> </tr> <tr> <td class="paramkey"></td> @@ -1321,14 +1123,14 @@ Variables</h2></td></tr> </table> </div><div class="memdoc"> -<p>Convert dtype=object arrays. </p> +<p>Convert NumPy arrays to Arrow. </p> <p>If target data type is not known, pass a type with nullptr</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">pool</td><td>Memory pool for any memory allocations </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">ao</td><td>an ndarray with the array data </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">mo</td><td>an ndarray with a null mask (True is null), optional </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td></td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>a specific type to cast to, may be null </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>a <a class="el" href="classarrow_1_1_chunked_array.html" title="A data structure managing a list of primitive Arrow arrays logically as one large array...">ChunkedArray</a>, to accommodate chunked output </td></tr> </table> </dd> @@ -1336,14 +1138,14 @@ Variables</h2></td></tr> </div> </div> -<a id="a83cc9cff9288b930ebc842e5d4795f09"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a83cc9cff9288b930ebc842e5d4795f09">◆ </a></span>PandasToArrow()</h2> +<a id="acf548283df305290d6797233eb10ea8f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acf548283df305290d6797233eb10ea8f">◆ </a></span>NdarrayToTensor()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::PandasToArrow </td> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::NdarrayToTensor </td> <td>(</td> <td class="paramtype"><a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> * </td> <td class="paramname"><em>pool</em>, </td> @@ -1357,19 +1159,7 @@ Variables</h2></td></tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">PyObject * </td> - <td class="paramname"><em>mo</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > & </td> - <td class="paramname"><em>type</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > * </td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_tensor.html">Tensor</a> > * </td> <td class="paramname"><em>out</em> </td> </tr> <tr> @@ -1382,45 +1172,45 @@ Variables</h2></td></tr> </div> </div> -<a id="a420f8c193475027edf8f2fb07cb6274f"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a420f8c193475027edf8f2fb07cb6274f">◆ </a></span>PassPyError()</h2> +<a id="a9d0ba3df1922f37090d3de6db967aa72"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9d0ba3df1922f37090d3de6db967aa72">◆ </a></span>NumPyDtypeToArrow()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::PassPyError </td> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::NumPyDtypeToArrow </td> <td>(</td> - <td class="paramname"></td><td>)</td> + <td class="paramtype">PyObject * </td> + <td class="paramname"><em>dtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> <td></td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > * </td> + <td class="paramname"><em>out</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> </div><div class="memdoc"> </div> </div> -<a id="af3466f6420ace71354ac21e2f225b264"></a> -<h2 class="memtitle"><span class="permalink"><a href="#af3466f6420ace71354ac21e2f225b264">◆ </a></span>PythonDecimalToString()</h2> +<a id="a420f8c193475027edf8f2fb07cb6274f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a420f8c193475027edf8f2fb07cb6274f">◆ </a></span>PassPyError()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::PythonDecimalToString </td> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::py::PassPyError </td> <td>(</td> - <td class="paramtype">PyObject * </td> - <td class="paramname"><em>python_decimal</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">std::string * </td> - <td class="paramname"><em>out</em> </td> - </tr> - <tr> + <td class="paramname"></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacemembers_d.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacemembers_d.html b/docs/cpp/namespacemembers_d.html index 350fb47..208217c 100644 --- a/docs/cpp/namespacemembers_d.html +++ b/docs/cpp/namespacemembers_d.html @@ -92,9 +92,6 @@ $(function() { <li>decimal_type() : <a class="el" href="namespacearrow.html#aecb3c7b3d0ee16a7761adcfdbe56c113">arrow</a> </li> -<li>DecimalFromString() -: <a class="el" href="namespacearrow_1_1py.html#aa54a9b88b48f93c50fede512af945267">arrow::py</a> -</li> <li>default_memory_pool() : <a class="el" href="namespacearrow.html#aebe81d544faaf827b8f32c5a80b99820">arrow</a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacemembers_func_d.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacemembers_func_d.html b/docs/cpp/namespacemembers_func_d.html index e819c4b..4d3e9eb 100644 --- a/docs/cpp/namespacemembers_func_d.html +++ b/docs/cpp/namespacemembers_func_d.html @@ -77,9 +77,6 @@ $(function() { <li>decimal_type() : <a class="el" href="namespacearrow.html#aecb3c7b3d0ee16a7761adcfdbe56c113">arrow</a> </li> -<li>DecimalFromString() -: <a class="el" href="namespacearrow_1_1py.html#aa54a9b88b48f93c50fede512af945267">arrow::py</a> -</li> <li>default_memory_pool() : <a class="el" href="namespacearrow.html#aebe81d544faaf827b8f32c5a80b99820">arrow</a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacemembers_func_i.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacemembers_func_i.html b/docs/cpp/namespacemembers_func_i.html index 5234f11..24a8dfd 100644 --- a/docs/cpp/namespacemembers_func_i.html +++ b/docs/cpp/namespacemembers_func_i.html @@ -68,12 +68,6 @@ $(function() { <li>import_pyarrow() : <a class="el" href="namespacearrow_1_1py.html#a8c15948e1a75ba4908778cc942ded806">arrow::py</a> </li> -<li>ImportFromModule() -: <a class="el" href="namespacearrow_1_1py.html#a9d82ea9a2d3de0d56579183cdb384082">arrow::py</a> -</li> -<li>ImportModule() -: <a class="el" href="namespacearrow_1_1py.html#a0d4e1e7cf205e8be31552d5d7b283fae">arrow::py</a> -</li> <li>InferArrowSize() : <a class="el" href="namespacearrow_1_1py.html#a801e9b954f2b0c26a237efb5e8a94073">arrow::py</a> </li> @@ -83,9 +77,6 @@ $(function() { <li>InferArrowTypeAndSize() : <a class="el" href="namespacearrow_1_1py.html#a662f3dfdff151fdc4b779b0704bfa995">arrow::py</a> </li> -<li>InferDecimalPrecisionAndScale() -: <a class="el" href="namespacearrow_1_1py.html#a6b6b5a10ad414d6f8baf3b4cae02bee8">arrow::py</a> -</li> <li>int16() : <a class="el" href="namespacearrow.html#a034c5c703e15039fe76af412d349734d">arrow</a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacemembers_func_n.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacemembers_func_n.html b/docs/cpp/namespacemembers_func_n.html index d7dfbde..c8f7310 100644 --- a/docs/cpp/namespacemembers_func_n.html +++ b/docs/cpp/namespacemembers_func_n.html @@ -62,6 +62,9 @@ $(function() {   <h3><a id="index_n"></a>- n -</h3><ul> +<li>NdarrayToArrow() +: <a class="el" href="namespacearrow_1_1py.html#a7e917e2ca4220b4d50c617d4f54ed5eb">arrow::py</a> +</li> <li>NdarrayToTensor() : <a class="el" href="namespacearrow_1_1py.html#acf548283df305290d6797233eb10ea8f">arrow::py</a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacemembers_func_p.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacemembers_func_p.html b/docs/cpp/namespacemembers_func_p.html index fa932db..efc53c5 100644 --- a/docs/cpp/namespacemembers_func_p.html +++ b/docs/cpp/namespacemembers_func_p.html @@ -62,12 +62,6 @@ $(function() {   <h3><a id="index_p"></a>- p -</h3><ul> -<li>PandasObjectsToArrow() -: <a class="el" href="namespacearrow_1_1py.html#aab89ccbd0e890b97cb76fd01ad424de7">arrow::py</a> -</li> -<li>PandasToArrow() -: <a class="el" href="namespacearrow_1_1py.html#a83cc9cff9288b930ebc842e5d4795f09">arrow::py</a> -</li> <li>ParallelFor() : <a class="el" href="namespacearrow.html#a0cc7c6eac204bd82e3d25d6467779611">arrow</a> </li> @@ -81,10 +75,7 @@ $(function() { : <a class="el" href="namespaceplasma.html#a80d88b1ca6fbdda17705f6e8fa53140e">plasma</a> </li> <li>PrettyPrint() -: <a class="el" href="namespacearrow.html#a4dc6b3a8c2c471161f3b4c6c61e86aad">arrow</a> -</li> -<li>PythonDecimalToString() -: <a class="el" href="namespacearrow_1_1py.html#af3466f6420ace71354ac21e2f225b264">arrow::py</a> +: <a class="el" href="namespacearrow.html#a737bc52e404537e2dbb14e110e78daaa">arrow</a> </li> </ul> </div><!-- contents --> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacemembers_i.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacemembers_i.html b/docs/cpp/namespacemembers_i.html index 38f035b..0f9ef4c 100644 --- a/docs/cpp/namespacemembers_i.html +++ b/docs/cpp/namespacemembers_i.html @@ -68,12 +68,6 @@ $(function() { <li>import_pyarrow() : <a class="el" href="namespacearrow_1_1py.html#a8c15948e1a75ba4908778cc942ded806">arrow::py</a> </li> -<li>ImportFromModule() -: <a class="el" href="namespacearrow_1_1py.html#a9d82ea9a2d3de0d56579183cdb384082">arrow::py</a> -</li> -<li>ImportModule() -: <a class="el" href="namespacearrow_1_1py.html#a0d4e1e7cf205e8be31552d5d7b283fae">arrow::py</a> -</li> <li>InferArrowSize() : <a class="el" href="namespacearrow_1_1py.html#a801e9b954f2b0c26a237efb5e8a94073">arrow::py</a> </li> @@ -83,9 +77,6 @@ $(function() { <li>InferArrowTypeAndSize() : <a class="el" href="namespacearrow_1_1py.html#a662f3dfdff151fdc4b779b0704bfa995">arrow::py</a> </li> -<li>InferDecimalPrecisionAndScale() -: <a class="el" href="namespacearrow_1_1py.html#a6b6b5a10ad414d6f8baf3b4cae02bee8">arrow::py</a> -</li> <li>int16() : <a class="el" href="namespacearrow.html#a034c5c703e15039fe76af412d349734d">arrow</a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacemembers_n.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacemembers_n.html b/docs/cpp/namespacemembers_n.html index 895fb40..85574d9 100644 --- a/docs/cpp/namespacemembers_n.html +++ b/docs/cpp/namespacemembers_n.html @@ -62,6 +62,9 @@ $(function() { <div class="textblock">Here is a list of all namespace members with links to the namespace documentation for each member:</div> <h3><a id="index_n"></a>- n -</h3><ul> +<li>NdarrayToArrow() +: <a class="el" href="namespacearrow_1_1py.html#a7e917e2ca4220b4d50c617d4f54ed5eb">arrow::py</a> +</li> <li>NdarrayToTensor() : <a class="el" href="namespacearrow_1_1py.html#acf548283df305290d6797233eb10ea8f">arrow::py</a> </li> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/namespacemembers_p.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacemembers_p.html b/docs/cpp/namespacemembers_p.html index bc9e7a6..6a73b34 100644 --- a/docs/cpp/namespacemembers_p.html +++ b/docs/cpp/namespacemembers_p.html @@ -62,12 +62,6 @@ $(function() { <div class="textblock">Here is a list of all namespace members with links to the namespace documentation for each member:</div> <h3><a id="index_p"></a>- p -</h3><ul> -<li>PandasObjectsToArrow() -: <a class="el" href="namespacearrow_1_1py.html#aab89ccbd0e890b97cb76fd01ad424de7">arrow::py</a> -</li> -<li>PandasToArrow() -: <a class="el" href="namespacearrow_1_1py.html#a83cc9cff9288b930ebc842e5d4795f09">arrow::py</a> -</li> <li>ParallelFor() : <a class="el" href="namespacearrow.html#a0cc7c6eac204bd82e3d25d6467779611">arrow</a> </li> @@ -96,10 +90,7 @@ $(function() { : <a class="el" href="namespaceplasma.html#a80d88b1ca6fbdda17705f6e8fa53140e">plasma</a> </li> <li>PrettyPrint() -: <a class="el" href="namespacearrow.html#a4dc6b3a8c2c471161f3b4c6c61e86aad">arrow</a> -</li> -<li>PythonDecimalToString() -: <a class="el" href="namespacearrow_1_1py.html#af3466f6420ace71354ac21e2f225b264">arrow::py</a> +: <a class="el" href="namespacearrow.html#a5e646aac1cf6c89685b5d161377a236b">arrow</a> </li> </ul> </div><!-- contents --> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/numpy-internal_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/numpy-internal_8h.html b/docs/cpp/numpy-internal_8h.html index b5ee20a..973222f 100644 --- a/docs/cpp/numpy-internal_8h.html +++ b/docs/cpp/numpy-internal_8h.html @@ -5,7 +5,7 @@ <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/numpy-internal.h File Reference</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/numpy-internal.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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/numpy-internal_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/numpy-internal_8h_source.html b/docs/cpp/numpy-internal_8h_source.html index 00175b2..c278333 100644 --- a/docs/cpp/numpy-internal_8h_source.html +++ b/docs/cpp/numpy-internal_8h_source.html @@ -5,7 +5,7 @@ <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/numpy-internal.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/numpy-internal.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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/numpy__convert_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/numpy__convert_8h.html b/docs/cpp/numpy__convert_8h.html index d4f7c6f..0f7990c 100644 --- a/docs/cpp/numpy__convert_8h.html +++ b/docs/cpp/numpy__convert_8h.html @@ -5,7 +5,7 @@ <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/numpy_convert.h File Reference</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/numpy_convert.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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/numpy__convert_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/numpy__convert_8h_source.html b/docs/cpp/numpy__convert_8h_source.html index 580ac37..9691fd6 100644 --- a/docs/cpp/numpy__convert_8h_source.html +++ b/docs/cpp/numpy__convert_8h_source.html @@ -5,7 +5,7 @@ <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/numpy_convert.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/numpy_convert.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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/numpy__interop_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/numpy__interop_8h.html b/docs/cpp/numpy__interop_8h.html index 0bbce0a..5b5b283 100644 --- a/docs/cpp/numpy__interop_8h.html +++ b/docs/cpp/numpy__interop_8h.html @@ -5,7 +5,7 @@ <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/numpy_interop.h File Reference</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/numpy_interop.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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/numpy__interop_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/numpy__interop_8h_source.html b/docs/cpp/numpy__interop_8h_source.html index 93550d0..b7586fa 100644 --- a/docs/cpp/numpy__interop_8h_source.html +++ b/docs/cpp/numpy__interop_8h_source.html @@ -5,7 +5,7 @@ <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/numpy_interop.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/numpy_interop.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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/8673db8b/docs/cpp/numpy__to__arrow_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/numpy__to__arrow_8h.html b/docs/cpp/numpy__to__arrow_8h.html new file mode 100644 index 0000000..1706db3 --- /dev/null +++ b/docs/cpp/numpy__to__arrow_8h.html @@ -0,0 +1,101 @@ +<!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++): /apache-arrow/arrow/cpp/src/arrow/python/numpy_to_arrow.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">numpy_to_arrow.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 <memory></code><br /> +<code>#include "<a class="el" href="visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br /> +</div> +<p><a href="numpy__to__arrow_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> +Namespaces</h2></td></tr> +<tr class="memitem:namespacearrow"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html">arrow</a></td></tr> +<tr class="memdesc:namespacearrow"><td class="mdescLeft"> </td><td class="mdescRight">Top-level namespace for Apache Arrow C++ API. <br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:namespacearrow_1_1py"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html">arrow::py</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a7e917e2ca4220b4d50c617d4f54ed5eb"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a7e917e2ca4220b4d50c617d4f54ed5eb">arrow::py::NdarrayToArrow</a> (MemoryPool *pool, PyObject *ao, PyObject *mo, bool use_pandas_null_sentinels, const std::shared_ptr< DataType > &type, std::shared_ptr< ChunkedArray > *out)</td></tr> +<tr class="memdesc:a7e917e2ca4220b4d50c617d4f54ed5eb"><td class="mdescLeft"> </td><td class="mdescRight">Convert NumPy arrays to Arrow. <a href="namespacearrow_1_1py.html#a7e917e2ca4220b4d50c617d4f54ed5eb">More...</a><br /></td></tr> +<tr class="separator:a7e917e2ca4220b4d50c617d4f54ed5eb"><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>
