http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/compare_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/compare_8h_source.html b/docs/cpp/compare_8h_source.html index 08f8bee..f9a152e 100644 --- a/docs/cpp/compare_8h_source.html +++ b/docs/cpp/compare_8h_source.html @@ -70,13 +70,13 @@ $(function() { <div class="title">compare.h</div> </div> </div><!--header--> <div class="contents"> -<a href="compare_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 distributed u nder 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 comparing Arrow data structures</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_COMPARE_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_COMPARE_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> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>& #160;<span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span>Array;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>DataType;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>Tensor;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef ARROW_NO_DEPRECATED_API</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span > Status ARROW_EXPORT <a class="code" >href="namespacearrow.html#a8753654b0dc794946d5205aa30fa54c6">ArrayEquals</a>(<span > class="keyword">const</span> Array& left, <span >class="keyword">const</span> Array& right, <span >class="keywordtype">bool</span>* are_equal);</div><div class="line"><a >name="l00038"></a><span class="lineno"> 38</span> </div><div >class="line"><a name="l00040"></a><span class="lineno"> >40</span> Status ARROW_EXPORT <a class="code" >href="namespacearrow.html#a94b24ab7fc29a4ccfd9035f008e6e7e9">TensorEquals</a>(<span > class="keyword">const</span> Tensor& left, <span >class="keyword">const</span> Tensor& right,</div><div class="line"><a >name="l00041"></a><span class="lineno"> 41</span>  > <span class="keywordtype">bool</span>* are_equal);</div><div >class="line"><a name="l00042"></a><span class="lineno"> >42</span> </div><div class="line"><a name="l00046"></a><span >class="lineno"> 46</span>  ;Status ARROW_EXPORT <a class="code" href="namespacearrow.html#aefba3083236a8c610ba6e47b1e8f077f">ArrayApproxEquals</a>(<span class="keyword">const</span> Array& left, <span class="keyword">const</span> Array& right,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">bool</span>* are_equal);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> Status ARROW_EXPORT <a class="code" href="namespacearrow.html#a6f9150ffb3b41c37044eea962e0e0845">ArrayRangeEquals</a>(<span class="keyword">const</span> Array& left, <span class="keyword">const</span> Array& right,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  int64_t start_idx, int64_t end_idx,</div><div class="line"><a name="l00053"></a><span clas s="lineno"> 53</span>  int64_t other_start_idx, <span class="keywordtype">bool</span>* are_equal);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> Status ARROW_EXPORT <a class="code" href="namespacearrow.html#a73533bccd4b4e0d9ddb068f2b4876ded">TypeEquals</a>(<span class="keyword">const</span> DataType& left, <span class="keyword">const</span> DataType& right,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">bool</span>* are_equal);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span cla ss="keywordtype">bool</span> ARROW_EXPORT <a class="code" href="namespacearrow.html#a8753654b0dc794946d5205aa30fa54c6">ArrayEquals</a>(<span class="keyword">const</span> Array& left, <span class="keyword">const</span> Array& right);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">bool</span> ARROW_EXPORT <a class="code" href="namespacearrow.html#a94b24ab7fc29a4ccfd9035f008e6e7e9">TensorEquals</a>(<span class="keyword">const</span> Tensor& left, <span class="keyword">const</span> Tensor& right);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">bool</span> ARROW_EXPORT <a class="code" href="namespacearrow.html#aefba3083236a8c610ba6e47b1e8f077f">ArrayApproxEquals</a>(<span class="keywor d">const</span> Array& left, <span class="keyword">const</span> Array& right);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keywordtype">bool</span> ARROW_EXPORT <a class="code" href="namespacearrow.html#a6f9150ffb3b41c37044eea962e0e0845">ArrayRangeEquals</a>(<span class="keyword">const</span> Array& left, <span class="keyword">const</span> Array& right,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  int64_t start_idx, int64_t end_idx,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  int64_t other_start_idx);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype ">bool</span> ARROW_EXPORT <a class="code" href="namespacearrow.html#a73533bccd4b4e0d9ddb068f2b4876ded">TypeEquals</a>(<span class="keyword">const</span> DataType& left, <span class="keyword">const</span> DataType& right);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> } <span class="comment">// namespace arrow</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="preprocessor">#endif // ARROW_COMPARE_H</span></div><div class="ttc" id="namespacearrow_html_a73533bccd4b4e0d9ddb068f2b4876ded"><div class="ttname"><a href="namespacearrow.html#a73533bccd4b4e0d9ddb068f2b4876ded">arrow::TypeEquals</a></div><div class="ttdeci">Status TypeEquals(const DataType &left, const DataType &right, bool *are_equal)</div><div class="ttd oc">Returns true if the type metadata are exactly equal. </div></div> -<div class="ttc" id="namespacearrow_html_aefba3083236a8c610ba6e47b1e8f077f"><div class="ttname"><a href="namespacearrow.html#aefba3083236a8c610ba6e47b1e8f077f">arrow::ArrayApproxEquals</a></div><div class="ttdeci">Status ArrayApproxEquals(const Array &left, const Array &right, bool *are_equal)</div><div class="ttdoc">Returns true if the arrays are approximately equal. </div></div> +<a href="compare_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 distributed u nder 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 comparing Arrow data structures</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_COMPARE_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_COMPARE_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> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>& #160;<span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span>Array;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>DataType;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>Tensor;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">bool</span> ARROW_EXPORT <a class="code" href="namespacearrow.html#a48cc628afeb953d5acb013f89d82b54e">ArrayEquals</a >(<span class="keyword">const</span> Array& left, <span >class="keyword">const</span> Array& right);</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="keywordtype">bool</span> ARROW_EXPORT <a >class="code" >href="namespacearrow.html#a417a6eae2db5c774057fd4f6adce5700">TensorEquals</a>(<span > class="keyword">const</span> Tensor& left, <span >class="keyword">const</span> Tensor& right);</div><div class="line"><a >name="l00038"></a><span class="lineno"> 38</span> </div><div >class="line"><a name="l00041"></a><span class="lineno"> >41</span> <span class="keywordtype">bool</span> ARROW_EXPORT <a >class="code" >href="namespacearrow.html#ab018fcebde82b4d98fb4cd19a477813e">ArrayApproxEquals</a>(<span > class="keyword">const</span> Array& left, <span >class="keyword">const</span> Array& right);</div><div class="line"><a >name="l00042"></a><s pan class="lineno"> 42</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">bool</span> ARROW_EXPORT <a class="code" href="namespacearrow.html#a1d4576fdd48ce9e8484b30e3b94fd00d">ArrayRangeEquals</a>(<span class="keyword">const</span> Array& left, <span class="keyword">const</span> Array& right,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  int64_t start_idx, int64_t end_idx,</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  int64_t other_start_idx);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">bool</span> ARROW_EXPORT <a class="code" href="namespacearrow.html#a143d6d46b882b0cc100584b69283d07e">TypeEquals</a>(<span class="k eyword">const</span> DataType& left, <span class="keyword">const</span> DataType& right);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#endif // ARROW_COMPARE_H</span></div><div class="ttc" id="namespacearrow_html_ab018fcebde82b4d98fb4cd19a477813e"><div class="ttname"><a href="namespacearrow.html#ab018fcebde82b4d98fb4cd19a477813e">arrow::ArrayApproxEquals</a></div><div class="ttdeci">bool ArrayApproxEquals(const Array &left, const Array &right)</div><div class="ttdoc">Returns true if the arrays are approximately equal. </div></div> +<div class="ttc" id="namespacearrow_html_a143d6d46b882b0cc100584b69283d07e"><div class="ttname"><a href="namespacearrow.html#a143d6d46b882b0cc100584b69283d07e">arrow::TypeEquals</a></div><div class="ttdeci">bool TypeEquals(const DataType &left, const DataType &right)</div><div class="ttdoc">Returns true if the type metadata are exactly equal. </div></div> +<div class="ttc" id="namespacearrow_html_a48cc628afeb953d5acb013f89d82b54e"><div class="ttname"><a href="namespacearrow.html#a48cc628afeb953d5acb013f89d82b54e">arrow::ArrayEquals</a></div><div class="ttdeci">bool ArrayEquals(const Array &left, const Array &right)</div><div class="ttdoc">Returns true if the arrays are exactly equal. </div></div> <div class="ttc" id="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div> -<div class="ttc" id="namespacearrow_html_a8753654b0dc794946d5205aa30fa54c6"><div class="ttname"><a href="namespacearrow.html#a8753654b0dc794946d5205aa30fa54c6">arrow::ArrayEquals</a></div><div class="ttdeci">Status ArrayEquals(const Array &left, const Array &right, bool *are_equal)</div><div class="ttdoc">Returns true if the arrays are exactly equal. </div></div> <div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div> -<div class="ttc" id="namespacearrow_html_a6f9150ffb3b41c37044eea962e0e0845"><div class="ttname"><a href="namespacearrow.html#a6f9150ffb3b41c37044eea962e0e0845">arrow::ArrayRangeEquals</a></div><div class="ttdeci">Status ArrayRangeEquals(const Array &left, const Array &right, int64_t start_idx, int64_t end_idx, int64_t other_start_idx, bool *are_equal)</div><div class="ttdoc">Returns true if indicated equal-length segment of arrays is exactly equal. </div></div> -<div class="ttc" id="namespacearrow_html_a94b24ab7fc29a4ccfd9035f008e6e7e9"><div class="ttname"><a href="namespacearrow.html#a94b24ab7fc29a4ccfd9035f008e6e7e9">arrow::TensorEquals</a></div><div class="ttdeci">Status TensorEquals(const Tensor &left, const Tensor &right, bool *are_equal)</div></div> +<div class="ttc" id="namespacearrow_html_a1d4576fdd48ce9e8484b30e3b94fd00d"><div class="ttname"><a href="namespacearrow.html#a1d4576fdd48ce9e8484b30e3b94fd00d">arrow::ArrayRangeEquals</a></div><div class="ttdeci">bool ArrayRangeEquals(const Array &left, const Array &right, int64_t start_idx, int64_t end_idx, int64_t other_start_idx)</div><div class="ttdoc">Returns true if indicated equal-length segment of arrays is exactly equal. </div></div> +<div class="ttc" id="namespacearrow_html_a417a6eae2db5c774057fd4f6adce5700"><div class="ttname"><a href="namespacearrow.html#a417a6eae2db5c774057fd4f6adce5700">arrow::TensorEquals</a></div><div class="ttdeci">bool TensorEquals(const Tensor &left, const Tensor &right)</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/compression__zlib_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/compression__zlib_8h_source.html b/docs/cpp/compression__zlib_8h_source.html index f9e1167..99ab989 100644 --- a/docs/cpp/compression__zlib_8h_source.html +++ b/docs/cpp/compression__zlib_8h_source.html @@ -70,7 +70,7 @@ $(function() { <div class="title">compression_zlib.h</div> </div> </div><!--header--> <div class="contents"> -<a href="compression__zlib_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a>< span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software dis tributed under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_UTIL_COMPRESSION_ZLIB_H</span></div><div class="line"><a name="l00019"></a>< span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_UTIL_COMPRESSION_ZLIB_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 <cstdint></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <memory></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="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="compression_8h.html">arrow/util/compression.h</a>"</span></div><div class="line"><a name= "l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.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="comment">// GZip codec.</span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classarrow_1_1_g_zip_codec.html"> 31</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1_g_zip_codec.html">GZipCodec</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1_codec.html">Co dec</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621"> 34</a></span>  <span class="keyword">enum</span> <a class="code" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621">Format</a> {</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621a384a14553b129930bb7850ab6f4c8ad7"> 35</a></span>  <a class="code" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621a384a14553b129930bb7850ab6f4c8ad7">ZLIB</a>,</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621ad0ccb2b0bf797c855bd687d307d03735"> 36</a></span> 0; <a class="code" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621ad0ccb2b0bf797c855bd687d307d03735">DEFLATE</a>,</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621ac1bfd1339393d6ef8b43a58e7b521879"> 37</a></span>  <a class="code" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621ac1bfd1339393d6ef8b43a58e7b521879">GZIP</a>,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  };</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1_g_zip_codec.html">GZipCodec</a>(Format format = GZIP);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">virtual</span> ~< a class="code" href="classarrow_1_1_g_zip_codec.html">GZipCodec</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>  <a class="code" href="classarrow_1_1_status.html">Status</a> Decompress(int64_t input_len, <span class="keyword">const</span> uint8_t* input, int64_t output_len,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  uint8_t* output_buffer) <span class="keyword">override</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Compress(int64_t input_len, <span class="keyword">const</span> uint8_t* input, int64_t output_buffer_len,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  uint8_t* output_buffer, int64_t* output_length) <span class="keyword">override</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  int64_t MaxCompressedLen(int64_t input_len, <span class="keyword">const</span> uint8_t* input) <span class="keyword">override</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* name() <span class="keyword">const override</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class=" comment">// The gzip compressor is stateful</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">class </span>GZipCodecImpl;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::unique_ptr<GZipCodecImpl> impl_;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <span class="comment">// namespace arrow</span></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="preprocessor">#endif // ARROW_UTIL_COMPRESSION_ZLIB_H</span></div><div class="ttc" id="compression_8h_html"><div class="ttname"><a href="compression_8h.html">compression.h</a></div></div> +<a href="compression__zlib_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a>< span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software dis tributed under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_UTIL_COMPRESSION_ZLIB_H</span></div><div class="line"><a name="l00019"></a>< span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_UTIL_COMPRESSION_ZLIB_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 <cstdint></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <memory></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="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="compression_8h.html">arrow/util/compression.h</a>"</span></div><div class="line"><a name= "l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.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="comment">// GZip codec.</span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classarrow_1_1_g_zip_codec.html"> 31</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1_g_zip_codec.html">GZipCodec</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1_codec.html">Co dec</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621"> 34</a></span>  <span class="keyword">enum</span> <a class="code" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621">Format</a> {</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621a384a14553b129930bb7850ab6f4c8ad7"> 35</a></span>  <a class="code" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621a384a14553b129930bb7850ab6f4c8ad7">ZLIB</a>,</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621ad0ccb2b0bf797c855bd687d307d03735"> 36</a></span> 0; <a class="code" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621ad0ccb2b0bf797c855bd687d307d03735">DEFLATE</a>,</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621ac1bfd1339393d6ef8b43a58e7b521879"> 37</a></span>  <a class="code" href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621ac1bfd1339393d6ef8b43a58e7b521879">GZIP</a>,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  };</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1_g_zip_codec.html">GZipCodec</a>(Format format = GZIP);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  ~<a class="code" href="classarrow_1_1_g _zip_codec.html">GZipCodec</a>() <span class="keyword">override</span>;</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>  <a class="code" href="classarrow_1_1_status.html">Status</a> Decompress(int64_t input_len, <span class="keyword">const</span> uint8_t* input, int64_t output_len,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  uint8_t* output_buffer) <span class="keyword">override</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Compress(int64_t input_len, <span class="keyword">const</span> uint8_t* input, int64_t output_buffer_len,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  uint8_t* output_buffer, int64_t* output_length) <span class="keyword">override</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  int64_t MaxCompressedLen(int64_t input_len, <span class="keyword">const</span> uint8_t* input) <span class="keyword">override</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* name() <span class="keyword">const override</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class= "comment">// The gzip compressor is stateful</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">class </span>GZipCodecImpl;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::unique_ptr<GZipCodecImpl> impl_;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <span class="comment">// namespace arrow</span></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="preprocessor">#endif // ARROW_UTIL_COMPRESSION_ZLIB_H</span></div><div class="ttc" id="compression_8h_html"><div class="ttname"><a href="compression_8h.html">compression.h</a></div></div> <div class="ttc" id="classarrow_1_1_g_zip_codec_html_a61e80e6eb225c4f17a5d6e9cd4ce1621ad0ccb2b0bf797c855bd687d307d03735"><div class="ttname"><a href="classarrow_1_1_g_zip_codec.html#a61e80e6eb225c4f17a5d6e9cd4ce1621ad0ccb2b0bf797c855bd687d307d03735">arrow::GZipCodec::DEFLATE</a></div><div class="ttdef"><b>Definition:</b> compression_zlib.h:36</div></div> <div class="ttc" id="classarrow_1_1_g_zip_codec_html"><div class="ttname"><a href="classarrow_1_1_g_zip_codec.html">arrow::GZipCodec</a></div><div class="ttdef"><b>Definition:</b> compression_zlib.h:31</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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/compute_2kernels_2hash_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/compute_2kernels_2hash_8h_source.html b/docs/cpp/compute_2kernels_2hash_8h_source.html index b132e6a..4674dad 100644 --- a/docs/cpp/compute_2kernels_2hash_8h_source.html +++ b/docs/cpp/compute_2kernels_2hash_8h_source.html @@ -73,7 +73,7 @@ $(function() { <a href="compute_2kernels_2hash_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">// softwar e distributed under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_COMPUTE_KERNELS_HASH_H</span></div><div class="line"><a name="l00019">< /a><span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_COMPUTE_KERNELS_HASH_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> <span class="preprocessor">#include <vector></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="kernel_8h.html">arrow/compute/kernel.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l000 26"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">arrow/type_fwd.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span>compute {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>FunctionContext;</div><div cla ss="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classarrow_1_1compute_1_1_hash_kernel.html"> 36</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1compute_1_1_hash_kernel.html">HashKernel</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1compute_1_1_unary_kernel.html">UnaryKernel</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Append(<a class="code" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a>* ctx, <span class="keyword">const</span> <a class="code" href="structarrow_1_1_array_data.html">ArrayData</a>& inpu t) = 0;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Flush(<a class="code" href="structarrow_1_1compute_1_1_datum.html">Datum</a>* out) = 0;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Status</a> GetDictionary(std::shared_ptr<ArrayData>* out) = 0;</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> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> ARROW_EXPORT</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1compute.html#a4872fa6dfd423 ccd7581d615b74ffa1a">GetUniqueKernel</a>(<a class="code" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a>* ctx, <span class="keyword">const</span> std::shared_ptr<DataType>& type,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  std::unique_ptr<HashKernel>* kernel);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> ARROW_EXPORT</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1compute.html#a1373e37ca6f1568d8dfa7bd14cfc0541">GetDictionaryEncodeKernel</a>(<a class="code" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a>* ctx,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">const</span> std::shared_ptr<DataType>& type,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  std::unique_ptr<HashKernel>* kernel);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> ARROW_EXPORT</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1compute.html#a9d011093aecc73991bc11f65c4d0acb2">Unique</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>& datum, std::shared_ptr<Array>* out);</div><div class="line"><a name="l00063"></a><span class=" lineno"> 63</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> ARROW_EXPORT</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1compute.html#abb320b25453cee69ed5c8048bd0e0df4">DictionaryEncode</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>& data, <a class="code" href="structarrow_1_1compute_1_1_datum.html">Datum</a>* out);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// TODO(wesm): Define API for incremental dictionary encoding</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="comment">// TODO(wesm): Define API for regularizing DictionaryArray objects with</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// different dictionaries</span></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">// class DictionaryEncoder {</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// public:</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// virtual Encode(const Datum& data, Datum* out) = 0;</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// };</span></div><div class="li ne"><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">//</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// ARROW_EXPORT</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// Status DictionaryEncode(FunctionContext* context, const Datum& data,</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// const Array& prior_dictionary, Datum* out);</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// TODO(wesm): Implement these next</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  ;<span class="comment">// ARROW_EXPORT</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// Status Match(FunctionContext* context, const Datum& values, const Datum& member_set,</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">// Datum* out);</span></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> <span class="comment">// ARROW_EXPORT</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">// Status IsIn(FunctionContext* context, const Datum& values, const Datum& member_set,</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">// Datum* out);</span></div><div class="line"><a name="l00097"></a ><span class="lineno"> 97</span> </div><div class="line"><a >name="l00098"></a><span class="lineno"> 98</span> <span >class="comment">// ARROW_EXPORT</span></div><div class="line"><a >name="l00099"></a><span class="lineno"> 99</span> <span >class="comment">// Status CountValues(FunctionContext* context, const >Datum& values,</span></div><div class="line"><a name="l00100"></a><span >class="lineno"> 100</span> <span class="comment">// >std::shared_ptr<Array>* out_uniques,</span></div><div class="line"><a >name="l00101"></a><span class="lineno"> 101</span> <span >class="comment">// std::shared_ptr<Array>* >out_counts);</span></div><div class="line"><a name="l00102"></a><span >class="lineno"> 102</span> </div><div class="line"><a >name="l00103"></a><span class="lineno"> 103</span> } <span >class="comment">// namespace compute</span></div><div class="line"><a >name="l00104"></a><span class="lineno"> 10 4</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#endif // ARROW_COMPUTE_KERNELS_HASH_H</span></div><div class="ttc" id="namespacearrow_1_1compute_html_a4872fa6dfd423ccd7581d615b74ffa1a"><div class="ttname"><a href="namespacearrow_1_1compute.html#a4872fa6dfd423ccd7581d615b74ffa1a">arrow::compute::GetUniqueKernel</a></div><div class="ttdeci">Status GetUniqueKernel(FunctionContext *ctx, const std::shared_ptr< DataType > &type, std::unique_ptr< HashKernel > *kernel)</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="namespacearrow_1_1compute_html_a9d011093aecc73991bc11f65c4d0acb2"><div class="ttname"><a href="namespacearrow_1_1compute.html#a9d011093aecc73991bc11f65c4d0acb2">arrow::compute::Unique</a></div><div class="ttdeci">Status Unique(FunctionContext *context, const Datum &datum, std::shared_ptr< Array > *out)</div><div class="ttdoc">Compute unique elements from an array-like object. </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="type__fwd_8h_html"><div class="ttname"><a href="type__fwd_8h.html">type_fwd.h</a></div></div> <div class="ttc" id="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div> @@ -81,7 +81,7 @@ $(function() { <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_1compute_1_1_hash_kernel_html"><div class="ttname"><a href="classarrow_1_1compute_1_1_hash_kernel.html">arrow::compute::HashKernel</a></div><div class="ttdoc">Invoke hash table kernel on input array, returning any output values. </div><div class="ttdef"><b>Definition:</b> hash.h:36</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_1_array_data_html"><div class="ttname"><a href="structarrow_1_1_array_data.html">arrow::ArrayData</a></div><div class="ttdoc">Mutable container for generic Arrow array data. </div><div class="ttdef"><b>Definition:</b> array.h:86</div></div> +<div class="ttc" id="structarrow_1_1_array_data_html"><div class="ttname"><a href="structarrow_1_1_array_data.html">arrow::ArrayData</a></div><div class="ttdoc">Mutable container for generic Arrow array data. </div><div class="ttdef"><b>Definition:</b> array.h:87</div></div> <div class="ttc" id="classarrow_1_1compute_1_1_unary_kernel_html"><div class="ttname"><a href="classarrow_1_1compute_1_1_unary_kernel.html">arrow::compute::UnaryKernel</a></div><div class="ttdoc">An array-valued function of a single input argument. </div><div class="ttdef"><b>Definition:</b> kernel.h:133</div></div> <div class="ttc" id="namespacearrow_1_1compute_html_abb320b25453cee69ed5c8048bd0e0df4"><div class="ttname"><a href="namespacearrow_1_1compute.html#abb320b25453cee69ed5c8048bd0e0df4">arrow::compute::DictionaryEncode</a></div><div class="ttdeci">Status DictionaryEncode(FunctionContext *context, const Datum &data, Datum *out)</div><div class="ttdoc">Dictionary-encode values in an array-like object. </div></div> <div class="ttc" id="namespacearrow_1_1compute_html_a1373e37ca6f1568d8dfa7bd14cfc0541"><div class="ttname"><a href="namespacearrow_1_1compute.html#a1373e37ca6f1568d8dfa7bd14cfc0541">arrow::compute::GetDictionaryEncodeKernel</a></div><div class="ttdeci">Status GetDictionaryEncodeKernel(FunctionContext *ctx, const std::shared_ptr< DataType > &type, std::unique_ptr< HashKernel > *kernel)</div></div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/context_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/context_8h.html b/docs/cpp/context_8h.html index 62293fa..3fd2a17 100644 --- a/docs/cpp/context_8h.html +++ b/docs/cpp/context_8h.html @@ -74,7 +74,8 @@ $(function() { <div class="title">context.h File Reference</div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><code>#include "<a class="el" href="memory__pool_8h_source.html">arrow/memory_pool.h</a>"</code><br /> +<div class="textblock"><code>#include <memory></code><br /> +<code>#include "<a class="el" href="memory__pool_8h_source.html">arrow/memory_pool.h</a>"</code><br /> <code>#include "<a class="el" href="status_8h_source.html">arrow/status.h</a>"</code><br /> <code>#include "<a class="el" href="type__fwd_8h_source.html">arrow/type_fwd.h</a>"</code><br /> <code>#include "<a class="el" href="visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br /> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/context_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/context_8h_source.html b/docs/cpp/context_8h_source.html index a61a767..fbf7f80 100644 --- a/docs/cpp/context_8h_source.html +++ b/docs/cpp/context_8h_source.html @@ -70,15 +70,15 @@ $(function() { <div class="title">context.h</div> </div> </div><!--header--> <div class="contents"> -<a href="context_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 distributed u nder 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_CONTEXT_H</span></div><div class="line"><a name="l00019"></a><span class="line no"> 19</span> <span class="preprocessor">#define ARROW_COMPUTE_CONTEXT_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "<a class="code" href="memory__pool_8h.html">arrow/memory_pool.h</a>"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">arrow/type_fwd.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="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespacearrow_1_1compute.html"> 27</a></span> <span class="keyword">namespace </span>compute {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="context_8h.html#a7808a044fcba7e0e5ee269a242d5b351"> 29</a></span> <span class="preprocessor">#define RETURN_IF_ERROR(ctx) \</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"> if (ARROW_PREDICT_FALSE(ctx->HasError())) { \</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"> Status s = ctx->status(); \</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"> ctx->ResetStatus(); \</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"> return s; \</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classarrow_1_1compute_1_1_function_context.html"> 37</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a> {</div><div class="line"><a name="l00038"></a><span class="lin eno"> 38</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a>(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool <a class="code" href="memory__pool_8h.html#a45892ac769df8063a376c306735ff637">ARROW_MEMORY_POOL_DEFAULT</a>);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* memory_pool() <span class="keyword">const</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Allocate(<span class="keyword">const</span> int64_t nbytes, std::shared_ptr<Buffer>* out);</di v><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> SetStatus(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_status.html">Status</a>& status);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> ResetStatus();</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classarrow_1_1compute_1_1_function_context.html#a4240c42d4fb40bb3c09d4c3c18139509"> 56</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classarrow_1_1compute_1_1_function_context.html#a4240c42d4fb40bb3c09d4c3c18139509">HasError</a>()<span class="key word"> const </span>{ <span class="keywordflow">return</span> !status_.ok(); }</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classarrow_1_1compute_1_1_function_context.html#aa575c2fe3f2b4c611ff45143333af0e3"> 59</a></span>  <span class="keyword">const</span> <a class="code" href="classarrow_1_1_status.html">Status</a>& <a class="code" href="classarrow_1_1compute_1_1_function_context.html#aa575c2fe3f2b4c611ff45143333af0e3">status</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> status_; }</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="keyword">private</span>:</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classarrow_1_1_statu s.html">Status</a> status_;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool_;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> };</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> } <span class="comment">// namespace compute</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#endif // ARROW_COMPUTE_CONTEXT_H</span></div><div class="ttc" id="memory__pool_8h_html_a45892ac769df8063a376c306735ff637"><div class="ttname"><a href="memory__pool_8h.htm l#a45892ac769df8063a376c306735ff637">ARROW_MEMORY_POOL_DEFAULT</a></div><div class="ttdeci">#define ARROW_MEMORY_POOL_DEFAULT</div><div class="ttdef"><b>Definition:</b> memory_pool.h:94</div></div> -<div class="ttc" id="classarrow_1_1compute_1_1_function_context_html_a4240c42d4fb40bb3c09d4c3c18139509"><div class="ttname"><a href="classarrow_1_1compute_1_1_function_context.html#a4240c42d4fb40bb3c09d4c3c18139509">arrow::compute::FunctionContext::HasError</a></div><div class="ttdeci">bool HasError() const</div><div class="ttdoc">Return true if an error has occurred. </div><div class="ttdef"><b>Definition:</b> context.h:56</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> +<a href="context_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 distributed u nder 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_CONTEXT_H</span></div><div class="line"><a name="l00019"></a><span class="line no"> 19</span> <span class="preprocessor">#define ARROW_COMPUTE_CONTEXT_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="memory__pool_8h.html">arrow/memory_pool.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">arrow/type_fwd.h</a>"</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.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"><a class="line" href="namespacearrow_1_1compute.html"> 29</a></span> <span class="keyword">namespace </span>compute {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="context_8h.html#a7808a044fcba7e0e5ee269a242d5b351"> 31</a></span> <span class="preprocessor">#define RETURN_IF_ERROR(ctx) \</span></div><div c lass="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"> if (ARROW_PREDICT_FALSE(ctx->HasError())) { \</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"> Status s = ctx->status(); \</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"> ctx->ResetStatus(); \</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"> return s; \</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classarrow_1_1compute_1_1_function_context.html "> 39</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a>(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool <a class="code" href="memory__pool_8h.html#a45892ac769df8063a376c306735ff637">ARROW_MEMORY_POOL_DEFAULT</a>);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* memory_pool() <span class="keyword">const</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line "><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Allocate(<span class="keyword">const</span> int64_t nbytes, std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">void</span> SetStatus(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_status.html">Status</a>& status);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">void</span> ResetStatus();</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classarrow_1_1compute_1_1_function_context.html#a4240c4 2d4fb40bb3c09d4c3c18139509"> 58</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classarrow_1_1compute_1_1_function_context.html#a4240c42d4fb40bb3c09d4c3c18139509">HasError</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !status_.ok(); }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classarrow_1_1compute_1_1_function_context.html#aa575c2fe3f2b4c611ff45143333af0e3"> 61</a></span>  <span class="keyword">const</span> <a class="code" href="classarrow_1_1_status.html">Status</a>& <a class="code" href="classarrow_1_1compute_1_1_function_context.html#aa575c2fe3f2b4c611ff45143333af0e3">status</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> status_; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line">< a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> status_;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool_;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> };</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> } <span class="comment">// namespace compute</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class=" lineno"> 71</span> <span class="preprocessor">#endif // ARROW_COMPUTE_CONTEXT_H</span></div><div class="ttc" id="memory__pool_8h_html_a45892ac769df8063a376c306735ff637"><div class="ttname"><a href="memory__pool_8h.html#a45892ac769df8063a376c306735ff637">ARROW_MEMORY_POOL_DEFAULT</a></div><div class="ttdeci">#define ARROW_MEMORY_POOL_DEFAULT</div><div class="ttdef"><b>Definition:</b> memory_pool.h:94</div></div> +<div class="ttc" id="classarrow_1_1compute_1_1_function_context_html_a4240c42d4fb40bb3c09d4c3c18139509"><div class="ttname"><a href="classarrow_1_1compute_1_1_function_context.html#a4240c42d4fb40bb3c09d4c3c18139509">arrow::compute::FunctionContext::HasError</a></div><div class="ttdeci">bool HasError() const</div><div class="ttdoc">Return true if an error has occurred. </div><div class="ttdef"><b>Definition:</b> context.h:58</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="type__fwd_8h_html"><div class="ttname"><a href="type__fwd_8h.html">type_fwd.h</a></div></div> <div class="ttc" id="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div> <div class="ttc" id="memory__pool_8h_html"><div class="ttname"><a href="memory__pool_8h.html">memory_pool.h</a></div></div> <div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div> -<div class="ttc" id="classarrow_1_1compute_1_1_function_context_html_aa575c2fe3f2b4c611ff45143333af0e3"><div class="ttname"><a href="classarrow_1_1compute_1_1_function_context.html#aa575c2fe3f2b4c611ff45143333af0e3">arrow::compute::FunctionContext::status</a></div><div class="ttdeci">const Status & status() const</div><div class="ttdoc">Return the current status of the context. </div><div class="ttdef"><b>Definition:</b> context.h:59</div></div> +<div class="ttc" id="classarrow_1_1compute_1_1_function_context_html_aa575c2fe3f2b4c611ff45143333af0e3"><div class="ttname"><a href="classarrow_1_1compute_1_1_function_context.html#aa575c2fe3f2b4c611ff45143333af0e3">arrow::compute::FunctionContext::status</a></div><div class="ttdeci">const Status & status() const</div><div class="ttdoc">Return the current status of the context. </div><div class="ttdef"><b>Definition:</b> context.h:61</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="classarrow_1_1_memory_pool_html"><div class="ttname"><a href="classarrow_1_1_memory_pool.html">arrow::MemoryPool</a></div><div class="ttdoc">Base class for memory allocation. </div><div class="ttdef"><b>Definition:</b> memory_pool.h:34</div></div> </div><!-- fragment --></div><!-- contents -->
