http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_array.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_array.html b/docs/cpp/classarrow_1_1_array.html new file mode 100644 index 0000000..848ad8b --- /dev/null +++ b/docs/cpp/classarrow_1_1_array.html @@ -0,0 +1,843 @@ +<!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.6"/> +<title>Apache Arrow (C++): arrow::Array 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 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.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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="classarrow_1_1_array.html">Array</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="classarrow_1_1_array-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">arrow::Array Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>Immutable data array with some logical type and some length. + <a href="classarrow_1_1_array.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="array_8h_source.html">array.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for arrow::Array:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarrow_1_1_array.png" usemap="#arrow::Array_map" alt=""/> + <map id="arrow::Array_map" name="arrow::Array_map"> +<area href="classarrow_1_1_binary_array.html" alt="arrow::BinaryArray" shape="rect" coords="0,56,187,80"/> +<area href="classarrow_1_1_dictionary_array.html" alt="arrow::DictionaryArray" shape="rect" coords="197,56,384,80"/> +<area href="classarrow_1_1_list_array.html" alt="arrow::ListArray" shape="rect" coords="394,56,581,80"/> +<area href="classarrow_1_1_null_array.html" title="Degenerate null type Array. " alt="arrow::NullArray" shape="rect" coords="591,56,778,80"/> +<area href="classarrow_1_1_primitive_array.html" title="Base class for fixed-size logical types. " alt="arrow::PrimitiveArray" shape="rect" coords="788,56,975,80"/> +<area href="classarrow_1_1_struct_array.html" alt="arrow::StructArray" shape="rect" coords="985,56,1172,80"/> +<area href="classarrow_1_1_union_array.html" alt="arrow::UnionArray" shape="rect" coords="1182,56,1369,80"/> +<area href="classarrow_1_1_string_array.html" alt="arrow::StringArray" shape="rect" coords="0,112,187,136"/> +<area href="classarrow_1_1_boolean_array.html" alt="arrow::BooleanArray" shape="rect" coords="591,112,778,136"/> +<area href="classarrow_1_1_fixed_size_binary_array.html" alt="arrow::FixedSizeBinaryArray" shape="rect" coords="788,112,975,136"/> +<area href="classarrow_1_1_numeric_array.html" alt="arrow::NumericArray< TYPE >" shape="rect" coords="985,112,1172,136"/> +<area href="classarrow_1_1_decimal_array.html" alt="arrow::DecimalArray" shape="rect" coords="788,168,975,192"/> +</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:ac3c8efd95a2867d774dc99c700e6e349"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#ac3c8efd95a2867d774dc99c700e6e349">Array</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#af6d0bb430191ceef853297d81236cba6">type</a>, int64_t <a class="el" href="classarrow_1_1_array.html#a9d79327fd562c7bb36455979a3d56c20">length</a>, const std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > &<a class="el" href="classarrow_1_1_array.html#ac6a9a5af6d174976d4f2e44e756744f0">null_bitmap</a>=nullptr, int64_t <a class="el" href="classarrow_1_1_array.html#a8d85273d7b76520f804b7da8eda629f6">null_count</a>=0, int64_t <a class="el" href="classarrow_1_1_array.html#a814cce1a10c7eef53236c2abfaea8bee">offset</a>=0)</td></tr> +<tr class="separator:ac3c8efd95a2867d774dc99c700e6e349"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:addd582eec9488bca2b3379b71fef6ce5"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a38785d2e1977c10f995e2f3d9813b4e7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a38785d2e1977c10f995e2f3d9813b4e7">IsNull</a> (int64_t i) const </td></tr> +<tr class="memdesc:a38785d2e1977c10f995e2f3d9813b4e7"><td class="mdescLeft"> </td><td class="mdescRight">Determine if a slot is null. For inner loops. Does <em>not</em> boundscheck. <a href="#a38785d2e1977c10f995e2f3d9813b4e7">More...</a><br/></td></tr> +<tr class="separator:a38785d2e1977c10f995e2f3d9813b4e7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9d79327fd562c7bb36455979a3d56c20"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a9d79327fd562c7bb36455979a3d56c20">length</a> () const </td></tr> +<tr class="memdesc:a9d79327fd562c7bb36455979a3d56c20"><td class="mdescLeft"> </td><td class="mdescRight">Size in the number of elements this array contains. <a href="#a9d79327fd562c7bb36455979a3d56c20">More...</a><br/></td></tr> +<tr class="separator:a9d79327fd562c7bb36455979a3d56c20"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a814cce1a10c7eef53236c2abfaea8bee"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a814cce1a10c7eef53236c2abfaea8bee">offset</a> () const </td></tr> +<tr class="memdesc:a814cce1a10c7eef53236c2abfaea8bee"><td class="mdescLeft"> </td><td class="mdescRight">A relative position into another array's data, to enable zero-copy slicing. <a href="#a814cce1a10c7eef53236c2abfaea8bee">More...</a><br/></td></tr> +<tr class="separator:a814cce1a10c7eef53236c2abfaea8bee"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8d85273d7b76520f804b7da8eda629f6"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a8d85273d7b76520f804b7da8eda629f6">null_count</a> () const </td></tr> +<tr class="memdesc:a8d85273d7b76520f804b7da8eda629f6"><td class="mdescLeft"> </td><td class="mdescRight">The number of null entries in the array. <a href="#a8d85273d7b76520f804b7da8eda629f6">More...</a><br/></td></tr> +<tr class="separator:a8d85273d7b76520f804b7da8eda629f6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af6d0bb430191ceef853297d81236cba6"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#af6d0bb430191ceef853297d81236cba6">type</a> () const </td></tr> +<tr class="separator:af6d0bb430191ceef853297d81236cba6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a60af513406e55369c4122f1d739c6f99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a60af513406e55369c4122f1d739c6f99">type_id</a> () const </td></tr> +<tr class="separator:a60af513406e55369c4122f1d739c6f99"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac6a9a5af6d174976d4f2e44e756744f0"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#ac6a9a5af6d174976d4f2e44e756744f0">null_bitmap</a> () const </td></tr> +<tr class="memdesc:ac6a9a5af6d174976d4f2e44e756744f0"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> for the null bitmap. <a href="#ac6a9a5af6d174976d4f2e44e756744f0">More...</a><br/></td></tr> +<tr class="separator:ac6a9a5af6d174976d4f2e44e756744f0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a817196cd3b72f8d8c6d578036f6e9e97"><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#a817196cd3b72f8d8c6d578036f6e9e97">null_bitmap_data</a> () const </td></tr> +<tr class="memdesc:a817196cd3b72f8d8c6d578036f6e9e97"><td class="mdescLeft"> </td><td class="mdescRight">Raw pointer to the null bitmap. <a href="#a817196cd3b72f8d8c6d578036f6e9e97">More...</a><br/></td></tr> +<tr class="separator:a817196cd3b72f8d8c6d578036f6e9e97"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9c74a407e71e42e75d769a2b2827e25e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a9c74a407e71e42e75d769a2b2827e25e">Equals</a> (const <a class="el" href="classarrow_1_1_array.html">Array</a> &arr) const </td></tr> +<tr class="separator:a9c74a407e71e42e75d769a2b2827e25e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1db07a2e4e4b2241dffd602d675ac2a0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a1db07a2e4e4b2241dffd602d675ac2a0">Equals</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > &arr) const </td></tr> +<tr class="separator:a1db07a2e4e4b2241dffd602d675ac2a0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0989ac08e03dad0a1bfbd8d9d6eab25c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a0989ac08e03dad0a1bfbd8d9d6eab25c">ApproxEquals</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > &arr) const </td></tr> +<tr class="separator:a0989ac08e03dad0a1bfbd8d9d6eab25c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acb8ad42b8db90ae77a6bbb69e88a1844"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#acb8ad42b8db90ae77a6bbb69e88a1844">ApproxEquals</a> (const <a class="el" href="classarrow_1_1_array.html">Array</a> &arr) const </td></tr> +<tr class="separator:acb8ad42b8db90ae77a6bbb69e88a1844"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3791855cfd4669b65874ddd0cc4c60c2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a3791855cfd4669b65874ddd0cc4c60c2">RangeEquals</a> (int64_t start_idx, int64_t end_idx, int64_t other_start_idx, const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > &other) const </td></tr> +<tr class="memdesc:a3791855cfd4669b65874ddd0cc4c60c2"><td class="mdescLeft"> </td><td class="mdescRight">Compare if the range of slots specified are equal for the given array and this array. <a href="#a3791855cfd4669b65874ddd0cc4c60c2">More...</a><br/></td></tr> +<tr class="separator:a3791855cfd4669b65874ddd0cc4c60c2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a577aaca493fb2596164e78463d0644bc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a577aaca493fb2596164e78463d0644bc">RangeEquals</a> (const <a class="el" href="classarrow_1_1_array.html">Array</a> &other, int64_t start_idx, int64_t end_idx, int64_t other_start_idx) const </td></tr> +<tr class="separator:a577aaca493fb2596164e78463d0644bc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a87a266b267d85dc37119cb699cf6fdf9"><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_1_array.html#a87a266b267d85dc37119cb699cf6fdf9">Validate</a> () const </td></tr> +<tr class="memdesc:a87a266b267d85dc37119cb699cf6fdf9"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the array is internally consistent. <a href="#a87a266b267d85dc37119cb699cf6fdf9">More...</a><br/></td></tr> +<tr class="separator:a87a266b267d85dc37119cb699cf6fdf9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8cf8e5e06bedfdeeaccef89f4fcd8d72"><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#a8cf8e5e06bedfdeeaccef89f4fcd8d72">Accept</a> (<a class="el" href="classarrow_1_1_array_visitor.html">ArrayVisitor</a> *visitor) const </td></tr> +<tr class="separator:a8cf8e5e06bedfdeeaccef89f4fcd8d72"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a318b4c7dad0da7a47d324b1befd669a6"><td class="memItemLeft" align="right" valign="top">virtual 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#a318b4c7dad0da7a47d324b1befd669a6">Slice</a> (int64_t <a class="el" href="classarrow_1_1_array.html#a814cce1a10c7eef53236c2abfaea8bee">offset</a>, int64_t <a class="el" href="classarrow_1_1_array.html#a9d79327fd562c7bb36455979a3d56c20">length</a>) const =0</td></tr> +<tr class="memdesc:a318b4c7dad0da7a47d324b1befd669a6"><td class="mdescLeft"> </td><td class="mdescRight">Construct a zero-copy slice of the array with the indicated offset and length. <a href="#a318b4c7dad0da7a47d324b1befd669a6">More...</a><br/></td></tr> +<tr class="separator:a318b4c7dad0da7a47d324b1befd669a6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a78dd90702dfd4a4989c77585eecc23b1"><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#a78dd90702dfd4a4989c77585eecc23b1">Slice</a> (int64_t <a class="el" href="classarrow_1_1_array.html#a814cce1a10c7eef53236c2abfaea8bee">offset</a>) const </td></tr> +<tr class="memdesc:a78dd90702dfd4a4989c77585eecc23b1"><td class="mdescLeft"> </td><td class="mdescRight">Slice from offset until end of the array. <a href="#a78dd90702dfd4a4989c77585eecc23b1">More...</a><br/></td></tr> +<tr class="separator:a78dd90702dfd4a4989c77585eecc23b1"><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> +<tr class="memitem:a12b693935f3dd0aab750dbe37032a019"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a12b693935f3dd0aab750dbe37032a019">type_</a></td></tr> +<tr class="separator:a12b693935f3dd0aab750dbe37032a019"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7a2a3b04675d806226b99fa6e78ea14f"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a7a2a3b04675d806226b99fa6e78ea14f">length_</a></td></tr> +<tr class="separator:a7a2a3b04675d806226b99fa6e78ea14f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a581cecab69f86737603be4c3bd5835bd"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a581cecab69f86737603be4c3bd5835bd">offset_</a></td></tr> +<tr class="separator:a581cecab69f86737603be4c3bd5835bd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a68856a2f8d06a4d3e7e97f9a116a16f9"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a68856a2f8d06a4d3e7e97f9a116a16f9">null_count_</a></td></tr> +<tr class="separator:a68856a2f8d06a4d3e7e97f9a116a16f9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3d8a39e330032fae689f82f765b19d4f"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a3d8a39e330032fae689f82f765b19d4f">null_bitmap_</a></td></tr> +<tr class="separator:a3d8a39e330032fae689f82f765b19d4f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aed59d9e8608229ff3808983cdc908ccd"><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"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Immutable data array with some logical type and some length. </p> +<p>Any memory is owned by the respective <a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> instance (or its parents).</p> +<p>The base class is only required to have a null bitmap buffer if the null count is greater than 0</p> +<p>If known, the null count can be provided in the base <a class="el" href="classarrow_1_1_array.html" title="Immutable data array with some logical type and some length. ">Array</a> constructor. If the null count is not known, pass -1 to indicate that the null count is to be computed on the first call to <a class="el" href="classarrow_1_1_array.html#a8d85273d7b76520f804b7da8eda629f6" title="The number of null entries in the array. ">null_count()</a> </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="ac3c8efd95a2867d774dc99c700e6e349"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">arrow::Array::Array </td> + <td>(</td> + <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > & </td> + <td class="paramname"><em>type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>length</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > & </td> + <td class="paramname"><em>null_bitmap</em> = <code>nullptr</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>null_count</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>offset</em> = <code>0</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="addd582eec9488bca2b3379b71fef6ce5"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual arrow::Array::~Array </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> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a8cf8e5e06bedfdeeaccef89f4fcd8d72"></a> +<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::Array::Accept </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classarrow_1_1_array_visitor.html">ArrayVisitor</a> * </td> + <td class="paramname"><em>visitor</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a0989ac08e03dad0a1bfbd8d9d6eab25c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Array::ApproxEquals </td> + <td>(</td> + <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > & </td> + <td class="paramname"><em>arr</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="acb8ad42b8db90ae77a6bbb69e88a1844"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Array::ApproxEquals </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarrow_1_1_array.html">Array</a> & </td> + <td class="paramname"><em>arr</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a9c74a407e71e42e75d769a2b2827e25e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Array::Equals </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarrow_1_1_array.html">Array</a> & </td> + <td class="paramname"><em>arr</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a1db07a2e4e4b2241dffd602d675ac2a0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Array::Equals </td> + <td>(</td> + <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > & </td> + <td class="paramname"><em>arr</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a38785d2e1977c10f995e2f3d9813b4e7"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Array::IsNull </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>i</em></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>Determine if a slot is null. For inner loops. Does <em>not</em> boundscheck. </p> + +</div> +</div> +<a class="anchor" id="a9d79327fd562c7bb36455979a3d56c20"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::Array::length </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Size in the number of elements this array contains. </p> + +</div> +</div> +<a class="anchor" id="ac6a9a5af6d174976d4f2e44e756744f0"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <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::Array::null_bitmap </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><a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> for the null bitmap. </p> +<p>Note that for <code>null_count == 0</code>, this can be a <code>nullptr</code>. This buffer does not account for any slice offset </p> + +</div> +</div> +<a class="anchor" id="a817196cd3b72f8d8c6d578036f6e9e97"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const uint8_t* arrow::Array::null_bitmap_data </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>Raw pointer to the null bitmap. </p> +<p>Note that for <code>null_count == 0</code>, this can be a <code>nullptr</code>. This buffer does not account for any slice offset </p> + +</div> +</div> +<a class="anchor" id="a8d85273d7b76520f804b7da8eda629f6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::Array::null_count </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The number of null entries in the array. </p> +<p>If the null count was not known at time of construction (and set to a negative value), then the null count will be computed and cached on the first invocation of this function </p> + +</div> +</div> +<a class="anchor" id="a814cce1a10c7eef53236c2abfaea8bee"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::Array::offset </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>A relative position into another array's data, to enable zero-copy slicing. </p> +<p>This value defaults to zero </p> + +</div> +</div> +<a class="anchor" id="a3791855cfd4669b65874ddd0cc4c60c2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Array::RangeEquals </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>start_idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>end_idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>other_start_idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > & </td> + <td class="paramname"><em>other</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Compare if the range of slots specified are equal for the given array and this array. </p> +<p>end_idx exclusive. This methods does not bounds check. </p> + +</div> +</div> +<a class="anchor" id="a577aaca493fb2596164e78463d0644bc"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Array::RangeEquals </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarrow_1_1_array.html">Array</a> & </td> + <td class="paramname"><em>other</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>start_idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>end_idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>other_start_idx</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a318b4c7dad0da7a47d324b1befd669a6"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual std::shared_ptr<<a class="el" href="classarrow_1_1_array.html">Array</a>> arrow::Array::Slice </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> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="classarrow_1_1_dictionary_array.html#a8388b534794cdb772060bb8dabf18283">arrow::DictionaryArray</a>, <a class="el" href="classarrow_1_1_union_array.html#aabeb9f15fe156cde1478b28546417f76">arrow::UnionArray</a>, <a class="el" href="classarrow_1_1_struct_array.html#a56f61125db5224e45ef9216ef4540414">arrow::StructArray</a>, <a class="el" href="classarrow_1_1_decimal_array.html#a764399a02037b21d9ac699d9324a027b">arrow::DecimalArray</a>, <a class="el" href="classarrow_1_1_fixed_size_binary_array.html#a490c01227b8bc1abe78c1265d423d728">arrow::FixedSizeBinaryArray</a>, <a class="el" href="classarrow_1_1_string_array.html#a14bc0b3c443569e088a801c1822d5bed">arrow::StringArray</a>, <a class="el" href="classarrow_1_1_binary_array.html#aa638842ee9f512db99be1a22e635b77d">arrow::BinaryArray</a>, <a class="el" href="classarrow_1_1_list_array.html#a8a4c22a60cc94983fb2b19042bf227f6">arrow::ListArray</a>, <a class="el" href="classarrow_1_1_boolean_array.html#ad535 f5f1b6f9dc3fbdf1b0995fb9cbb8">arrow::BooleanArray</a>, <a class="el" href="classarrow_1_1_numeric_array.html#ab32db7f8075c6c7eb0c72644abb5adf4">arrow::NumericArray< TYPE ></a>, and <a class="el" href="classarrow_1_1_null_array.html#a2fc10055782b7b0b386fdb2276afd1d7">arrow::NullArray</a>.</p> + +</div> +</div> +<a class="anchor" id="a78dd90702dfd4a4989c77585eecc23b1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > arrow::Array::Slice </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>offset</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Slice from offset until end of the array. </p> + +</div> +</div> +<a class="anchor" id="af6d0bb430191ceef853297d81236cba6"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_data_type.html">DataType</a>> arrow::Array::type </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"> + +</div> +</div> +<a class="anchor" id="a60af513406e55369c4122f1d739c6f99"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> arrow::Array::type_id </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"> + +</div> +</div> +<a class="anchor" id="a87a266b267d85dc37119cb699cf6fdf9"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::Array::Validate </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">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Determines if the array is internally consistent. </p> +<p>Defaults to always returning <a class="el" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>. This can be an expensive check. </p> + +<p>Reimplemented in <a class="el" href="classarrow_1_1_dictionary_array.html#a974c31d4908d228db0d9257d06fa48ba">arrow::DictionaryArray</a>, <a class="el" href="classarrow_1_1_union_array.html#a214606a4736480685afa96cb69d63e44">arrow::UnionArray</a>, <a class="el" href="classarrow_1_1_struct_array.html#aad392081ee9dd50676272825c471e9a2">arrow::StructArray</a>, <a class="el" href="classarrow_1_1_string_array.html#a44ba441a6279333d7ef11fe263baf7d9">arrow::StringArray</a>, <a class="el" href="classarrow_1_1_binary_array.html#a49099f1ce25f198fed52a2e72e1f76e8">arrow::BinaryArray</a>, and <a class="el" href="classarrow_1_1_list_array.html#a86dda5eb3e7a16b45526840948285515">arrow::ListArray</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a7a2a3b04675d806226b99fa6e78ea14f"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::Array::length_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a3d8a39e330032fae689f82f765b19d4f"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <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::Array::null_bitmap_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="aed59d9e8608229ff3808983cdc908ccd"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const uint8_t* arrow::Array::null_bitmap_data_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a68856a2f8d06a4d3e7e97f9a116a16f9"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::Array::null_count_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a581cecab69f86737603be4c3bd5835bd"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::Array::offset_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a12b693935f3dd0aab750dbe37032a019"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_data_type.html">DataType</a>> arrow::Array::type_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>/home/wesm/code/arrow/cpp/src/arrow/<a class="el" href="array_8h_source.html">array.h</a></li> +<li>/home/wesm/code/arrow/cpp/src/arrow/<a class="el" href="array_8cc.html">array.cc</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.6 +</small></address> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_array.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_array.png b/docs/cpp/classarrow_1_1_array.png new file mode 100644 index 0000000..a0557ea Binary files /dev/null and b/docs/cpp/classarrow_1_1_array.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_array_builder-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_array_builder-members.html b/docs/cpp/classarrow_1_1_array_builder-members.html new file mode 100644 index 0000000..1f185e2 --- /dev/null +++ b/docs/cpp/classarrow_1_1_array_builder-members.html @@ -0,0 +1,133 @@ +<!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.6"/> +<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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 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.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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="classarrow_1_1_array_builder.html">ArrayBuilder</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">arrow::ArrayBuilder Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a630ea6ee96e26b8f1a2d08b45180fb32">Advance</a>(int64_t elements)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a21c1d9818e379f41e6c72df407ae029d">AppendToBitmap</a>(bool is_valid)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a17c9bf5211cb980518df3bb1c33ba4fc">AppendToBitmap</a>(const uint8_t *valid_bytes, int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a2cef09cd798edf3e9b3b9943ce33347b">ArrayBuilder</a>(MemoryPool *pool, const std::shared_ptr< DataType > &type)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a47b36298c021436d35b31d861892903d">capacity</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aeb92737fe5ada5b372459705c1690d7e">capacity_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aad4a1ed2c24204b1cc21e44ab0ad444b">child</a>(int i)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a9b2ede82de7d728f80eaa17ac8f7327d">children_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#ab9f2831b950610ff61087f994571d1cc">Finish</a>(std::shared_ptr< Array > *out)=0</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a821ca87387951f30dc3016393937ce19">Init</a>(int64_t capacity)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a2c99eda3af97e27847b080170d073e57">length</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#ae8b7ebc042e6684440bd9e1c77f0f5c1">length_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a190150db6c3770d90dfb58b11d978479">null_bitmap</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a030598b8cf748d469a1faed173237db1">null_bitmap_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a03476f9edb6a8fb48854ba7ecc785fa7">null_bitmap_data_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a75f95fc8ae6f3e996e26f09df1c73063">null_count</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a9ea96ba4121857ab23241b6b408051b9">null_count_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a95e609990be3c11d86265e701c9cefa8">num_children</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a33e3aa20cedda9f6d8581809437f1c86">pool_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a177b858a7ef7ee0ac316ca626bb3bf21">Reserve</a>(int64_t elements)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#adba65688b4b394f6faab764eb3c5c885">Resize</a>(int64_t new_bits)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aa505ec95646314c3b9254e0cce39538b">SetNotNull</a>(int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a890c2acb7ddc41a6206f267ee516ce1a">type</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aca785c23ae1f914f66bbf370bd9536a9">type_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a2dbe80584eac62147112c4d0a43ceea2">UnsafeAppendToBitmap</a>(bool is_valid)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#afd319659d3125af8a72c0c529c329c12">UnsafeAppendToBitmap</a>(const uint8_t *valid_bytes, int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aa0a2125633a3cdb1860d3f62d44ac4a1">UnsafeSetNotNull</a>(int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a74bb29b347e12ed7528925d12db109a7">~ArrayBuilder</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> +</table></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html>
