http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_union_array.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_union_array.html b/docs/cpp/classarrow_1_1_union_array.html index 5c77948..d3c7ed9 100644 --- a/docs/cpp/classarrow_1_1_union_array.html +++ b/docs/cpp/classarrow_1_1_union_array.html @@ -94,8 +94,8 @@ Public Types</h2></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> -<tr class="memitem:a912c72080808bf2db0527b1ccda33fb5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_array.html#a912c72080808bf2db0527b1ccda33fb5">UnionArray</a> (const std::shared_ptr< internal::ArrayData > &<a class="el" href="classarrow_1_1_array.html#ad98f18518f7061381863ee800eabf2ad">data</a>)</td></tr> -<tr class="separator:a912c72080808bf2db0527b1ccda33fb5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1c3602e865c5506fe5b1700329ccd6f3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_array.html#a1c3602e865c5506fe5b1700329ccd6f3">UnionArray</a> (const std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > &<a class="el" href="classarrow_1_1_array.html#aeca84e9b3a1f1e6e3f83a61c90e376a9">data</a>)</td></tr> +<tr class="separator:a1c3602e865c5506fe5b1700329ccd6f3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a082ab049050cb4381c5fab7e0317bacf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_array.html#a082ab049050cb4381c5fab7e0317bacf">UnionArray</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > &<a class="el" href="classarrow_1_1_array.html#a635a694fbadb0bfa731beb97df2ef7ea">type</a>, int64_t <a class="el" href="classarrow_1_1_array.html#a49c7fb3f73d2d43e7338591c5a8bd8bf">length</a>, const std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> >> &children, const std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > &<a class="el" href="classarrow_1_1_union_array.html#a679049e92aec3deacda4178e55cd1215">type_ids</a>, const std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > &<a class="el" href="classarrow_ 1_1_union_array.html#a8b2f7da8a7e992670924f06d40c3fd58">value_offsets</a>=nullptr, const std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > &<a class="el" href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">null_bitmap</a>=nullptr, int64_t <a class="el" href="classarrow_1_1_array.html#a0537d3b69a889b951e88be2fe9f3d96a">null_count</a>=0, int64_t <a class="el" href="classarrow_1_1_array.html#a1a0c6c1aa06cffd1dcb3813f0d24b2fd">offset</a>=0)</td></tr> <tr class="separator:a082ab049050cb4381c5fab7e0317bacf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a679049e92aec3deacda4178e55cd1215"><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_union_array.html#a679049e92aec3deacda4178e55cd1215">type_ids</a> () const</td></tr> @@ -112,9 +112,6 @@ Public Member Functions</h2></td></tr> <tr class="separator:ae636d3323f6226fe6c9911005c996da5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a097980a5f57e8c3abad054c1664feb52"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_array.html#a097980a5f57e8c3abad054c1664feb52">child</a> (int pos) const</td></tr> <tr class="separator:a097980a5f57e8c3abad054c1664feb52"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a89a9e7364dc6324dcb562997f295c36f"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_array.html#a89a9e7364dc6324dcb562997f295c36f">Slice</a> (int64_t <a class="el" href="classarrow_1_1_array.html#a1a0c6c1aa06cffd1dcb3813f0d24b2fd">offset</a>, int64_t <a class="el" href="classarrow_1_1_array.html#a49c7fb3f73d2d43e7338591c5a8bd8bf">length</a>) const override</td></tr> -<tr class="memdesc:a89a9e7364dc6324dcb562997f295c36f"><td class="mdescLeft"> </td><td class="mdescRight">Construct a zero-copy slice of the array with the indicated offset and length. <a href="#a89a9e7364dc6324dcb562997f295c36f">More...</a><br /></td></tr> -<tr class="separator:a89a9e7364dc6324dcb562997f295c36f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classarrow_1_1_array"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarrow_1_1_array')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td></tr> <tr class="memitem:addd582eec9488bca2b3379b71fef6ce5 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#addd582eec9488bca2b3379b71fef6ce5">~Array</a> ()=default</td></tr> <tr class="separator:addd582eec9488bca2b3379b71fef6ce5 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> @@ -155,11 +152,14 @@ Public Member Functions</h2></td></tr> <tr class="separator:acf138d427e7f8a8c56cac7f9d9e64db3 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a168f3ec5c96688dadeaf015692e4bef8 inherit pub_methods_classarrow_1_1_array"><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_array.html#a168f3ec5c96688dadeaf015692e4bef8">Accept</a> (<a class="el" href="classarrow_1_1_array_visitor.html">ArrayVisitor</a> *visitor) const</td></tr> <tr class="separator:a168f3ec5c96688dadeaf015692e4bef8 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae32f72c78fe10ce17f0a817e302e17d1 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#ae32f72c78fe10ce17f0a817e302e17d1">Slice</a> (int64_t <a class="el" href="classarrow_1_1_array.html#a1a0c6c1aa06cffd1dcb3813f0d24b2fd">offset</a>, int64_t <a class="el" href="classarrow_1_1_array.html#a49c7fb3f73d2d43e7338591c5a8bd8bf">length</a>) const</td></tr> +<tr class="memdesc:ae32f72c78fe10ce17f0a817e302e17d1 inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight">Construct a zero-copy slice of the array with the indicated offset and length. <a href="classarrow_1_1_array.html#ae32f72c78fe10ce17f0a817e302e17d1">More...</a><br /></td></tr> +<tr class="separator:ae32f72c78fe10ce17f0a817e302e17d1 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5cf4c3330e850670aa52dab3b21869ea inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a5cf4c3330e850670aa52dab3b21869ea">Slice</a> (int64_t <a class="el" href="classarrow_1_1_array.html#a1a0c6c1aa06cffd1dcb3813f0d24b2fd">offset</a>) const</td></tr> <tr class="memdesc:a5cf4c3330e850670aa52dab3b21869ea inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight">Slice from offset until end of the array. <a href="classarrow_1_1_array.html#a5cf4c3330e850670aa52dab3b21869ea">More...</a><br /></td></tr> <tr class="separator:a5cf4c3330e850670aa52dab3b21869ea inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ad98f18518f7061381863ee800eabf2ad inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< internal::ArrayData > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#ad98f18518f7061381863ee800eabf2ad">data</a> () const</td></tr> -<tr class="separator:ad98f18518f7061381863ee800eabf2ad inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aeca84e9b3a1f1e6e3f83a61c90e376a9 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#aeca84e9b3a1f1e6e3f83a61c90e376a9">data</a> () const</td></tr> +<tr class="separator:aeca84e9b3a1f1e6e3f83a61c90e376a9 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a183e69c91c531609f42a29b593119d58 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a183e69c91c531609f42a29b593119d58">num_fields</a> () const</td></tr> <tr class="separator:a183e69c91c531609f42a29b593119d58 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a41c7af0e40ac55f2ce11785fea3e051e inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a41c7af0e40ac55f2ce11785fea3e051e">ToString</a> () const</td></tr> @@ -167,14 +167,14 @@ Public Member Functions</h2></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> -<tr class="memitem:a93ca8abd7613759d0e80fe42d80751f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_array.html#a93ca8abd7613759d0e80fe42d80751f1">SetData</a> (const std::shared_ptr< internal::ArrayData > &<a class="el" href="classarrow_1_1_array.html#ad98f18518f7061381863ee800eabf2ad">data</a>)</td></tr> -<tr class="separator:a93ca8abd7613759d0e80fe42d80751f1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4ef525f978c100e016ae395fdc0fc00a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_array.html#a4ef525f978c100e016ae395fdc0fc00a">SetData</a> (const std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > &<a class="el" href="classarrow_1_1_array.html#aeca84e9b3a1f1e6e3f83a61c90e376a9">data</a>)</td></tr> +<tr class="separator:a4ef525f978c100e016ae395fdc0fc00a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_methods_classarrow_1_1_array"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1_array')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td></tr> <tr class="memitem:ae44d3c2fae3a8578fe829da20c6732f8 inherit pro_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#ae44d3c2fae3a8578fe829da20c6732f8">Array</a> ()</td></tr> <tr class="separator:ae44d3c2fae3a8578fe829da20c6732f8 inherit pro_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a7e01a2ba2ecb1cc84deb7f85c0f5c842 inherit pro_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a7e01a2ba2ecb1cc84deb7f85c0f5c842">SetData</a> (const std::shared_ptr< internal::ArrayData > &<a class="el" href="classarrow_1_1_array.html#ad98f18518f7061381863ee800eabf2ad">data</a>)</td></tr> -<tr class="memdesc:a7e01a2ba2ecb1cc84deb7f85c0f5c842 inherit pro_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight">Protected method for constructors. <a href="classarrow_1_1_array.html#a7e01a2ba2ecb1cc84deb7f85c0f5c842">More...</a><br /></td></tr> -<tr class="separator:a7e01a2ba2ecb1cc84deb7f85c0f5c842 inherit pro_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7053d3600bccd9cd34fcb6f5470a75c1 inherit pro_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a7053d3600bccd9cd34fcb6f5470a75c1">SetData</a> (const std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > &<a class="el" href="classarrow_1_1_array.html#aeca84e9b3a1f1e6e3f83a61c90e376a9">data</a>)</td></tr> +<tr class="memdesc:a7053d3600bccd9cd34fcb6f5470a75c1 inherit pro_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight">Protected method for constructors. <a href="classarrow_1_1_array.html#a7053d3600bccd9cd34fcb6f5470a75c1">More...</a><br /></td></tr> +<tr class="separator:a7053d3600bccd9cd34fcb6f5470a75c1 inherit pro_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> @@ -182,9 +182,11 @@ Protected Attributes</h2></td></tr> <tr class="separator:a3177a84d9b1c886dc0859f7c20bf1704"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2cd1c82dec5b8dcedc94c05fe9dbe872"><td class="memItemLeft" align="right" valign="top">const int32_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_array.html#a2cd1c82dec5b8dcedc94c05fe9dbe872">raw_value_offsets_</a></td></tr> <tr class="separator:a2cd1c82dec5b8dcedc94c05fe9dbe872"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0ec671cb63da95b44d5d0bcb787aa5c4"><td class="memItemLeft" align="right" valign="top">std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_array.html#a0ec671cb63da95b44d5d0bcb787aa5c4">boxed_fields_</a></td></tr> +<tr class="separator:a0ec671cb63da95b44d5d0bcb787aa5c4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_attribs_classarrow_1_1_array"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classarrow_1_1_array')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td></tr> -<tr class="memitem:aa8047296b1e2027f4089fceca3714597 inherit pro_attribs_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< internal::ArrayData > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#aa8047296b1e2027f4089fceca3714597">data_</a></td></tr> -<tr class="separator:aa8047296b1e2027f4089fceca3714597 inherit pro_attribs_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2631dce1d5868216cba0a140e81ef14e inherit pro_attribs_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a2631dce1d5868216cba0a140e81ef14e">data_</a></td></tr> +<tr class="separator:a2631dce1d5868216cba0a140e81ef14e inherit pro_attribs_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aed59d9e8608229ff3808983cdc908ccd inherit pro_attribs_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#aed59d9e8608229ff3808983cdc908ccd">null_bitmap_data_</a></td></tr> <tr class="separator:aed59d9e8608229ff3808983cdc908ccd inherit pro_attribs_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> </table> @@ -218,8 +220,8 @@ Protected Attributes</h2></td></tr> </div> </div> <h2 class="groupheader">Constructor & Destructor Documentation</h2> -<a id="a912c72080808bf2db0527b1ccda33fb5"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a912c72080808bf2db0527b1ccda33fb5">◆ </a></span>UnionArray() <span class="overload">[1/2]</span></h2> +<a id="a1c3602e865c5506fe5b1700329ccd6f3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1c3602e865c5506fe5b1700329ccd6f3">◆ </a></span>UnionArray() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> @@ -230,7 +232,7 @@ Protected Attributes</h2></td></tr> <tr> <td class="memname">arrow::UnionArray::UnionArray </td> <td>(</td> - <td class="paramtype">const std::shared_ptr< internal::ArrayData > & </td> + <td class="paramtype">const std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > & </td> <td class="paramname"><em>data</em></td><td>)</td> <td></td> </tr> @@ -402,8 +404,8 @@ Protected Attributes</h2></td></tr> </div> </div> -<a id="a93ca8abd7613759d0e80fe42d80751f1"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a93ca8abd7613759d0e80fe42d80751f1">◆ </a></span>SetData()</h2> +<a id="a4ef525f978c100e016ae395fdc0fc00a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4ef525f978c100e016ae395fdc0fc00a">◆ </a></span>SetData()</h2> <div class="memitem"> <div class="memproto"> @@ -414,7 +416,7 @@ Protected Attributes</h2></td></tr> <tr> <td class="memname">void arrow::UnionArray::SetData </td> <td>(</td> - <td class="paramtype">const std::shared_ptr< internal::ArrayData > & </td> + <td class="paramtype">const std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > & </td> <td class="paramname"><em>data</em></td><td>)</td> <td></td> </tr> @@ -428,8 +430,8 @@ Protected Attributes</h2></td></tr> </div> </div> -<a id="a89a9e7364dc6324dcb562997f295c36f"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a89a9e7364dc6324dcb562997f295c36f">◆ </a></span>Slice()</h2> +<a id="a679049e92aec3deacda4178e55cd1215"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a679049e92aec3deacda4178e55cd1215">◆ </a></span>type_ids()</h2> <div class="memitem"> <div class="memproto"> @@ -438,46 +440,25 @@ Protected Attributes</h2></td></tr> <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_array.html">Array</a>> arrow::UnionArray::Slice </td> + <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_buffer.html">Buffer</a>> arrow::UnionArray::type_ids </td> <td>(</td> - <td class="paramtype">int64_t </td> - <td class="paramname"><em>offset</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int64_t </td> - <td class="paramname"><em>length</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td> const</td> + <td class="paramname"></td><td>)</td> + <td> const</td> </tr> </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> -<p>Construct a zero-copy slice of the array with the indicated offset and length. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>the position of the first element in the constructed slice </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>the length of the slice. If there are not enough elements in the array, the length will be adjusted accordingly</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>a new object wrapped in std::shared_ptr<Array> </dd></dl> - -<p>Implements <a class="el" href="classarrow_1_1_array.html#a318b4c7dad0da7a47d324b1befd669a6">arrow::Array</a>.</p> +<p>Note that this buffer does not account for any slice offset. </p> </div> </div> -<a id="a679049e92aec3deacda4178e55cd1215"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a679049e92aec3deacda4178e55cd1215">◆ </a></span>type_ids()</h2> +<a id="a8b2f7da8a7e992670924f06d40c3fd58"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8b2f7da8a7e992670924f06d40c3fd58">◆ </a></span>value_offsets()</h2> <div class="memitem"> <div class="memproto"> @@ -486,7 +467,7 @@ Protected Attributes</h2></td></tr> <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_buffer.html">Buffer</a>> arrow::UnionArray::type_ids </td> + <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_buffer.html">Buffer</a>> arrow::UnionArray::value_offsets </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> @@ -503,8 +484,9 @@ Protected Attributes</h2></td></tr> </div> </div> -<a id="a8b2f7da8a7e992670924f06d40c3fd58"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a8b2f7da8a7e992670924f06d40c3fd58">◆ </a></span>value_offsets()</h2> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a0ec671cb63da95b44d5d0bcb787aa5c4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0ec671cb63da95b44d5d0bcb787aa5c4">◆ </a></span>boxed_fields_</h2> <div class="memitem"> <div class="memproto"> @@ -513,24 +495,18 @@ Protected Attributes</h2></td></tr> <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_buffer.html">Buffer</a>> arrow::UnionArray::value_offsets </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td> const</td> + <td class="memname">std::vector<std::shared_ptr<<a class="el" href="classarrow_1_1_array.html">Array</a>> > arrow::UnionArray::boxed_fields_</td> </tr> </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">inline</span></span> </td> +<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> -<p>Note that this buffer does not account for any slice offset. </p> - </div> </div> -<h2 class="groupheader">Member Data Documentation</h2> <a id="a3177a84d9b1c886dc0859f7c20bf1704"></a> <h2 class="memtitle"><span class="permalink"><a href="#a3177a84d9b1c886dc0859f7c20bf1704">◆ </a></span>raw_type_ids_</h2>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_union_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_union_type-members.html b/docs/cpp/classarrow_1_1_union_type-members.html index eac1514..c047a90 100644 --- a/docs/cpp/classarrow_1_1_union_type-members.html +++ b/docs/cpp/classarrow_1_1_union_type-members.html @@ -81,7 +81,7 @@ $(function() { <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#a5ec6a1c93420c68e9c8065d4a56ad645">id</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#aa2704f1cfc50018d02e109b32f67e422">id_</a></td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</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_union_type.html#ac4a59917d07f91698b869df5c2774e5a">mode</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_union_type.html">arrow::UnionType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_union_type.html#a023f466406bc0bdea728a0c2b2d980fd">name</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_union_type.html">arrow::UnionType</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_union_type.html#ae1fa65b67319c82d243e9a95de543bdc">name</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_union_type.html">arrow::UnionType</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#ac8920179a6c1e7f434c495d5ec4662f1">num_children</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_union_type.html#a54535494e9b2d710c0eb9fcbdde26dcd">ToString</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_union_type.html">arrow::UnionType</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_union_type.html#acc914e368eee461747fd06e711e7d8c8">type_codes</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_union_type.html">arrow::UnionType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_union_type.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_union_type.html b/docs/cpp/classarrow_1_1_union_type.html index 888d7bc..d8e66b1 100644 --- a/docs/cpp/classarrow_1_1_union_type.html +++ b/docs/cpp/classarrow_1_1_union_type.html @@ -65,7 +65,6 @@ $(function() { <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | -<a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pub-static-attribs">Static Public Attributes</a> | <a href="classarrow_1_1_union_type-members.html">List of all members</a> </div> <div class="headertitle"> @@ -90,7 +89,11 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a0f0a6c7cc29db606184583cd6c0ac36d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_type.html#a0f0a6c7cc29db606184583cd6c0ac36d">UnionType</a> (const std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_field.html">Field</a> >> &fields, const std::vector< uint8_t > &<a class="el" href="classarrow_1_1_union_type.html#acc914e368eee461747fd06e711e7d8c8">type_codes</a>, <a class="el" href="namespacearrow.html#a8f5c97201fa51210e007f33a600e295d">UnionMode</a> <a class="el" href="classarrow_1_1_union_type.html#ac4a59917d07f91698b869df5c2774e5a">mode</a>=<a class="el" href="namespacearrow.html#a8f5c97201fa51210e007f33a600e295da0459833ba9cad7cfd7bbfe10d7bbbe6e">UnionMode::SPARSE</a>)</td></tr> <tr class="separator:a0f0a6c7cc29db606184583cd6c0ac36d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a54535494e9b2d710c0eb9fcbdde26dcd"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_type.html#a54535494e9b2d710c0eb9fcbdde26dcd">ToString</a> () const override</td></tr> +<tr class="memdesc:a54535494e9b2d710c0eb9fcbdde26dcd"><td class="mdescLeft"> </td><td class="mdescRight">A string representation of the type, including any children. <a href="#a54535494e9b2d710c0eb9fcbdde26dcd">More...</a><br /></td></tr> <tr class="separator:a54535494e9b2d710c0eb9fcbdde26dcd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae1fa65b67319c82d243e9a95de543bdc"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_type.html#ae1fa65b67319c82d243e9a95de543bdc">name</a> () const override</td></tr> +<tr class="memdesc:ae1fa65b67319c82d243e9a95de543bdc"><td class="mdescLeft"> </td><td class="mdescRight">A string name of the type, omitting any child fields. <a href="#ae1fa65b67319c82d243e9a95de543bdc">More...</a><br /></td></tr> +<tr class="separator:ae1fa65b67319c82d243e9a95de543bdc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeb066e982e3289afa5cfafb448550324"><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_union_type.html#aeb066e982e3289afa5cfafb448550324">Accept</a> (<a class="el" href="classarrow_1_1_type_visitor.html">TypeVisitor</a> *visitor) const override</td></tr> <tr class="separator:aeb066e982e3289afa5cfafb448550324"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab9e3fa385f8a352a36b55729548211ce"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classarrow_1_1_buffer_descr.html">BufferDescr</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_type.html#ab9e3fa385f8a352a36b55729548211ce">GetBufferLayout</a> () const override</td></tr> @@ -117,14 +120,6 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a5ec6a1c93420c68e9c8065d4a56ad645 inherit pub_methods_classarrow_1_1_data_type"><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_data_type.html#a5ec6a1c93420c68e9c8065d4a56ad645">id</a> () const</td></tr> <tr class="separator:a5ec6a1c93420c68e9c8065d4a56ad645 inherit pub_methods_classarrow_1_1_data_type"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> -Static Public Member Functions</h2></td></tr> -<tr class="memitem:a023f466406bc0bdea728a0c2b2d980fd"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_union_type.html#a023f466406bc0bdea728a0c2b2d980fd">name</a> ()</td></tr> -<tr class="separator:a023f466406bc0bdea728a0c2b2d980fd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="inherit_header pub_static_methods_classarrow_1_1_nested_type"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classarrow_1_1_nested_type')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classarrow_1_1_nested_type.html">arrow::NestedType</a></td></tr> -<tr class="memitem:a95b52dca79d0ded4958285f2ed100569 inherit pub_static_methods_classarrow_1_1_nested_type"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_nested_type.html#a95b52dca79d0ded4958285f2ed100569">name</a> ()</td></tr> -<tr class="separator:a95b52dca79d0ded4958285f2ed100569 inherit pub_static_methods_classarrow_1_1_nested_type"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> Static Public Attributes</h2></td></tr> <tr class="memitem:abef5ab55bb61d53e4d2e4866480768dd"><td class="memItemLeft" align="right" valign="top">static constexpr <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_union_type.html#abef5ab55bb61d53e4d2e4866480768dd">type_id</a> = <a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44a2fa6d3a8e3947b7d0024304bfb8b5fad">Type::UNION</a></td></tr> @@ -254,8 +249,8 @@ Additional Inherited Members</h2></td></tr> </div> </div> -<a id="a023f466406bc0bdea728a0c2b2d980fd"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a023f466406bc0bdea728a0c2b2d980fd">◆ </a></span>name()</h2> +<a id="ae1fa65b67319c82d243e9a95de543bdc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae1fa65b67319c82d243e9a95de543bdc">◆ </a></span>name()</h2> <div class="memitem"> <div class="memproto"> @@ -264,19 +259,25 @@ Additional Inherited Members</h2></td></tr> <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">static std::string arrow::UnionType::name </td> + <td class="memname">std::string arrow::UnionType::name </td> <td>(</td> <td class="paramname"></td><td>)</td> - <td></td> + <td> const</td> </tr> </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> +<p>A string name of the type, omitting any child fields. </p> +<dl class="section note"><dt>Note</dt><dd>Experimental API </dd></dl> +<dl class="section since"><dt>Since</dt><dd>0.7.0 </dd></dl> + +<p>Implements <a class="el" href="classarrow_1_1_data_type.html#a94985d12273f5dd353d6142921299d4d">arrow::DataType</a>.</p> + </div> </div> <a id="a54535494e9b2d710c0eb9fcbdde26dcd"></a> @@ -302,6 +303,8 @@ Additional Inherited Members</h2></td></tr> </table> </div><div class="memdoc"> +<p>A string representation of the type, including any children. </p> + <p>Implements <a class="el" href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">arrow::DataType</a>.</p> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1compute_1_1_function_context-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1compute_1_1_function_context-members.html b/docs/cpp/classarrow_1_1compute_1_1_function_context-members.html new file mode 100644 index 0000000..fc646a7 --- /dev/null +++ b/docs/cpp/classarrow_1_1compute_1_1_function_context-members.html @@ -0,0 +1,88 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="namespacearrow_1_1compute.html">compute</a></li><li class="navelem"><a class="el" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">arrow::compute::FunctionContext Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classarrow_1_1compute_1_1_function_context.html">arrow::compute::FunctionContext</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#a9b52caa508a3d9b48519c3ef2dcd407f">Allocate</a>(const int64_t nbytes, std::shared_ptr< Buffer > *out)</td><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html">arrow::compute::FunctionContext</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#a02cce8aff2d51bccddfad538273339e1">FunctionContext</a>(MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)</td><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html">arrow::compute::FunctionContext</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#a4240c42d4fb40bb3c09d4c3c18139509">HasError</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html">arrow::compute::FunctionContext</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#a6a40381868c74845a698123ce6f2a4d3">memory_pool</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html">arrow::compute::FunctionContext</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#ad5a87457b35454ee157e08bfb62090d1">ResetStatus</a>()</td><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html">arrow::compute::FunctionContext</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#aa2836c190e3a5e5f452e45bb730fd155">SetStatus</a>(const Status &status)</td><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html">arrow::compute::FunctionContext</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#aa575c2fe3f2b4c611ff45143333af0e3">status</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_function_context.html">arrow::compute::FunctionContext</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> +</table></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1compute_1_1_function_context.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1compute_1_1_function_context.html b/docs/cpp/classarrow_1_1compute_1_1_function_context.html new file mode 100644 index 0000000..6249b2f --- /dev/null +++ b/docs/cpp/classarrow_1_1compute_1_1_function_context.html @@ -0,0 +1,289 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): arrow::compute::FunctionContext Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="namespacearrow_1_1compute.html">compute</a></li><li class="navelem"><a class="el" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarrow_1_1compute_1_1_function_context-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">arrow::compute::FunctionContext Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Container for variables and options used by function evaluation. + <a href="classarrow_1_1compute_1_1_function_context.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="context_8h_source.html">context.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a02cce8aff2d51bccddfad538273339e1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#a02cce8aff2d51bccddfad538273339e1">FunctionContext</a> (<a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool <a class="el" href="memory__pool_8h.html#a45892ac769df8063a376c306735ff637">ARROW_MEMORY_POOL_DEFAULT</a>)</td></tr> +<tr class="separator:a02cce8aff2d51bccddfad538273339e1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6a40381868c74845a698123ce6f2a4d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#a6a40381868c74845a698123ce6f2a4d3">memory_pool</a> () const</td></tr> +<tr class="separator:a6a40381868c74845a698123ce6f2a4d3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9b52caa508a3d9b48519c3ef2dcd407f"><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_1compute_1_1_function_context.html#a9b52caa508a3d9b48519c3ef2dcd407f">Allocate</a> (const int64_t nbytes, std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > *out)</td></tr> +<tr class="memdesc:a9b52caa508a3d9b48519c3ef2dcd407f"><td class="mdescLeft"> </td><td class="mdescRight">Allocate buffer from the context's memory pool. <a href="#a9b52caa508a3d9b48519c3ef2dcd407f">More...</a><br /></td></tr> +<tr class="separator:a9b52caa508a3d9b48519c3ef2dcd407f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa2836c190e3a5e5f452e45bb730fd155"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#aa2836c190e3a5e5f452e45bb730fd155">SetStatus</a> (const <a class="el" href="classarrow_1_1_status.html">Status</a> &<a class="el" href="classarrow_1_1compute_1_1_function_context.html#aa575c2fe3f2b4c611ff45143333af0e3">status</a>)</td></tr> +<tr class="memdesc:aa2836c190e3a5e5f452e45bb730fd155"><td class="mdescLeft"> </td><td class="mdescRight">Indicate that an error has occurred, to be checked by a parent caller. <a href="#aa2836c190e3a5e5f452e45bb730fd155">More...</a><br /></td></tr> +<tr class="separator:aa2836c190e3a5e5f452e45bb730fd155"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad5a87457b35454ee157e08bfb62090d1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#ad5a87457b35454ee157e08bfb62090d1">ResetStatus</a> ()</td></tr> +<tr class="memdesc:ad5a87457b35454ee157e08bfb62090d1"><td class="mdescLeft"> </td><td class="mdescRight">Clear any error status. <a href="#ad5a87457b35454ee157e08bfb62090d1">More...</a><br /></td></tr> +<tr class="separator:ad5a87457b35454ee157e08bfb62090d1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4240c42d4fb40bb3c09d4c3c18139509"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#a4240c42d4fb40bb3c09d4c3c18139509">HasError</a> () const</td></tr> +<tr class="memdesc:a4240c42d4fb40bb3c09d4c3c18139509"><td class="mdescLeft"> </td><td class="mdescRight">Return true if an error has occurred. <a href="#a4240c42d4fb40bb3c09d4c3c18139509">More...</a><br /></td></tr> +<tr class="separator:a4240c42d4fb40bb3c09d4c3c18139509"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa575c2fe3f2b4c611ff45143333af0e3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarrow_1_1_status.html">Status</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1compute_1_1_function_context.html#aa575c2fe3f2b4c611ff45143333af0e3">status</a> () const</td></tr> +<tr class="memdesc:aa575c2fe3f2b4c611ff45143333af0e3"><td class="mdescLeft"> </td><td class="mdescRight">Return the current status of the context. <a href="#aa575c2fe3f2b4c611ff45143333af0e3">More...</a><br /></td></tr> +<tr class="separator:aa575c2fe3f2b4c611ff45143333af0e3"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Container for variables and options used by function evaluation. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a02cce8aff2d51bccddfad538273339e1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a02cce8aff2d51bccddfad538273339e1">◆ </a></span>FunctionContext()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">arrow::compute::FunctionContext::FunctionContext </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool </td> + <td class="paramname"><em>ARROW_MEMORY_POOL_DEFAULT</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a9b52caa508a3d9b48519c3ef2dcd407f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9b52caa508a3d9b48519c3ef2dcd407f">◆ </a></span>Allocate()</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::compute::FunctionContext::Allocate </td> + <td>(</td> + <td class="paramtype">const int64_t </td> + <td class="paramname"><em>nbytes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > * </td> + <td class="paramname"><em>out</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Allocate buffer from the context's memory pool. </p> + +</div> +</div> +<a id="a4240c42d4fb40bb3c09d4c3c18139509"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4240c42d4fb40bb3c09d4c3c18139509">◆ </a></span>HasError()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::compute::FunctionContext::HasError </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">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Return true if an error has occurred. </p> + +</div> +</div> +<a id="a6a40381868c74845a698123ce6f2a4d3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6a40381868c74845a698123ce6f2a4d3">◆ </a></span>memory_pool()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* arrow::compute::FunctionContext::memory_pool </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="ad5a87457b35454ee157e08bfb62090d1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad5a87457b35454ee157e08bfb62090d1">◆ </a></span>ResetStatus()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void arrow::compute::FunctionContext::ResetStatus </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Clear any error status. </p> + +</div> +</div> +<a id="aa2836c190e3a5e5f452e45bb730fd155"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa2836c190e3a5e5f452e45bb730fd155">◆ </a></span>SetStatus()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void arrow::compute::FunctionContext::SetStatus </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarrow_1_1_status.html">Status</a> & </td> + <td class="paramname"><em>status</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Indicate that an error has occurred, to be checked by a parent caller. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>a <a class="el" href="classarrow_1_1_status.html">Status</a> instance</td></tr> + </table> + </dd> +</dl> +<dl class="section note"><dt>Note</dt><dd>Will not overwrite a prior set <a class="el" href="classarrow_1_1_status.html">Status</a>, so we will have the first error that occurred until <a class="el" href="classarrow_1_1compute_1_1_function_context.html#ad5a87457b35454ee157e08bfb62090d1" title="Clear any error status. ">FunctionContext::ResetStatus</a> is called </dd></dl> + +</div> +</div> +<a id="aa575c2fe3f2b4c611ff45143333af0e3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa575c2fe3f2b4c611ff45143333af0e3">◆ </a></span>status()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="classarrow_1_1_status.html">Status</a>& arrow::compute::FunctionContext::status </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">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Return the current status of the context. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/wesm/code/arrow/cpp/src/arrow/compute/<a class="el" href="context_8h_source.html">context.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1compute_1_1_op_kernel-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1compute_1_1_op_kernel-members.html b/docs/cpp/classarrow_1_1compute_1_1_op_kernel-members.html new file mode 100644 index 0000000..0aadf52 --- /dev/null +++ b/docs/cpp/classarrow_1_1compute_1_1_op_kernel-members.html @@ -0,0 +1,82 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="namespacearrow_1_1compute.html">compute</a></li><li class="navelem"><a class="el" href="classarrow_1_1compute_1_1_op_kernel.html">OpKernel</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">arrow::compute::OpKernel Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classarrow_1_1compute_1_1_op_kernel.html">arrow::compute::OpKernel</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_op_kernel.html#a640d7e2c51722436ed428013dabb63d3">~OpKernel</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_op_kernel.html">arrow::compute::OpKernel</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> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1compute_1_1_op_kernel.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1compute_1_1_op_kernel.html b/docs/cpp/classarrow_1_1compute_1_1_op_kernel.html new file mode 100644 index 0000000..1bb7ef6 --- /dev/null +++ b/docs/cpp/classarrow_1_1compute_1_1_op_kernel.html @@ -0,0 +1,132 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): arrow::compute::OpKernel Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="namespacearrow_1_1compute.html">compute</a></li><li class="navelem"><a class="el" href="classarrow_1_1compute_1_1_op_kernel.html">OpKernel</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarrow_1_1compute_1_1_op_kernel-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">arrow::compute::OpKernel Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Base class for operator kernels. + <a href="classarrow_1_1compute_1_1_op_kernel.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="kernel_8h_source.html">kernel.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for arrow::compute::OpKernel:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarrow_1_1compute_1_1_op_kernel.png" usemap="#arrow::compute::OpKernel_map" alt=""/> + <map id="arrow::compute::OpKernel_map" name="arrow::compute::OpKernel_map"> +<area href="classarrow_1_1compute_1_1_unary_kernel.html" title="An array-valued function of a single input argument. " alt="arrow::compute::UnaryKernel" shape="rect" coords="0,56,175,80"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a640d7e2c51722436ed428013dabb63d3"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1compute_1_1_op_kernel.html#a640d7e2c51722436ed428013dabb63d3">~OpKernel</a> ()=default</td></tr> +<tr class="separator:a640d7e2c51722436ed428013dabb63d3"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Base class for operator kernels. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a640d7e2c51722436ed428013dabb63d3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a640d7e2c51722436ed428013dabb63d3">◆ </a></span>~OpKernel()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual arrow::compute::OpKernel::~OpKernel </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/wesm/code/arrow/cpp/src/arrow/compute/<a class="el" href="kernel_8h_source.html">kernel.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1compute_1_1_op_kernel.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1compute_1_1_op_kernel.png b/docs/cpp/classarrow_1_1compute_1_1_op_kernel.png new file mode 100644 index 0000000..1b7da86 Binary files /dev/null and b/docs/cpp/classarrow_1_1compute_1_1_op_kernel.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1compute_1_1_unary_kernel-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1compute_1_1_unary_kernel-members.html b/docs/cpp/classarrow_1_1compute_1_1_unary_kernel-members.html new file mode 100644 index 0000000..6bfdbd5 --- /dev/null +++ b/docs/cpp/classarrow_1_1compute_1_1_unary_kernel-members.html @@ -0,0 +1,83 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="namespacearrow_1_1compute.html">compute</a></li><li class="navelem"><a class="el" href="classarrow_1_1compute_1_1_unary_kernel.html">UnaryKernel</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">arrow::compute::UnaryKernel Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classarrow_1_1compute_1_1_unary_kernel.html">arrow::compute::UnaryKernel</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_unary_kernel.html#a6835fc4ef911cd22c56fccadc19048bb">Call</a>(FunctionContext *ctx, const Array &input, ArrayData *out)=0</td><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_unary_kernel.html">arrow::compute::UnaryKernel</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_op_kernel.html#a640d7e2c51722436ed428013dabb63d3">~OpKernel</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1compute_1_1_op_kernel.html">arrow::compute::OpKernel</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> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1compute_1_1_unary_kernel.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1compute_1_1_unary_kernel.html b/docs/cpp/classarrow_1_1compute_1_1_unary_kernel.html new file mode 100644 index 0000000..ba4d593 --- /dev/null +++ b/docs/cpp/classarrow_1_1compute_1_1_unary_kernel.html @@ -0,0 +1,152 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): arrow::compute::UnaryKernel Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="namespacearrow_1_1compute.html">compute</a></li><li class="navelem"><a class="el" href="classarrow_1_1compute_1_1_unary_kernel.html">UnaryKernel</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarrow_1_1compute_1_1_unary_kernel-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">arrow::compute::UnaryKernel Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>An array-valued function of a single input argument. + <a href="classarrow_1_1compute_1_1_unary_kernel.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="kernel_8h_source.html">kernel.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for arrow::compute::UnaryKernel:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarrow_1_1compute_1_1_unary_kernel.png" usemap="#arrow::compute::UnaryKernel_map" alt=""/> + <map id="arrow::compute::UnaryKernel_map" name="arrow::compute::UnaryKernel_map"> +<area href="classarrow_1_1compute_1_1_op_kernel.html" title="Base class for operator kernels. " alt="arrow::compute::OpKernel" shape="rect" coords="0,0,175,24"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a6835fc4ef911cd22c56fccadc19048bb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1compute_1_1_unary_kernel.html#a6835fc4ef911cd22c56fccadc19048bb">Call</a> (<a class="el" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a> *ctx, const <a class="el" href="classarrow_1_1_array.html">Array</a> &input, <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> *out)=0</td></tr> +<tr class="separator:a6835fc4ef911cd22c56fccadc19048bb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classarrow_1_1compute_1_1_op_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarrow_1_1compute_1_1_op_kernel')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarrow_1_1compute_1_1_op_kernel.html">arrow::compute::OpKernel</a></td></tr> +<tr class="memitem:a640d7e2c51722436ed428013dabb63d3 inherit pub_methods_classarrow_1_1compute_1_1_op_kernel"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1compute_1_1_op_kernel.html#a640d7e2c51722436ed428013dabb63d3">~OpKernel</a> ()=default</td></tr> +<tr class="separator:a640d7e2c51722436ed428013dabb63d3 inherit pub_methods_classarrow_1_1compute_1_1_op_kernel"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>An array-valued function of a single input argument. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a6835fc4ef911cd22c56fccadc19048bb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6835fc4ef911cd22c56fccadc19048bb">◆ </a></span>Call()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classarrow_1_1_status.html">Status</a> arrow::compute::UnaryKernel::Call </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classarrow_1_1compute_1_1_function_context.html">FunctionContext</a> * </td> + <td class="paramname"><em>ctx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classarrow_1_1_array.html">Array</a> & </td> + <td class="paramname"><em>input</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> * </td> + <td class="paramname"><em>out</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/wesm/code/arrow/cpp/src/arrow/compute/<a class="el" href="kernel_8h_source.html">kernel.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1compute_1_1_unary_kernel.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1compute_1_1_unary_kernel.png b/docs/cpp/classarrow_1_1compute_1_1_unary_kernel.png new file mode 100644 index 0000000..7fa0e27 Binary files /dev/null and b/docs/cpp/classarrow_1_1compute_1_1_unary_kernel.png differ
