http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/builtin__convert_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/builtin__convert_8h.html b/docs/cpp/builtin__convert_8h.html index 603919c..bbfb57a 100644 --- a/docs/cpp/builtin__convert_8h.html +++ b/docs/cpp/builtin__convert_8h.html @@ -97,16 +97,16 @@ Functions</h2></td></tr> <tr class="separator:a8bd9328121d69070c36f08839d321e03"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a662f3dfdff151fdc4b779b0704bfa995"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">arrow::Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a662f3dfdff151fdc4b779b0704bfa995">arrow::py::InferArrowTypeAndSize</a> (PyObject *obj, int64_t *size, std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a> > *out_type)</td></tr> <tr class="separator:a662f3dfdff151fdc4b779b0704bfa995"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a801e9b954f2b0c26a237efb5e8a94073"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">arrow::Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a801e9b954f2b0c26a237efb5e8a94073">arrow::py::InferArrowSize</a> (PyObject *obj, int64_t *size)</td></tr> -<tr class="separator:a801e9b954f2b0c26a237efb5e8a94073"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af44052b681633fea317d0d058b18a674"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">arrow::Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#af44052b681633fea317d0d058b18a674">arrow::py::AppendPySequence</a> (PyObject *obj, int64_t size, const std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a> > &type, <a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a> *builder)</td></tr> <tr class="separator:af44052b681633fea317d0d058b18a674"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a100162703dd2961e39447265bb2ddd9e"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a100162703dd2961e39447265bb2ddd9e">arrow::py::ConvertPySequence</a> (PyObject *obj, MemoryPool *pool, std::shared_ptr< Array > *out)</td></tr> <tr class="separator:a100162703dd2961e39447265bb2ddd9e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ac36caac328ed66e40e637c9ea49d9533"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#ac36caac328ed66e40e637c9ea49d9533">arrow::py::ConvertPySequence</a> (PyObject *obj, MemoryPool *pool, std::shared_ptr< Array > *out, const std::shared_ptr< DataType > &type)</td></tr> -<tr class="separator:ac36caac328ed66e40e637c9ea49d9533"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a8a0974d5390a4ee449d34daf39aac4be"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a8a0974d5390a4ee449d34daf39aac4be">arrow::py::ConvertPySequence</a> (PyObject *obj, MemoryPool *pool, std::shared_ptr< Array > *out, const std::shared_ptr< DataType > &type, int64_t size)</td></tr> -<tr class="separator:a8a0974d5390a4ee449d34daf39aac4be"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae54082f1471ba82d9d91e425c7f3067e"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#ae54082f1471ba82d9d91e425c7f3067e">arrow::py::ConvertPySequence</a> (PyObject *obj, int64_t size, MemoryPool *pool, std::shared_ptr< Array > *out)</td></tr> +<tr class="separator:ae54082f1471ba82d9d91e425c7f3067e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a302aeb223d2ed56ca1a2f3447e27e94f"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a302aeb223d2ed56ca1a2f3447e27e94f">arrow::py::ConvertPySequence</a> (PyObject *obj, const std::shared_ptr< DataType > &type, MemoryPool *pool, std::shared_ptr< Array > *out)</td></tr> +<tr class="separator:a302aeb223d2ed56ca1a2f3447e27e94f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a515844fecfe171beea17df7b0d8a3862"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a515844fecfe171beea17df7b0d8a3862">arrow::py::ConvertPySequence</a> (PyObject *obj, int64_t size, const std::shared_ptr< DataType > &type, MemoryPool *pool, std::shared_ptr< Array > *out)</td></tr> +<tr class="separator:a515844fecfe171beea17df7b0d8a3862"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0c8f3c97e27d6a38d25c01c7939f04c1"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a0c8f3c97e27d6a38d25c01c7939f04c1">arrow::py::InvalidConversion</a> (PyObject *obj, const std::string &expected_type_name, std::ostream *out)</td></tr> <tr class="separator:a0c8f3c97e27d6a38d25c01c7939f04c1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a06b8a872c10fd37c65fe3eb06fe38241"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html#a06b8a872c10fd37c65fe3eb06fe38241">arrow::py::CheckPythonBytesAreFixedLength</a> (PyObject *obj, Py_ssize_t expected_length)</td></tr>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/builtin__convert_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/builtin__convert_8h_source.html b/docs/cpp/builtin__convert_8h_source.html index c040d9c..b750a31 100644 --- a/docs/cpp/builtin__convert_8h_source.html +++ b/docs/cpp/builtin__convert_8h_source.html @@ -70,13 +70,12 @@ $(function() { <div class="title">builtin_convert.h</div> </div> </div><!--header--> <div class="contents"> -<a href="builtin__convert_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><s pan 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 dist ributed 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 CPython built-in data structures and Arrow</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// 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_BUILTIN_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define ARROW_PYTHON_ADAPTERS_BUILTIN_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 class="preproce ssor">#include <memory></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <ostream></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="type_8h.html">arrow/type.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></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="preprocessor"> #include "<a class="code" href="arrow_2python_2common_8h.html">arrow/python/common.h</a>"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>Array;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</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="lineno"> 42</span> ARROW_EXPORT <a class="code" href="classarrow_1_1_status.html">arrow::Status</a> <a class="code" href="namespacearrow_1_1py.html#a8bd9328121d69070c36f08839d321e03">InferArrowType</a>(PyObject* obj,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  std::shared_ptr<arrow::DataType>* out_type);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> ARROW_EXPORT <a class="code" href="classarrow_1_1_status.html">arrow::Status</a> <a class="code" href="namespacearrow_1_1py.html#a662f3dfdff151fdc4b779b0704bfa995">InferArrowTypeAndSize</a>(</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  PyObject* obj, int64_t* size, std::shared_ptr<arrow::DataType>* out_type);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> ARROW_EXPORT < a class="code" href="classarrow_1_1_status.html">arrow::Status</a> <a class="code" href="namespacearrow_1_1py.html#a801e9b954f2b0c26a237efb5e8a94073">InferArrowSize</a>(PyObject* obj, int64_t* size);</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> ARROW_EXPORT <a class="code" href="classarrow_1_1_status.html">arrow::Status</a> <a class="code" href="namespacearrow_1_1py.html#af44052b681633fea317d0d058b18a674">AppendPySequence</a>(PyObject* obj, int64_t size,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">const</span> std::shared_ptr<arrow::DataType>& type,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder< /a>* builder);</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="comment">// Type and size inference</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> ARROW_EXPORT</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> Status <a class="code" href="namespacearrow_1_1py.html#a100162703dd2961e39447265bb2ddd9e">ConvertPySequence</a>(PyObject* obj, MemoryPool* pool, std::shared_ptr<Array>* out);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// Size inference</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> ARROW_EXPORT</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> Status <a class="code" href="namespacearrow_1_1py.html#a100162703dd2961e39447265bb2ddd9e">ConvertPySequence</a>(PyObject* obj, MemoryPool* pool, std::shared_ptr<Array>* out,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">const</span> std::shared_ptr<DataType>& type);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// No inference</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> ARROW_EXPORT</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> Status <a class="code" href="namespacearrow_1_1py.html#a100162703dd2961e39447265bb2ddd9e">ConvertPySequence</a>(PyObject* obj, MemoryPool* pool, std::shared_ptr<Array>* out,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> std::shared_ptr<DataType>& type, int64_t size);</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> ARROW_EXPORT</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> Status <a class="code" href="namespacearrow_1_1py.html#a0c8f3c97e27d6a38d25c01c7939f04c1">InvalidConversion</a>(PyObject* obj, <span class="keyword">const</span> std::string& expected_type_name,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  std::ostream* out);</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> ARROW_EXPORT Status <a class="code" href="namespacearrow_1_1py.html#a06b8a872c10fd37c65fe3eb06fe38241">C heckPythonBytesAreFixedLength</a>(PyObject* obj,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  Py_ssize_t expected_length);</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> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif // ARROW_PYTHON_ADAPTERS_BUILTIN_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="namespacearrow_1_1py_html_a801e9b954f2b0c26a237efb5e8a94073"><div class="ttname"><a href="namespacearrow_1_1py.html#a801e9b954f2b0c26a237efb5e8a94073">arrow::py::InferArrowSize</a></div><div class="ttdeci">arrow::Status InferArrowSize(PyObject *obj, int64_t *size)</div></div> +<a href="builtin__convert_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><s pan 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 dist ributed 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 CPython built-in data structures and Arrow</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// 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_BUILTIN_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define ARROW_PYTHON_ADAPTERS_BUILTIN_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 class="preproce ssor">#include <memory></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <ostream></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="type_8h.html">arrow/type.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></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="preprocessor"> #include "<a class="code" href="arrow_2python_2common_8h.html">arrow/python/common.h</a>"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>Array;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</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="lineno"> 42</span> <span class="comment">// These three functions take a sequence input, not arbitrary iterables</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> ARROW_EXPORT <a class="code" href="classarrow_1_1_status.html">arrow::Status</a> <a class="code" href="namespacearrow_1_1py.html#a8bd9328121d69070c36f08839d321e03">InferArrowType</a>(PyObject* obj,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  std::shared_ptr<arrow::DataType>* out_type);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> ARROW_EXPORT <a class="code" href="classarrow_1_1_status.html">arrow::Status</a> <a class="code" href="namespacearrow_1_1py.html#a662f3dfdff151fdc4b779b0704bfa995">InferArrowTypeAndSize</a>(</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> 0; PyObject* obj, int64_t* size, std::shared_ptr<arrow::DataType>* out_type);</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> ARROW_EXPORT <a class="code" href="classarrow_1_1_status.html">arrow::Status</a> <a class="code" href="namespacearrow_1_1py.html#af44052b681633fea317d0d058b18a674">AppendPySequence</a>(PyObject* obj, int64_t size,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">const</span> std::shared_ptr<arrow::DataType>& type,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a>* builder);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div clas s="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// Type and size inference</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> ARROW_EXPORT</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> Status <a class="code" href="namespacearrow_1_1py.html#a100162703dd2961e39447265bb2ddd9e">ConvertPySequence</a>(PyObject* obj, MemoryPool* pool, std::shared_ptr<Array>* out);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// Type inference only</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> ARROW_EXPORT</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> Status <a class="code" href="namespacearrow_1_1py.html#a100162703dd2961e39447265bb2ddd9e">ConvertPySequence</a>(Py Object* obj, int64_t size, MemoryPool* pool,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  std::shared_ptr<Array>* out);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// Size inference only</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> ARROW_EXPORT</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> Status <a class="code" href="namespacearrow_1_1py.html#a100162703dd2961e39447265bb2ddd9e">ConvertPySequence</a>(PyObject* obj, <span class="keyword">const</span> std::shared_ptr<DataType>& type,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  MemoryPool* pool, std::shared_ptr<Array>* out);</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> <span >class="comment">// No inference</span></div><div class="line"><a >name="l00067"></a><span class="lineno"> >67</span> ARROW_EXPORT</div><div class="line"><a name="l00068"></a><span >class="lineno"> 68</span> Status <a class="code" >href="namespacearrow_1_1py.html#a100162703dd2961e39447265bb2ddd9e">ConvertPySequence</a>(PyObject* > obj, int64_t size,</div><div class="line"><a name="l00069"></a><span >class="lineno"> 69</span>  <span >class="keyword">const</span> std::shared_ptr<DataType>& type, >MemoryPool* pool,</div><div class="line"><a name="l00070"></a><span >class="lineno"> 70</span>  >std::shared_ptr<Array>* out);</div><div class="line"><a >name="l00071"></a><span class="lineno"> 71</span> </div><div >class="line"><a name="l00072"></a><span class="lineno"> 72</span > ARROW_EXPORT</div><div class="line"><a name="l00073"></a><span >class="lineno"> 73</span> Status <a class="code" >href="namespacearrow_1_1py.html#a0c8f3c97e27d6a38d25c01c7939f04c1">InvalidConversion</a>(PyObject* > obj, <span class="keyword">const</span> std::string& >expected_type_name,</div><div class="line"><a name="l00074"></a><span >class="lineno"> 74</span>  std::ostream* >out);</div><div class="line"><a name="l00075"></a><span class="lineno"> >75</span> </div><div class="line"><a name="l00076"></a><span >class="lineno"> 76</span> ARROW_EXPORT Status <a class="code" >href="namespacearrow_1_1py.html#a06b8a872c10fd37c65fe3eb06fe38241">CheckPythonBytesAreFixedLength</a>(PyObject* > obj,</div><div class="line"><a name="l00077"></a><span class="lineno"> >77</span>  Py_ssize_t >expected_length);</div><div class="line"><a name="l00078"></a><span >class="lineno"> 78</span> < /div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif // ARROW_PYTHON_ADAPTERS_BUILTIN_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="namespacearrow_1_1py_html_a662f3dfdff151fdc4b779b0704bfa995"><div class="ttname"><a href="namespacearrow_1_1py.html#a662f3dfdff151fdc4b779b0704bfa995">arrow::py::InferArrowTypeAndSize</a></div><div class="ttdeci">arrow::Status InferArrowTypeAndSize(PyObject *obj, int64_t *size, std::shared_ptr< arrow::DataType > *out_type)</div></div> <div class="ttc" id="namespacearrow_1_1py_html_a0c8f3c97e27d6a38d25c01c7939f04c1"><div class="ttname"><a href="namespacearrow_1_1py.html#a0c8f3c97e27d6a38d25c01c7939f04c1">arrow::py::InvalidConversion</a></div><div class="ttdeci">Status InvalidConversion(PyObject *obj, const std::string &expected_type_name, std::ostream *out)</div></div> <div class="ttc" id="namespacearrow_1_1py_html_a8bd9328121d69070c36f08839d321e03"><div class="ttname"><a href="namespacearrow_1_1py.html#a8bd9328121d69070c36f08839d321e03">arrow::py::InferArrowType</a></div><div class="ttdeci">arrow::Status InferArrowType(PyObject *obj, std::shared_ptr< arrow::DataType > *out_type)</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="classarrow_1_1_array_builder_html"><div class="ttname"><a href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></div><div class="ttdoc">Base class for all data array builders. </div><div class="ttdef"><b>Definition:</b> builder.h:57</div></div> +<div class="ttc" id="classarrow_1_1_array_builder_html"><div class="ttname"><a href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></div><div class="ttdoc">Base class for all data array builders. </div><div class="ttdef"><b>Definition:</b> builder.h:60</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="namespacearrow_1_1py_html_af44052b681633fea317d0d058b18a674"><div class="ttname"><a href="namespacearrow_1_1py.html#af44052b681633fea317d0d058b18a674">arrow::py::AppendPySequence</a></div><div class="ttdeci">arrow::Status AppendPySequence(PyObject *obj, int64_t size, const std::shared_ptr< arrow::DataType > &type, arrow::ArrayBuilder *builder)</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/4c7c2f1b/docs/cpp/cast_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/cast_8h_source.html b/docs/cpp/cast_8h_source.html index 3ef65c7..a72b251 100644 --- a/docs/cpp/cast_8h_source.html +++ b/docs/cpp/cast_8h_source.html @@ -72,7 +72,7 @@ $(function() { <div class="contents"> <a href="cast_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="l ineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed unde r 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_COMPUTE_KERNELS_CAST_H</span></div><div class="line"><a name="l00019"></a><span class="li neno"> 19</span> <span class="preprocessor">#define ARROW_COMPUTE_KERNELS_CAST_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocess or">#include "<a class="code" href="kernel_8h.html">arrow/compute/kernel.h</a>"</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="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>Array;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>ChunkedArray;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>Column;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>DataType;</div><div class="line"><a name="l00034"></a> <span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>compute {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structarrow_1_1compute_1_1_cast_options.html"> 37</a></span> <span class="keyword">struct </span>ARROW_EXPORT <a class="code" href="structarrow_1_1compute_1_1_cast_options.html">CastOptions</a> {</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structarrow_1_1compute_1_1_cast_options.html#a926af2b39ebb3494a447987f5255350e"> 38</a></span>  <a class="code" href="structarrow_1_1compute_1_1_cast_options.html#a926af2b39ebb3494a447987f5255350e">CastOptions</a>() : allow_int_overflow(false), allow_time_truncate(false) {}</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> 0;</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structarrow_1_1compute_1_1_cast_options.html#acbb8da5a5aeecb1a89392a5dba94ecb7"> 40</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structarrow_1_1compute_1_1_cast_options.html#acbb8da5a5aeecb1a89392a5dba94ecb7">allow_int_overflow</a>;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structarrow_1_1compute_1_1_cast_options.html#ae7afd064112db4f0d91dd48ed2b567fd"> 41</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structarrow_1_1compute_1_1_cast_options.html#ae7afd064112db4f0d91dd48ed2b567fd">allow_time_truncate</a>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> };</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </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_1compute.html#a0051daf1c20b46aeea8a6acb79e1b452">GetCastFunction</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_data_type.html">DataType</a>& in_type, <span class="keyword">const</span> std::shared_ptr<DataType>& to_type,</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">const</span> <a class="code" href="structarrow_1_1compute_1_1_cast_options.html">CastOptions</a>& options, std::unique_ptr<UnaryKernel>* kernel);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> ARROW_EXPORT</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <a class="code" hre f="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1compute.html#a0c6ecafda9e91ce9e19bcb13428f01c7">Cast</a>(<a class="code" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a>* context, <span class="keyword">const</span> <a class="code" href="classarrow_1_1_array.html">Array</a>& value,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> std::shared_ptr<DataType>& to_type, <span class="keyword">const</span> <a class="code" href="structarrow_1_1compute_1_1_cast_options.html">CastOptions</a>& options,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  std::shared_ptr<Array>* out);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> ARROW_EXPORT</div><div class="line"><a name= "l00074"></a><span class="lineno"> 74</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1compute.html#a0c6ecafda9e91ce9e19bcb13428f01c7">Cast</a>(<a class="code" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a>* context, <span class="keyword">const</span> <a class="code" href="structarrow_1_1compute_1_1_datum.html">Datum</a>& value,</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> std::shared_ptr<DataType>& to_type, <span class="keyword">const</span> <a class="code" href="structarrow_1_1compute_1_1_cast_options.html">CastOptions</a>& options,</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="structarrow_1_1compute_1_1_datum.html">Datum</a>* out);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </d iv><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> } <span class="comment">// namespace compute</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#endif // ARROW_COMPUTE_KERNELS_CAST_H</span></div><div class="ttc" id="structarrow_1_1compute_1_1_cast_options_html_acbb8da5a5aeecb1a89392a5dba94ecb7"><div class="ttname"><a href="structarrow_1_1compute_1_1_cast_options.html#acbb8da5a5aeecb1a89392a5dba94ecb7">arrow::compute::CastOptions::allow_int_overflow</a></div><div class="ttdeci">bool allow_int_overflow</div><div class="ttdef"><b>Definition:</b> cast.h:40</div></div> <div class="ttc" id="kernel_8h_html"><div class="ttname"><a href="kernel_8h.html">kernel.h</a></div></div> -<div class="ttc" id="classarrow_1_1compute_1_1_function_context_html"><div class="ttname"><a href="classarrow_1_1compute_1_1_function_context.html">arrow::compute::FunctionContext</a></div><div class="ttdoc">Container for variables and options used by function evaluation. </div><div class="ttdef"><b>Definition:</b> context.h:37</div></div> +<div class="ttc" id="classarrow_1_1compute_1_1_function_context_html"><div class="ttname"><a href="classarrow_1_1compute_1_1_function_context.html">arrow::compute::FunctionContext</a></div><div class="ttdoc">Container for variables and options used by function evaluation. </div><div class="ttdef"><b>Definition:</b> context.h:39</div></div> <div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:106</div></div> <div class="ttc" id="namespacearrow_1_1compute_html_a0c6ecafda9e91ce9e19bcb13428f01c7"><div class="ttname"><a href="namespacearrow_1_1compute.html#a0c6ecafda9e91ce9e19bcb13428f01c7">arrow::compute::Cast</a></div><div class="ttdeci">Status Cast(FunctionContext *context, const Array &value, const std::shared_ptr< DataType > &to_type, const CastOptions &options, std::shared_ptr< Array > *out)</div><div class="ttdoc">Cast from one array type to another. </div></div> <div class="ttc" id="structarrow_1_1compute_1_1_cast_options_html_ae7afd064112db4f0d91dd48ed2b567fd"><div class="ttname"><a href="structarrow_1_1compute_1_1_cast_options.html#ae7afd064112db4f0d91dd48ed2b567fd">arrow::compute::CastOptions::allow_time_truncate</a></div><div class="ttdeci">bool allow_time_truncate</div><div class="ttdef"><b>Definition:</b> cast.h:41</div></div> @@ -80,7 +80,7 @@ $(function() { <div class="ttc" id="structarrow_1_1compute_1_1_datum_html"><div class="ttname"><a href="structarrow_1_1compute_1_1_datum.html">arrow::compute::Datum</a></div><div class="ttdoc">Variant type for various Arrow C++ data structures. </div><div class="ttdef"><b>Definition:</b> kernel.h:52</div></div> <div class="ttc" id="namespacearrow_1_1compute_html_a0051daf1c20b46aeea8a6acb79e1b452"><div class="ttname"><a href="namespacearrow_1_1compute.html#a0051daf1c20b46aeea8a6acb79e1b452">arrow::compute::GetCastFunction</a></div><div class="ttdeci">Status GetCastFunction(const DataType &in_type, const std::shared_ptr< DataType > &to_type, const CastOptions &options, std::unique_ptr< UnaryKernel > *kernel)</div></div> <div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div> -<div class="ttc" id="classarrow_1_1_array_html"><div class="ttname"><a href="classarrow_1_1_array.html">arrow::Array</a></div><div class="ttdoc">Array base type Immutable data array with some logical type and some length. </div><div class="ttdef"><b>Definition:</b> array.h:196</div></div> +<div class="ttc" id="classarrow_1_1_array_html"><div class="ttname"><a href="classarrow_1_1_array.html">arrow::Array</a></div><div class="ttdoc">Array base type Immutable data array with some logical type and some length. </div><div class="ttdef"><b>Definition:</b> array.h:184</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="structarrow_1_1compute_1_1_cast_options_html"><div class="ttname"><a href="structarrow_1_1compute_1_1_cast_options.html">arrow::compute::CastOptions</a></div><div class="ttdef"><b>Definition:</b> cast.h:37</div></div> <div class="ttc" id="structarrow_1_1compute_1_1_cast_options_html_a926af2b39ebb3494a447987f5255350e"><div class="ttname"><a href="structarrow_1_1compute_1_1_cast_options.html#a926af2b39ebb3494a447987f5255350e">arrow::compute::CastOptions::CastOptions</a></div><div class="ttdeci">CastOptions()</div><div class="ttdef"><b>Definition:</b> cast.h:38</div></div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_adaptive_int_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_adaptive_int_builder.html b/docs/cpp/classarrow_1_1_adaptive_int_builder.html index 5ad77bc..67ad9b9 100644 --- a/docs/cpp/classarrow_1_1_adaptive_int_builder.html +++ b/docs/cpp/classarrow_1_1_adaptive_int_builder.html @@ -367,7 +367,7 @@ template<typename new_type > </div> </div><div class="memdoc"> <p>Return result of builder as an internal generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object. </p> -<p>Resets builder</p> +<p>Resets builder except for dictionary builder</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the finalized <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object </td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_adaptive_u_int_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_adaptive_u_int_builder.html b/docs/cpp/classarrow_1_1_adaptive_u_int_builder.html index 4b16595..9083a79 100644 --- a/docs/cpp/classarrow_1_1_adaptive_u_int_builder.html +++ b/docs/cpp/classarrow_1_1_adaptive_u_int_builder.html @@ -367,7 +367,7 @@ template<typename new_type > </div> </div><div class="memdoc"> <p>Return result of builder as an internal generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object. </p> -<p>Resets builder</p> +<p>Resets builder except for dictionary builder</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the finalized <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object </td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_array.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_array.html b/docs/cpp/classarrow_1_1_array.html index 57a06a5..abf06a6 100644 --- a/docs/cpp/classarrow_1_1_array.html +++ b/docs/cpp/classarrow_1_1_array.html @@ -126,7 +126,7 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a155d9d827415438f976e3cb31e0a55f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a155d9d827415438f976e3cb31e0a55f6">type_id</a> () const</td></tr> <tr class="separator:a155d9d827415438f976e3cb31e0a55f6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a76c4756ac85b29f9135064d68d2ef908"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">null_bitmap</a> () const</td></tr> -<tr class="memdesc:a76c4756ac85b29f9135064d68d2ef908"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> for the null bitmap. <a href="#a76c4756ac85b29f9135064d68d2ef908">More...</a><br /></td></tr> +<tr class="memdesc:a76c4756ac85b29f9135064d68d2ef908"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classarrow_1_1_buffer.html" title="Object containing a pointer to a piece of contiguous memory with a particular size. ">Buffer</a> for the null bitmap. <a href="#a76c4756ac85b29f9135064d68d2ef908">More...</a><br /></td></tr> <tr class="separator:a76c4756ac85b29f9135064d68d2ef908"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7a8838fbc97b9b3b8ca15cb163b2027c"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a7a8838fbc97b9b3b8ca15cb163b2027c">null_bitmap_data</a> () const</td></tr> <tr class="memdesc:a7a8838fbc97b9b3b8ca15cb163b2027c"><td class="mdescLeft"> </td><td class="mdescRight">Raw pointer to the null bitmap. <a href="#a7a8838fbc97b9b3b8ca15cb163b2027c">More...</a><br /></td></tr> @@ -176,7 +176,7 @@ Protected Attributes</h2></td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> base type Immutable data array with some logical type and some length. </p> -<p>Any memory is owned by the respective <a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> instance (or its parents).</p> +<p>Any memory is owned by the respective <a class="el" href="classarrow_1_1_buffer.html" title="Object containing a pointer to a piece of contiguous memory with a particular size. ">Buffer</a> instance (or its parents).</p> <p>The base class is only required to have a null bitmap buffer if the null count is greater than 0</p> <p>If known, the null count can be provided in the base <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> constructor. If the null count is not known, pass -1 to indicate that the null count is to be computed on the first call to <a class="el" href="classarrow_1_1_array.html#a0537d3b69a889b951e88be2fe9f3d96a" title="The number of null entries in the array. ">null_count()</a> </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> @@ -453,7 +453,7 @@ Protected Attributes</h2></td></tr> </table> </div><div class="memdoc"> -<p><a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> for the null bitmap. </p> +<p><a class="el" href="classarrow_1_1_buffer.html" title="Object containing a pointer to a piece of contiguous memory with a particular size. ">Buffer</a> for the null bitmap. </p> <p>Note that for <code>null_count == 0</code>, this can be null. This buffer does not account for any slice offset </p> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_array_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_array_builder.html b/docs/cpp/classarrow_1_1_array_builder.html index c210ea6..436175f 100644 --- a/docs/cpp/classarrow_1_1_array_builder.html +++ b/docs/cpp/classarrow_1_1_array_builder.html @@ -88,7 +88,7 @@ Inheritance diagram for arrow::ArrayBuilder:</div> <map id="arrow::ArrayBuilder_map" name="arrow::ArrayBuilder_map"> <area href="classarrow_1_1_binary_builder.html" title="Builder class for variable-length binary data. " alt="arrow::BinaryBuilder" shape="rect" coords="248,56,486,80"/> <area href="classarrow_1_1_boolean_builder.html" alt="arrow::BooleanBuilder" shape="rect" coords="248,112,486,136"/> -<area href="classarrow_1_1_dictionary_builder.html" title="Array builder for created encoded DictionaryArray from dense array data. " alt="arrow::DictionaryBuilder< T >" shape="rect" coords="248,168,486,192"/> +<area href="classarrow_1_1_dictionary_builder.html" title="Array builder for created encoded DictionaryArray from dense array. " alt="arrow::DictionaryBuilder< T >" shape="rect" coords="248,168,486,192"/> <area href="classarrow_1_1_dictionary_builder_3_01_null_type_01_4.html" alt="arrow::DictionaryBuilder< NullType >" shape="rect" coords="248,224,486,248"/> <area href="classarrow_1_1_fixed_size_binary_builder.html" alt="arrow::FixedSizeBinaryBuilder" shape="rect" coords="248,280,486,304"/> <area href="classarrow_1_1_list_builder.html" title="Builder class for variable-length list array value types. " alt="arrow::ListBuilder" shape="rect" coords="248,392,486,416"/> @@ -418,7 +418,7 @@ Protected Attributes</h2></td></tr> </div><div class="memdoc"> <p>Return result of builder as an <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> object. </p> -<p>Resets builder</p> +<p>Resets the builder except for <a class="el" href="classarrow_1_1_dictionary_builder.html" title="Array builder for created encoded DictionaryArray from dense array. ">DictionaryBuilder</a></p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the finalized <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> object </td></tr> @@ -454,7 +454,7 @@ Protected Attributes</h2></td></tr> </div><div class="memdoc"> <p>Return result of builder as an internal generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object. </p> -<p>Resets builder</p> +<p>Resets builder except for dictionary builder</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the finalized <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object </td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_binary_array.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_binary_array.html b/docs/cpp/classarrow_1_1_binary_array.html index 4de26a9..dbc18d3 100644 --- a/docs/cpp/classarrow_1_1_binary_array.html +++ b/docs/cpp/classarrow_1_1_binary_array.html @@ -141,7 +141,7 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a155d9d827415438f976e3cb31e0a55f6 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a155d9d827415438f976e3cb31e0a55f6">type_id</a> () const</td></tr> <tr class="separator:a155d9d827415438f976e3cb31e0a55f6 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">null_bitmap</a> () const</td></tr> -<tr class="memdesc:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> for the null bitmap. <a href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">More...</a><br /></td></tr> +<tr class="memdesc:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classarrow_1_1_buffer.html" title="Object containing a pointer to a piece of contiguous memory with a particular size. ">Buffer</a> for the null bitmap. <a href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">More...</a><br /></td></tr> <tr class="separator:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7a8838fbc97b9b3b8ca15cb163b2027c inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a7a8838fbc97b9b3b8ca15cb163b2027c">null_bitmap_data</a> () const</td></tr> <tr class="memdesc:a7a8838fbc97b9b3b8ca15cb163b2027c inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight">Raw pointer to the null bitmap. <a href="classarrow_1_1_array.html#a7a8838fbc97b9b3b8ca15cb163b2027c">More...</a><br /></td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_binary_builder-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_binary_builder-members.html b/docs/cpp/classarrow_1_1_binary_builder-members.html index ee9c58f..ff77a9f 100644 --- a/docs/cpp/classarrow_1_1_binary_builder-members.html +++ b/docs/cpp/classarrow_1_1_binary_builder-members.html @@ -93,18 +93,18 @@ $(function() { <tr><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#a13caa5ab30a6b60c95bc37c10ec6010b">FinishInternal</a>(std::shared_ptr< ArrayData > *out) override</td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#abdb85ad459c436c2a91cc709b361c190">GetValue</a>(int64_t i, int32_t *out_length) const</td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#adda875540f916d83bc931e1254eba95b">Init</a>(int64_t elements) override</td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#aff5c15c1cc766da35995e85a50322571">kMaximumCapacity</a></td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">static</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a296ac75b9b3d877192e37681c66513ba">length</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#ae8b7ebc042e6684440bd9e1c77f0f5c1">length_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a1ebef9199b1e209d1e27debff6068e2f">null_bitmap</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a030598b8cf748d469a1faed173237db1">null_bitmap_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a03476f9edb6a8fb48854ba7ecc785fa7">null_bitmap_data_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aad098f61890072a4576867a7cf4fb9ee">null_count</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a9ea96ba4121857ab23241b6b408051b9">null_count_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aa829b8339092408c9d710cc2c1bdc46a">num_children</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#a25e78f8e1f3678f61d54ae3148ab45a1">offsets_builder_</a></td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a33e3aa20cedda9f6d8581809437f1c86">pool_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a177b858a7ef7ee0ac316ca626bb3bf21">Reserve</a>(int64_t elements)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a296ac75b9b3d877192e37681c66513ba">length</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#ae8b7ebc042e6684440bd9e1c77f0f5c1">length_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a1ebef9199b1e209d1e27debff6068e2f">null_bitmap</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a030598b8cf748d469a1faed173237db1">null_bitmap_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a03476f9edb6a8fb48854ba7ecc785fa7">null_bitmap_data_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aad098f61890072a4576867a7cf4fb9ee">null_count</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a9ea96ba4121857ab23241b6b408051b9">null_count_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aa829b8339092408c9d710cc2c1bdc46a">num_children</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#a25e78f8e1f3678f61d54ae3148ab45a1">offsets_builder_</a></td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a33e3aa20cedda9f6d8581809437f1c86">pool_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a177b858a7ef7ee0ac316ca626bb3bf21">Reserve</a>(int64_t elements)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#ab5bda581f3a741a34241f9ad0f97c2c6">ReserveData</a>(int64_t elements)</td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#ae49b062fbb8f24e2bba1f7f90fa266b7">Reset</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#aaa2e0651e2d191fd6248c843f4429a1d">Resize</a>(int64_t capacity) override</td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aa505ec95646314c3b9254e0cce39538b">SetNotNull</a>(int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"></td></tr> @@ -115,8 +115,9 @@ $(function() { <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a361c8efe3030a75126cbbbe90e9a3ee4">UnsafeAppendToBitmap</a>(const std::vector< bool > &is_valid)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aa0a2125633a3cdb1860d3f62d44ac4a1">UnsafeSetNotNull</a>(int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#adca4b2a7142b3c57f805cb1ec6686601">value_data_builder_</a></td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#a1da67af983ae5c78810d48d8d3e92b36">value_data_length</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a74bb29b347e12ed7528925d12db109a7">~ArrayBuilder</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#a56180c6e8fec7abd91a16aedd3015412">value_data_capacity</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html#a1da67af983ae5c78810d48d8d3e92b36">value_data_length</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a74bb29b347e12ed7528925d12db109a7">~ArrayBuilder</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> </table></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_binary_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_binary_builder.html b/docs/cpp/classarrow_1_1_binary_builder.html index 810ceac..bfa1323 100644 --- a/docs/cpp/classarrow_1_1_binary_builder.html +++ b/docs/cpp/classarrow_1_1_binary_builder.html @@ -70,7 +70,6 @@ $(function() { <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | -<a href="#pro-static-attribs">Static Protected Attributes</a> | <a href="classarrow_1_1_binary_builder-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">arrow::BinaryBuilder Class Reference</div> </div> @@ -112,11 +111,16 @@ Public Member Functions</h2></td></tr> <tr class="memitem:aaa2e0651e2d191fd6248c843f4429a1d"><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="classarrow_1_1_binary_builder.html#aaa2e0651e2d191fd6248c843f4429a1d">Resize</a> (int64_t <a class="el" href="classarrow_1_1_array_builder.html#a0236e815af8f62c98bd612eea219cd73">capacity</a>) override</td></tr> <tr class="memdesc:aaa2e0651e2d191fd6248c843f4429a1d"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the null_bitmap array. <a href="#aaa2e0651e2d191fd6248c843f4429a1d">More...</a><br /></td></tr> <tr class="separator:aaa2e0651e2d191fd6248c843f4429a1d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab5bda581f3a741a34241f9ad0f97c2c6"><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="classarrow_1_1_binary_builder.html#ab5bda581f3a741a34241f9ad0f97c2c6">ReserveData</a> (int64_t elements)</td></tr> +<tr class="memdesc:ab5bda581f3a741a34241f9ad0f97c2c6"><td class="mdescLeft"> </td><td class="mdescRight">Ensures there is enough allocated capacity to append the indicated number of bytes to the value data buffer without additional allocations. <a href="#ab5bda581f3a741a34241f9ad0f97c2c6">More...</a><br /></td></tr> +<tr class="separator:ab5bda581f3a741a34241f9ad0f97c2c6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a13caa5ab30a6b60c95bc37c10ec6010b"><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="classarrow_1_1_binary_builder.html#a13caa5ab30a6b60c95bc37c10ec6010b">FinishInternal</a> (std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > *out) override</td></tr> <tr class="memdesc:a13caa5ab30a6b60c95bc37c10ec6010b"><td class="mdescLeft"> </td><td class="mdescRight">Return result of builder as an internal generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object. <a href="#a13caa5ab30a6b60c95bc37c10ec6010b">More...</a><br /></td></tr> <tr class="separator:a13caa5ab30a6b60c95bc37c10ec6010b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1da67af983ae5c78810d48d8d3e92b36"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_binary_builder.html#a1da67af983ae5c78810d48d8d3e92b36">value_data_length</a> () const</td></tr> <tr class="separator:a1da67af983ae5c78810d48d8d3e92b36"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a56180c6e8fec7abd91a16aedd3015412"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_binary_builder.html#a56180c6e8fec7abd91a16aedd3015412">value_data_capacity</a> () const</td></tr> +<tr class="separator:a56180c6e8fec7abd91a16aedd3015412"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abdb85ad459c436c2a91cc709b361c190"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_binary_builder.html#abdb85ad459c436c2a91cc709b361c190">GetValue</a> (int64_t i, int32_t *out_length) const</td></tr> <tr class="memdesc:abdb85ad459c436c2a91cc709b361c190"><td class="mdescLeft"> </td><td class="mdescRight">Temporary access to a value. <a href="#abdb85ad459c436c2a91cc709b361c190">More...</a><br /></td></tr> <tr class="separator:abdb85ad459c436c2a91cc709b361c190"><td class="memSeparator" colspan="2"> </td></tr> @@ -202,11 +206,6 @@ Protected Attributes</h2></td></tr> <tr class="separator:aeb92737fe5ada5b372459705c1690d7e inherit pro_attribs_classarrow_1_1_array_builder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9b2ede82de7d728f80eaa17ac8f7327d inherit pro_attribs_classarrow_1_1_array_builder"><td class="memItemLeft" align="right" valign="top">std::vector< std::unique_ptr< <a class="el" href="classarrow_1_1_array_builder.html">ArrayBuilder</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array_builder.html#a9b2ede82de7d728f80eaa17ac8f7327d">children_</a></td></tr> <tr class="separator:a9b2ede82de7d728f80eaa17ac8f7327d inherit pro_attribs_classarrow_1_1_array_builder"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a> -Static Protected Attributes</h2></td></tr> -<tr class="memitem:aff5c15c1cc766da35995e85a50322571"><td class="memItemLeft" align="right" valign="top">static constexpr int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_binary_builder.html#aff5c15c1cc766da35995e85a50322571">kMaximumCapacity</a> = std::numeric_limits<int32_t>::max() - 1</td></tr> -<tr class="separator:aff5c15c1cc766da35995e85a50322571"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Builder class for variable-length binary data. </p> @@ -423,7 +422,7 @@ Static Protected Attributes</h2></td></tr> </div><div class="memdoc"> <p>Return result of builder as an internal generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object. </p> -<p>Resets builder</p> +<p>Resets builder except for dictionary builder</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the finalized <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object </td></tr> @@ -498,6 +497,26 @@ Static Protected Attributes</h2></td></tr> </div> </div> +<a id="ab5bda581f3a741a34241f9ad0f97c2c6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab5bda581f3a741a34241f9ad0f97c2c6">◆ </a></span>ReserveData()</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::BinaryBuilder::ReserveData </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>elements</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Ensures there is enough allocated capacity to append the indicated number of bytes to the value data buffer without additional allocations. </p> + +</div> +</div> <a id="ae49b062fbb8f24e2bba1f7f90fa266b7"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae49b062fbb8f24e2bba1f7f90fa266b7">◆ </a></span>Reset()</h2> @@ -554,8 +573,8 @@ Static Protected Attributes</h2></td></tr> </div> </div> -<a id="a1da67af983ae5c78810d48d8d3e92b36"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a1da67af983ae5c78810d48d8d3e92b36">◆ </a></span>value_data_length()</h2> +<a id="a56180c6e8fec7abd91a16aedd3015412"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a56180c6e8fec7abd91a16aedd3015412">◆ </a></span>value_data_capacity()</h2> <div class="memitem"> <div class="memproto"> @@ -564,7 +583,7 @@ Static Protected Attributes</h2></td></tr> <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">int64_t arrow::BinaryBuilder::value_data_length </td> + <td class="memname">int64_t arrow::BinaryBuilder::value_data_capacity </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> @@ -576,13 +595,12 @@ Static Protected Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<dl class="section return"><dt>Returns</dt><dd>size of values buffer so far </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>capacity of values buffer </dd></dl> </div> </div> -<h2 class="groupheader">Member Data Documentation</h2> -<a id="aff5c15c1cc766da35995e85a50322571"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aff5c15c1cc766da35995e85a50322571">◆ </a></span>kMaximumCapacity</h2> +<a id="a1da67af983ae5c78810d48d8d3e92b36"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1da67af983ae5c78810d48d8d3e92b36">◆ </a></span>value_data_length()</h2> <div class="memitem"> <div class="memproto"> @@ -591,18 +609,23 @@ Static Protected Attributes</h2></td></tr> <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">constexpr int64_t arrow::BinaryBuilder::kMaximumCapacity = std::numeric_limits<int32_t>::max() - 1</td> + <td class="memname">int64_t arrow::BinaryBuilder::value_data_length </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> </tr> </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>size of values buffer so far </dd></dl> </div> </div> +<h2 class="groupheader">Member Data Documentation</h2> <a id="a25e78f8e1f3678f61d54ae3148ab45a1"></a> <h2 class="memtitle"><span class="permalink"><a href="#a25e78f8e1f3678f61d54ae3148ab45a1">◆ </a></span>offsets_builder_</h2>
