http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_primitive_builder-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_primitive_builder-members.html b/docs/cpp/classarrow_1_1_primitive_builder-members.html index cd14235..73e09fb 100644 --- a/docs/cpp/classarrow_1_1_primitive_builder-members.html +++ b/docs/cpp/classarrow_1_1_primitive_builder-members.html @@ -72,11 +72,15 @@ $(function() { <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_primitive_builder.html#af56d2faa32f2008bf4fe8ceb4742b007">Append</a>(const value_type *values, int64_t length, const uint8_t *valid_bytes=nullptr)</td><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder< Type ></a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html#a5e8f61934c9b31e8300eb0e393091b22">AppendNull</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder< Type ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html#a81d4fe57bd4c9399e9122f4e862bd466">AppendNulls</a>(const uint8_t *valid_bytes, int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder< Type ></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#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><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 class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a1cca0c811526a59cdd4f6491d6f1c7b6">ArrayBuilder</a>(const std::shared_ptr< DataType > &type, MemoryPool *pool)</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_primitive_builder.html#ae98d282930fe426b9062d3802a5bd477">Append</a>(const value_type *values, int64_t length, const std::vector< bool > &is_valid)</td><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder< Type ></a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html#ae55dc9d440381381ce139d414e339194">Append</a>(const std::vector< value_type > &values, const std::vector< bool > &is_valid)</td><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder< Type ></a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html#a1ed12b2856cb1571cb730c3ece8e090d">Append</a>(const std::vector< value_type > &values)</td><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder< Type ></a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html#a5e8f61934c9b31e8300eb0e393091b22">AppendNull</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder< Type ></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_primitive_builder.html#a81d4fe57bd4c9399e9122f4e862bd466">AppendNulls</a>(const uint8_t *valid_bytes, int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder< Type ></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#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#a1cca0c811526a59cdd4f6491d6f1c7b6">ArrayBuilder</a>(const std::shared_ptr< DataType > &type, MemoryPool *pool)</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#a37ea95121df1a041dcc869ad488ff0bd">ArrayBuilder</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">inline</span><span class="mlabel">protected</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a0236e815af8f62c98bd612eea219cd73">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 class="even"><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><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> @@ -105,9 +109,10 @@ $(function() { <tr class="even"><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><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">inline</span><span class="mlabel">protected</span></td></tr> <tr class="even"><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><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 class="even"><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html#a7232c92a1ba781092ee68d2a65196dcf">value_type</a> typedef</td><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder< Type ></a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a74bb29b347e12ed7528925d12db109a7">~ArrayBuilder</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a361c8efe3030a75126cbbbe90e9a3ee4">UnsafeAppendToBitmap</a>(const std::vector< bool > &is_valid)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#aa0a2125633a3cdb1860d3f62d44ac4a1">UnsafeSetNotNull</a>(int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html#a7232c92a1ba781092ee68d2a65196dcf">value_type</a> typedef</td><td class="entry"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder< Type ></a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html#a74bb29b347e12ed7528925d12db109a7">~ArrayBuilder</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> </table></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_primitive_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_primitive_builder.html b/docs/cpp/classarrow_1_1_primitive_builder.html index 386c377..f769694 100644 --- a/docs/cpp/classarrow_1_1_primitive_builder.html +++ b/docs/cpp/classarrow_1_1_primitive_builder.html @@ -103,8 +103,17 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a22a36e1dfbf627dea6ec949408cbda18"><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_primitive_builder.html#a22a36e1dfbf627dea6ec949408cbda18">data</a> () const</td></tr> <tr class="separator:a22a36e1dfbf627dea6ec949408cbda18"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af56d2faa32f2008bf4fe8ceb4742b007"><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_primitive_builder.html#af56d2faa32f2008bf4fe8ceb4742b007">Append</a> (const <a class="el" href="classarrow_1_1_primitive_builder.html#a7232c92a1ba781092ee68d2a65196dcf">value_type</a> *values, int64_t <a class="el" href="classarrow_1_1_array_builder.html#a296ac75b9b3d877192e37681c66513ba">length</a>, const uint8_t *valid_bytes=nullptr)</td></tr> -<tr class="memdesc:af56d2faa32f2008bf4fe8ceb4742b007"><td class="mdescLeft"> </td><td class="mdescRight">Vector append. <a href="#af56d2faa32f2008bf4fe8ceb4742b007">More...</a><br /></td></tr> +<tr class="memdesc:af56d2faa32f2008bf4fe8ceb4742b007"><td class="mdescLeft"> </td><td class="mdescRight">Append a sequence of elements in one shot. <a href="#af56d2faa32f2008bf4fe8ceb4742b007">More...</a><br /></td></tr> <tr class="separator:af56d2faa32f2008bf4fe8ceb4742b007"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae98d282930fe426b9062d3802a5bd477"><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_primitive_builder.html#ae98d282930fe426b9062d3802a5bd477">Append</a> (const <a class="el" href="classarrow_1_1_primitive_builder.html#a7232c92a1ba781092ee68d2a65196dcf">value_type</a> *values, int64_t <a class="el" href="classarrow_1_1_array_builder.html#a296ac75b9b3d877192e37681c66513ba">length</a>, const std::vector< bool > &is_valid)</td></tr> +<tr class="memdesc:ae98d282930fe426b9062d3802a5bd477"><td class="mdescLeft"> </td><td class="mdescRight">Append a sequence of elements in one shot. <a href="#ae98d282930fe426b9062d3802a5bd477">More...</a><br /></td></tr> +<tr class="separator:ae98d282930fe426b9062d3802a5bd477"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae55dc9d440381381ce139d414e339194"><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_primitive_builder.html#ae55dc9d440381381ce139d414e339194">Append</a> (const std::vector< <a class="el" href="classarrow_1_1_primitive_builder.html#a7232c92a1ba781092ee68d2a65196dcf">value_type</a> > &values, const std::vector< bool > &is_valid)</td></tr> +<tr class="memdesc:ae55dc9d440381381ce139d414e339194"><td class="mdescLeft"> </td><td class="mdescRight">Append a sequence of elements in one shot. <a href="#ae55dc9d440381381ce139d414e339194">More...</a><br /></td></tr> +<tr class="separator:ae55dc9d440381381ce139d414e339194"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1ed12b2856cb1571cb730c3ece8e090d"><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_primitive_builder.html#a1ed12b2856cb1571cb730c3ece8e090d">Append</a> (const std::vector< <a class="el" href="classarrow_1_1_primitive_builder.html#a7232c92a1ba781092ee68d2a65196dcf">value_type</a> > &values)</td></tr> +<tr class="memdesc:a1ed12b2856cb1571cb730c3ece8e090d"><td class="mdescLeft"> </td><td class="mdescRight">Append a sequence of elements in one shot. <a href="#a1ed12b2856cb1571cb730c3ece8e090d">More...</a><br /></td></tr> +<tr class="separator:a1ed12b2856cb1571cb730c3ece8e090d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2b8295c164f0a8f5a421212b02171124"><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_primitive_builder.html#a2b8295c164f0a8f5a421212b02171124">Finish</a> (std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > *out) override</td></tr> <tr class="memdesc:a2b8295c164f0a8f5a421212b02171124"><td class="mdescLeft"> </td><td class="mdescRight">Creates new <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> object to hold the contents of the builder and transfers ownership of the data. <a href="#a2b8295c164f0a8f5a421212b02171124">More...</a><br /></td></tr> <tr class="separator:a2b8295c164f0a8f5a421212b02171124"><td class="memSeparator" colspan="2"> </td></tr> @@ -177,12 +186,16 @@ Protected Attributes</h2></td></tr> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pro_methods_classarrow_1_1_array_builder"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1_array_builder')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td></tr> +<tr class="memitem:a37ea95121df1a041dcc869ad488ff0bd inherit pro_methods_classarrow_1_1_array_builder"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array_builder.html#a37ea95121df1a041dcc869ad488ff0bd">ArrayBuilder</a> ()</td></tr> +<tr class="separator:a37ea95121df1a041dcc869ad488ff0bd inherit pro_methods_classarrow_1_1_array_builder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a82e016f3be8a271a97b850fd81a7a338 inherit pro_methods_classarrow_1_1_array_builder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array_builder.html#a82e016f3be8a271a97b850fd81a7a338">Reset</a> ()</td></tr> <tr class="separator:a82e016f3be8a271a97b850fd81a7a338 inherit pro_methods_classarrow_1_1_array_builder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2dbe80584eac62147112c4d0a43ceea2 inherit pro_methods_classarrow_1_1_array_builder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array_builder.html#a2dbe80584eac62147112c4d0a43ceea2">UnsafeAppendToBitmap</a> (bool is_valid)</td></tr> <tr class="separator:a2dbe80584eac62147112c4d0a43ceea2 inherit pro_methods_classarrow_1_1_array_builder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afd319659d3125af8a72c0c529c329c12 inherit pro_methods_classarrow_1_1_array_builder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array_builder.html#afd319659d3125af8a72c0c529c329c12">UnsafeAppendToBitmap</a> (const uint8_t *valid_bytes, int64_t <a class="el" href="classarrow_1_1_array_builder.html#a296ac75b9b3d877192e37681c66513ba">length</a>)</td></tr> <tr class="separator:afd319659d3125af8a72c0c529c329c12 inherit pro_methods_classarrow_1_1_array_builder"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a361c8efe3030a75126cbbbe90e9a3ee4 inherit pro_methods_classarrow_1_1_array_builder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array_builder.html#a361c8efe3030a75126cbbbe90e9a3ee4">UnsafeAppendToBitmap</a> (const std::vector< bool > &is_valid)</td></tr> +<tr class="separator:a361c8efe3030a75126cbbbe90e9a3ee4 inherit pro_methods_classarrow_1_1_array_builder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa0a2125633a3cdb1860d3f62d44ac4a1 inherit pro_methods_classarrow_1_1_array_builder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array_builder.html#aa0a2125633a3cdb1860d3f62d44ac4a1">UnsafeSetNotNull</a> (int64_t <a class="el" href="classarrow_1_1_array_builder.html#a296ac75b9b3d877192e37681c66513ba">length</a>)</td></tr> <tr class="separator:aa0a2125633a3cdb1860d3f62d44ac4a1 inherit pro_methods_classarrow_1_1_array_builder"><td class="memSeparator" colspan="2"> </td></tr> </table> @@ -282,7 +295,7 @@ template<typename Type> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="af56d2faa32f2008bf4fe8ceb4742b007"></a> -<h2 class="memtitle"><span class="permalink"><a href="#af56d2faa32f2008bf4fe8ceb4742b007">◆ </a></span>Append()</h2> +<h2 class="memtitle"><span class="permalink"><a href="#af56d2faa32f2008bf4fe8ceb4742b007">◆ </a></span>Append() <span class="overload">[1/4]</span></h2> <div class="memitem"> <div class="memproto"> @@ -315,8 +328,132 @@ template<typename Type> </div> </table> </div><div class="memdoc"> -<p>Vector append. </p> -<p>If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot </p> +<p>Append a sequence of elements in one shot. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">values</td><td>a contiguous C array of values </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>the number of values to append </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">valid_bytes</td><td>an optional sequence of bytes where non-zero indicates a valid (non-null) value </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl> + +</div> +</div> +<a id="ae98d282930fe426b9062d3802a5bd477"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae98d282930fe426b9062d3802a5bd477">◆ </a></span>Append() <span class="overload">[2/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Type> </div> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> <a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder</a>< <a class="el" href="structarrow_1_1_type.html">Type</a> >::Append </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarrow_1_1_primitive_builder.html#a7232c92a1ba781092ee68d2a65196dcf">value_type</a> * </td> + <td class="paramname"><em>values</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::vector< bool > & </td> + <td class="paramname"><em>is_valid</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Append a sequence of elements in one shot. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">values</td><td>a contiguous C array of values </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>the number of values to append </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">is_valid</td><td>an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl> + +</div> +</div> +<a id="ae55dc9d440381381ce139d414e339194"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae55dc9d440381381ce139d414e339194">◆ </a></span>Append() <span class="overload">[3/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Type> </div> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> <a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder</a>< <a class="el" href="structarrow_1_1_type.html">Type</a> >::Append </td> + <td>(</td> + <td class="paramtype">const std::vector< <a class="el" href="classarrow_1_1_primitive_builder.html#a7232c92a1ba781092ee68d2a65196dcf">value_type</a> > & </td> + <td class="paramname"><em>values</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::vector< bool > & </td> + <td class="paramname"><em>is_valid</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Append a sequence of elements in one shot. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">values</td><td>a std::vector of values </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">is_valid</td><td>an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl> + +</div> +</div> +<a id="a1ed12b2856cb1571cb730c3ece8e090d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1ed12b2856cb1571cb730c3ece8e090d">◆ </a></span>Append() <span class="overload">[4/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Type> </div> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> <a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder</a>< <a class="el" href="structarrow_1_1_type.html">Type</a> >::Append </td> + <td>(</td> + <td class="paramtype">const std::vector< <a class="el" href="classarrow_1_1_primitive_builder.html#a7232c92a1ba781092ee68d2a65196dcf">value_type</a> > & </td> + <td class="paramname"><em>values</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Append a sequence of elements in one shot. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">values</td><td>a std::vector of values </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl> </div> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_primitive_c_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_primitive_c_type-members.html b/docs/cpp/classarrow_1_1_primitive_c_type-members.html index 8716bd3..18934e8 100644 --- a/docs/cpp/classarrow_1_1_primitive_c_type-members.html +++ b/docs/cpp/classarrow_1_1_primitive_c_type-members.html @@ -81,9 +81,10 @@ $(function() { <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_fixed_width_type.html#a3e2714cd3cd0c7487e4f801880bd4c94">GetBufferLayout</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_fixed_width_type.html">arrow::FixedWidthType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr><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 class="even"><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><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 class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">ToString</a>() const =0</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#abb9105c8087a4b19f53c61ddf3188c48">~DataType</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">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#a94985d12273f5dd353d6142921299d4d">name</a>() const =0</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">pure 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_data_type.html#a944727354fb11138ebd46368319598f2">ToString</a>() const =0</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#abb9105c8087a4b19f53c61ddf3188c48">~DataType</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">virtual</span></td></tr> </table></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_primitive_c_type.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_primitive_c_type.html b/docs/cpp/classarrow_1_1_primitive_c_type.html index 571097d..5b7a981 100644 --- a/docs/cpp/classarrow_1_1_primitive_c_type.html +++ b/docs/cpp/classarrow_1_1_primitive_c_type.html @@ -79,8 +79,9 @@ Inheritance diagram for arrow::PrimitiveCType:</div> <map id="arrow::PrimitiveCType_map" name="arrow::PrimitiveCType_map"> <area href="classarrow_1_1_fixed_width_type.html" alt="arrow::FixedWidthType" shape="rect" coords="518,56,1026,80"/> <area href="classarrow_1_1_data_type.html" alt="arrow::DataType" shape="rect" coords="518,0,1026,24"/> -<area href="classarrow_1_1_floating_point.html" alt="arrow::FloatingPoint" shape="rect" coords="0,168,508,192"/> -<area href="classarrow_1_1_integer.html" alt="arrow::Integer" shape="rect" coords="1036,168,1544,192"/> +<area href="classarrow_1_1_number.html" alt="arrow::Number" shape="rect" coords="518,168,1026,192"/> +<area href="classarrow_1_1_floating_point.html" alt="arrow::FloatingPoint" shape="rect" coords="0,224,508,248"/> +<area href="classarrow_1_1_integer.html" alt="arrow::Integer" shape="rect" coords="1036,224,1544,248"/> </map> </div></div> <table class="memberdecls"> @@ -109,7 +110,11 @@ Additional Inherited Members</h2></td></tr> <tr class="memitem:adb306e4a8a597a0ff017f4358942130d inherit pub_methods_classarrow_1_1_data_type"><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_data_type.html#adb306e4a8a597a0ff017f4358942130d">Accept</a> (<a class="el" href="classarrow_1_1_type_visitor.html">TypeVisitor</a> *visitor) const =0</td></tr> <tr class="separator:adb306e4a8a597a0ff017f4358942130d inherit pub_methods_classarrow_1_1_data_type"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a944727354fb11138ebd46368319598f2 inherit pub_methods_classarrow_1_1_data_type"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">ToString</a> () const =0</td></tr> +<tr class="memdesc:a944727354fb11138ebd46368319598f2 inherit pub_methods_classarrow_1_1_data_type"><td class="mdescLeft"> </td><td class="mdescRight">A string representation of the type, including any children. <a href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">More...</a><br /></td></tr> <tr class="separator:a944727354fb11138ebd46368319598f2 inherit pub_methods_classarrow_1_1_data_type"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a94985d12273f5dd353d6142921299d4d inherit pub_methods_classarrow_1_1_data_type"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_data_type.html#a94985d12273f5dd353d6142921299d4d">name</a> () const =0</td></tr> +<tr class="memdesc:a94985d12273f5dd353d6142921299d4d inherit pub_methods_classarrow_1_1_data_type"><td class="mdescLeft"> </td><td class="mdescRight">A string name of the type, omitting any child fields. <a href="classarrow_1_1_data_type.html#a94985d12273f5dd353d6142921299d4d">More...</a><br /></td></tr> +<tr class="separator:a94985d12273f5dd353d6142921299d4d inherit pub_methods_classarrow_1_1_data_type"><td class="memSeparator" colspan="2"> </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> <tr class="inherit_header pro_attribs_classarrow_1_1_data_type"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classarrow_1_1_data_type')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_primitive_c_type.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_primitive_c_type.png b/docs/cpp/classarrow_1_1_primitive_c_type.png index dbf84d8..305a683 100644 Binary files a/docs/cpp/classarrow_1_1_primitive_c_type.png and b/docs/cpp/classarrow_1_1_primitive_c_type.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_record_batch-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_record_batch-members.html b/docs/cpp/classarrow_1_1_record_batch-members.html index c4e0c8c..054dc0f 100644 --- a/docs/cpp/classarrow_1_1_record_batch-members.html +++ b/docs/cpp/classarrow_1_1_record_batch-members.html @@ -72,15 +72,15 @@ $(function() { <table class="directory"> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#ae5f6c3764a9b0a8473fb9736c67f8dab">ApproxEquals</a>(const RecordBatch &other) const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#a07bb1d16c31c9689f03271d7c941cdd6">column</a>(int i) const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#a70fd8fd6068eab31d1283cb3647b0808">column_data</a>(int i) const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</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_record_batch.html#ac4090fcb8edc640f16a080e3e6548da3">column_data</a>(int i) const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#a0bd1bad353a59444d1f9ace0590eb0b4">column_name</a>(int i) const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#ad2eaa05788df79e3816c903794b8013a">Equals</a>(const RecordBatch &other) const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#a9cc71f8b2e351ea3e432686172f34546">num_columns</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</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_record_batch.html#aa1012641ffba9c70786dffbb2bb76d4f">num_rows</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#a97fc70434b33542941754a55aab183b5">RecordBatch</a>(const std::shared_ptr< Schema > &schema, int64_t num_rows, const std::vector< std::shared_ptr< Array >> &columns)</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#a68b7781633ddfd37f903d33ce0c6497b">RecordBatch</a>(const std::shared_ptr< Schema > &schema, int64_t num_rows, std::vector< std::shared_ptr< Array >> &&columns)</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#a29e727eb8cbe415e6b4f8e4431e060a5">RecordBatch</a>(const std::shared_ptr< Schema > &schema, int64_t num_rows, std::vector< std::shared_ptr< internal::ArrayData >> &&columns)</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#a29040e912f8129078c9de9cce06d870d">RecordBatch</a>(const std::shared_ptr< Schema > &schema, int64_t num_rows, const std::vector< std::shared_ptr< internal::ArrayData >> &columns)</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#ad52d775d7462351062b79612c20fd494">RecordBatch</a>(const std::shared_ptr< Schema > &schema, int64_t num_rows, std::vector< std::shared_ptr< ArrayData >> &&columns)</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#a74a691b1df7de4406ef3c6a5d123c499">RecordBatch</a>(const std::shared_ptr< Schema > &schema, int64_t num_rows, const std::vector< std::shared_ptr< ArrayData >> &columns)</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#ae8120f630a1f65c6f05af44d91e733e7">ReplaceSchemaMetadata</a>(const std::shared_ptr< const KeyValueMetadata > &metadata) const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#ab12ff2c2d5cca56fc185f9a4dfc64395">schema</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html#ab4f5ad5e79688702ec20daf13511038d">Slice</a>(int64_t offset) const</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></td><td class="entry"></td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_record_batch.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_record_batch.html b/docs/cpp/classarrow_1_1_record_batch.html index 93a150c..45f3de2 100644 --- a/docs/cpp/classarrow_1_1_record_batch.html +++ b/docs/cpp/classarrow_1_1_record_batch.html @@ -79,28 +79,31 @@ $(function() { <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a97fc70434b33542941754a55aab183b5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#a97fc70434b33542941754a55aab183b5">RecordBatch</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="classarrow_1_1_record_batch.html#ab12ff2c2d5cca56fc185f9a4dfc64395">schema</a>, int64_t <a class="el" href="classarrow_1_1_record_batch.html#aa1012641ffba9c70786dffbb2bb76d4f">num_rows</a>, const std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> >> &columns)</td></tr> -<tr class="memdesc:a97fc70434b33542941754a55aab183b5"><td class="mdescLeft"> </td><td class="mdescRight">num_rows is a parameter to allow for record batches of a particular size not having any materialized columns. <a href="#a97fc70434b33542941754a55aab183b5">More...</a><br /></td></tr> <tr class="separator:a97fc70434b33542941754a55aab183b5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a68b7781633ddfd37f903d33ce0c6497b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#a68b7781633ddfd37f903d33ce0c6497b">RecordBatch</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="classarrow_1_1_record_batch.html#ab12ff2c2d5cca56fc185f9a4dfc64395">schema</a>, int64_t <a class="el" href="classarrow_1_1_record_batch.html#aa1012641ffba9c70786dffbb2bb76d4f">num_rows</a>, std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> >> &&columns)</td></tr> -<tr class="memdesc:a68b7781633ddfd37f903d33ce0c6497b"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated move constructor for a vector of <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> instances. <a href="#a68b7781633ddfd37f903d33ce0c6497b">More...</a><br /></td></tr> +<tr class="memdesc:a68b7781633ddfd37f903d33ce0c6497b"><td class="mdescLeft"> </td><td class="mdescRight">Move-based constructor for a vector of <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> instances. <a href="#a68b7781633ddfd37f903d33ce0c6497b">More...</a><br /></td></tr> <tr class="separator:a68b7781633ddfd37f903d33ce0c6497b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a29e727eb8cbe415e6b4f8e4431e060a5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#a29e727eb8cbe415e6b4f8e4431e060a5">RecordBatch</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="classarrow_1_1_record_batch.html#ab12ff2c2d5cca56fc185f9a4dfc64395">schema</a>, int64_t <a class="el" href="classarrow_1_1_record_batch.html#aa1012641ffba9c70786dffbb2bb76d4f">num_rows</a>, std::vector< std::shared_ptr< internal::ArrayData >> &&columns)</td></tr> -<tr class="memdesc:a29e727eb8cbe415e6b4f8e4431e060a5"><td class="mdescLeft"> </td><td class="mdescRight">Construct record batch from vector of internal data structures. <a href="#a29e727eb8cbe415e6b4f8e4431e060a5">More...</a><br /></td></tr> -<tr class="separator:a29e727eb8cbe415e6b4f8e4431e060a5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a29040e912f8129078c9de9cce06d870d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#a29040e912f8129078c9de9cce06d870d">RecordBatch</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="classarrow_1_1_record_batch.html#ab12ff2c2d5cca56fc185f9a4dfc64395">schema</a>, int64_t <a class="el" href="classarrow_1_1_record_batch.html#aa1012641ffba9c70786dffbb2bb76d4f">num_rows</a>, const std::vector< std::shared_ptr< internal::ArrayData >> &columns)</td></tr> -<tr class="memdesc:a29040e912f8129078c9de9cce06d870d"><td class="mdescLeft"> </td><td class="mdescRight">Construct record batch by copying vector of array data. <a href="#a29040e912f8129078c9de9cce06d870d">More...</a><br /></td></tr> -<tr class="separator:a29040e912f8129078c9de9cce06d870d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad52d775d7462351062b79612c20fd494"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#ad52d775d7462351062b79612c20fd494">RecordBatch</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="classarrow_1_1_record_batch.html#ab12ff2c2d5cca56fc185f9a4dfc64395">schema</a>, int64_t <a class="el" href="classarrow_1_1_record_batch.html#aa1012641ffba9c70786dffbb2bb76d4f">num_rows</a>, std::vector< std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> >> &&columns)</td></tr> +<tr class="memdesc:ad52d775d7462351062b79612c20fd494"><td class="mdescLeft"> </td><td class="mdescRight">Construct record batch from vector of internal data structures. <a href="#ad52d775d7462351062b79612c20fd494">More...</a><br /></td></tr> +<tr class="separator:ad52d775d7462351062b79612c20fd494"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a74a691b1df7de4406ef3c6a5d123c499"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#a74a691b1df7de4406ef3c6a5d123c499">RecordBatch</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="classarrow_1_1_record_batch.html#ab12ff2c2d5cca56fc185f9a4dfc64395">schema</a>, int64_t <a class="el" href="classarrow_1_1_record_batch.html#aa1012641ffba9c70786dffbb2bb76d4f">num_rows</a>, const std::vector< std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> >> &columns)</td></tr> +<tr class="memdesc:a74a691b1df7de4406ef3c6a5d123c499"><td class="mdescLeft"> </td><td class="mdescRight">Construct record batch by copying vector of array data. <a href="#a74a691b1df7de4406ef3c6a5d123c499">More...</a><br /></td></tr> +<tr class="separator:a74a691b1df7de4406ef3c6a5d123c499"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad2eaa05788df79e3816c903794b8013a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#ad2eaa05788df79e3816c903794b8013a">Equals</a> (const <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> &other) const</td></tr> +<tr class="memdesc:ad2eaa05788df79e3816c903794b8013a"><td class="mdescLeft"> </td><td class="mdescRight">Determine if two record batches are exactly equal. <a href="#ad2eaa05788df79e3816c903794b8013a">More...</a><br /></td></tr> <tr class="separator:ad2eaa05788df79e3816c903794b8013a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae5f6c3764a9b0a8473fb9736c67f8dab"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#ae5f6c3764a9b0a8473fb9736c67f8dab">ApproxEquals</a> (const <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> &other) const</td></tr> +<tr class="memdesc:ae5f6c3764a9b0a8473fb9736c67f8dab"><td class="mdescLeft"> </td><td class="mdescRight">Determine if two record batches are approximately equal. <a href="#ae5f6c3764a9b0a8473fb9736c67f8dab">More...</a><br /></td></tr> <tr class="separator:ae5f6c3764a9b0a8473fb9736c67f8dab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab12ff2c2d5cca56fc185f9a4dfc64395"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#ab12ff2c2d5cca56fc185f9a4dfc64395">schema</a> () const</td></tr> <tr class="separator:ab12ff2c2d5cca56fc185f9a4dfc64395"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a07bb1d16c31c9689f03271d7c941cdd6"><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_record_batch.html#a07bb1d16c31c9689f03271d7c941cdd6">column</a> (int i) const</td></tr> +<tr class="memdesc:a07bb1d16c31c9689f03271d7c941cdd6"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve an array from the record batch. <a href="#a07bb1d16c31c9689f03271d7c941cdd6">More...</a><br /></td></tr> <tr class="separator:a07bb1d16c31c9689f03271d7c941cdd6"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a70fd8fd6068eab31d1283cb3647b0808"><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_record_batch.html#a70fd8fd6068eab31d1283cb3647b0808">column_data</a> (int i) const</td></tr> -<tr class="separator:a70fd8fd6068eab31d1283cb3647b0808"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac4090fcb8edc640f16a080e3e6548da3"><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_record_batch.html#ac4090fcb8edc640f16a080e3e6548da3">column_data</a> (int i) const</td></tr> +<tr class="separator:ac4090fcb8edc640f16a080e3e6548da3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0bd1bad353a59444d1f9ace0590eb0b4"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#a0bd1bad353a59444d1f9ace0590eb0b4">column_name</a> (int i) const</td></tr> +<tr class="memdesc:a0bd1bad353a59444d1f9ace0590eb0b4"><td class="mdescLeft"> </td><td class="mdescRight">Name in i-th column. <a href="#a0bd1bad353a59444d1f9ace0590eb0b4">More...</a><br /></td></tr> <tr class="separator:a0bd1bad353a59444d1f9ace0590eb0b4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9cc71f8b2e351ea3e432686172f34546"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#a9cc71f8b2e351ea3e432686172f34546">num_columns</a> () const</td></tr> <tr class="separator:a9cc71f8b2e351ea3e432686172f34546"><td class="memSeparator" colspan="2"> </td></tr> @@ -110,9 +113,10 @@ Public Member Functions</h2></td></tr> <tr class="memdesc:ae8120f630a1f65c6f05af44d91e733e7"><td class="mdescLeft"> </td><td class="mdescRight">Replace schema key-value metadata with new metadata (EXPERIMENTAL) <a href="#ae8120f630a1f65c6f05af44d91e733e7">More...</a><br /></td></tr> <tr class="separator:ae8120f630a1f65c6f05af44d91e733e7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab4f5ad5e79688702ec20daf13511038d"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#ab4f5ad5e79688702ec20daf13511038d">Slice</a> (int64_t offset) const</td></tr> -<tr class="memdesc:ab4f5ad5e79688702ec20daf13511038d"><td class="mdescLeft"> </td><td class="mdescRight">Slice each of the arrays in the record batch and construct a new <a class="el" href="classarrow_1_1_record_batch.html" title="Collection of equal-length arrays matching a particular Schema. ">RecordBatch</a> object. <a href="#ab4f5ad5e79688702ec20daf13511038d">More...</a><br /></td></tr> +<tr class="memdesc:ab4f5ad5e79688702ec20daf13511038d"><td class="mdescLeft"> </td><td class="mdescRight">Slice each of the arrays in the record batch. <a href="#ab4f5ad5e79688702ec20daf13511038d">More...</a><br /></td></tr> <tr class="separator:ab4f5ad5e79688702ec20daf13511038d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aad1415d5cfbff7169610b33f4c4e0b3f"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch.html#aad1415d5cfbff7169610b33f4c4e0b3f">Slice</a> (int64_t offset, int64_t length) const</td></tr> +<tr class="memdesc:aad1415d5cfbff7169610b33f4c4e0b3f"><td class="mdescLeft"> </td><td class="mdescRight">Slice each of the arrays in the record batch. <a href="#aad1415d5cfbff7169610b33f4c4e0b3f">More...</a><br /></td></tr> <tr class="separator:aad1415d5cfbff7169610b33f4c4e0b3f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8de1cd6996fb69c9d659cd0dbe1437bf"><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_record_batch.html#a8de1cd6996fb69c9d659cd0dbe1437bf">Validate</a> () const</td></tr> <tr class="memdesc:a8de1cd6996fb69c9d659cd0dbe1437bf"><td class="mdescLeft"> </td><td class="mdescRight">Check for schema or length inconsistencies. <a href="#a8de1cd6996fb69c9d659cd0dbe1437bf">More...</a><br /></td></tr> @@ -153,9 +157,14 @@ Public Member Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> - -<p>num_rows is a parameter to allow for record batches of a particular size not having any materialized columns. </p> -<p>Each array should have the same length as num_rows </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">schema</td><td></td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">num_rows</td><td>length of fields in the record batch. Each array should have the same length as num_rows </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">columns</td><td>the record batch fields as vector of arrays </td></tr> + </table> + </dd> +</dl> </div> </div> @@ -191,12 +200,12 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Deprecated move constructor for a vector of <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> instances. </p> +<p>Move-based constructor for a vector of <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> instances. </p> </div> </div> -<a id="a29e727eb8cbe415e6b4f8e4431e060a5"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a29e727eb8cbe415e6b4f8e4431e060a5">◆ </a></span>RecordBatch() <span class="overload">[3/4]</span></h2> +<a id="ad52d775d7462351062b79612c20fd494"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad52d775d7462351062b79612c20fd494">◆ </a></span>RecordBatch() <span class="overload">[3/4]</span></h2> <div class="memitem"> <div class="memproto"> @@ -216,7 +225,7 @@ Public Member Functions</h2></td></tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">std::vector< std::shared_ptr< internal::ArrayData >> && </td> + <td class="paramtype">std::vector< std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> >> && </td> <td class="paramname"><em>columns</em> </td> </tr> <tr> @@ -241,8 +250,8 @@ Public Member Functions</h2></td></tr> </div> </div> -<a id="a29040e912f8129078c9de9cce06d870d"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a29040e912f8129078c9de9cce06d870d">◆ </a></span>RecordBatch() <span class="overload">[4/4]</span></h2> +<a id="a74a691b1df7de4406ef3c6a5d123c499"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a74a691b1df7de4406ef3c6a5d123c499">◆ </a></span>RecordBatch() <span class="overload">[4/4]</span></h2> <div class="memitem"> <div class="memproto"> @@ -262,7 +271,7 @@ Public Member Functions</h2></td></tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">const std::vector< std::shared_ptr< internal::ArrayData >> & </td> + <td class="paramtype">const std::vector< std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> >> & </td> <td class="paramname"><em>columns</em> </td> </tr> <tr> @@ -295,6 +304,8 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Determine if two record batches are approximately equal. </p> + </div> </div> <a id="a07bb1d16c31c9689f03271d7c941cdd6"></a> @@ -313,10 +324,19 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Retrieve an array from the record batch. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>field index, does not boundscheck </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>an <a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">Array</a> object </dd></dl> + </div> </div> -<a id="a70fd8fd6068eab31d1283cb3647b0808"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a70fd8fd6068eab31d1283cb3647b0808">◆ </a></span>column_data()</h2> +<a id="ac4090fcb8edc640f16a080e3e6548da3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac4090fcb8edc640f16a080e3e6548da3">◆ </a></span>column_data()</h2> <div class="memitem"> <div class="memproto"> @@ -325,7 +345,7 @@ Public Member Functions</h2></td></tr> <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">std::shared_ptr<internal::ArrayData> arrow::RecordBatch::column_data </td> + <td class="memname">std::shared_ptr<<a class="el" href="structarrow_1_1_array_data.html">ArrayData</a>> arrow::RecordBatch::column_data </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>i</em></td><td>)</td> @@ -357,6 +377,8 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Name in i-th column. </p> + </div> </div> <a id="ad2eaa05788df79e3816c903794b8013a"></a> @@ -375,6 +397,9 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Determine if two record batches are exactly equal. </p> +<dl class="section return"><dt>Returns</dt><dd>true if batches are equal </dd></dl> + </div> </div> <a id="a9cc71f8b2e351ea3e432686172f34546"></a> @@ -399,6 +424,7 @@ Public Member Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the number of columns in the table </dd></dl> </div> </div> @@ -424,6 +450,7 @@ Public Member Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the number of rows (the corresponding length of each column) </dd></dl> </div> </div> @@ -477,6 +504,7 @@ Public Member Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>true if batches are equal </dd></dl> </div> </div> @@ -496,7 +524,14 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Slice each of the arrays in the record batch and construct a new <a class="el" href="classarrow_1_1_record_batch.html" title="Collection of equal-length arrays matching a particular Schema. ">RecordBatch</a> object. </p> +<p>Slice each of the arrays in the record batch. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>the starting offset to slice, through end of batch </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>new record batch </dd></dl> </div> </div> @@ -526,6 +561,16 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Slice each of the arrays in the record batch. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>the starting offset to slice </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>the number of elements to slice from offset </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>new record batch </dd></dl> + </div> </div> <a id="a8de1cd6996fb69c9d659cd0dbe1437bf"></a> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_record_batch_reader-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_record_batch_reader-members.html b/docs/cpp/classarrow_1_1_record_batch_reader-members.html new file mode 100644 index 0000000..4fc940c --- /dev/null +++ b/docs/cpp/classarrow_1_1_record_batch_reader-members.html @@ -0,0 +1,85 @@ +<!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="classarrow_1_1_record_batch_reader.html">RecordBatchReader</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">arrow::RecordBatchReader 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_record_batch_reader.html">arrow::RecordBatchReader</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html#aaffe944df9d8a4c3e6592eb2f8f78f9f">ReadNext</a>(std::shared_ptr< RecordBatch > *batch)=0</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html#a8ac4623435d60509ac5a5ec22c98d59b">ReadNextRecordBatch</a>(std::shared_ptr< RecordBatch > *batch)</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html#ad2ded865a6720e61e4685cfd34ed377f">schema</a>() const =0</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html#ad8660ce224397979fbf0da8898e55047">~RecordBatchReader</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</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_1_record_batch_reader.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_record_batch_reader.html b/docs/cpp/classarrow_1_1_record_batch_reader.html new file mode 100644 index 0000000..21dfe18 --- /dev/null +++ b/docs/cpp/classarrow_1_1_record_batch_reader.html @@ -0,0 +1,225 @@ +<!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::RecordBatchReader 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="classarrow_1_1_record_batch_reader.html">RecordBatchReader</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarrow_1_1_record_batch_reader-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">arrow::RecordBatchReader Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>Abstract interface for reading stream of record batches. + <a href="classarrow_1_1_record_batch_reader.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="table_8h_source.html">table.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for arrow::RecordBatchReader:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarrow_1_1_record_batch_reader.png" usemap="#arrow::RecordBatchReader_map" alt=""/> + <map id="arrow::RecordBatchReader_map" name="arrow::RecordBatchReader_map"> +<area href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html" title="Synchronous batch stream reader that reads from io::InputStream. " alt="arrow::ipc::RecordBatchStreamReader" shape="rect" coords="0,56,227,80"/> +<area href="classarrow_1_1_table_batch_reader.html" title="Compute a sequence of record batches from a (possibly chunked) Table. " alt="arrow::TableBatchReader" shape="rect" coords="237,56,464,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:ad8660ce224397979fbf0da8898e55047"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch_reader.html#ad8660ce224397979fbf0da8898e55047">~RecordBatchReader</a> ()</td></tr> +<tr class="separator:ad8660ce224397979fbf0da8898e55047"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad2ded865a6720e61e4685cfd34ed377f"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch_reader.html#ad2ded865a6720e61e4685cfd34ed377f">schema</a> () const =0</td></tr> +<tr class="separator:ad2ded865a6720e61e4685cfd34ed377f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaffe944df9d8a4c3e6592eb2f8f78f9f"><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_record_batch_reader.html#aaffe944df9d8a4c3e6592eb2f8f78f9f">ReadNext</a> (std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > *batch)=0</td></tr> +<tr class="memdesc:aaffe944df9d8a4c3e6592eb2f8f78f9f"><td class="mdescLeft"> </td><td class="mdescRight">Read the next record batch in the stream. <a href="#aaffe944df9d8a4c3e6592eb2f8f78f9f">More...</a><br /></td></tr> +<tr class="separator:aaffe944df9d8a4c3e6592eb2f8f78f9f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8ac4623435d60509ac5a5ec22c98d59b"><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_record_batch_reader.html#a8ac4623435d60509ac5a5ec22c98d59b">ReadNextRecordBatch</a> (std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > *batch)</td></tr> +<tr class="separator:a8ac4623435d60509ac5a5ec22c98d59b"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Abstract interface for reading stream of record batches. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ad8660ce224397979fbf0da8898e55047"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad8660ce224397979fbf0da8898e55047">◆ </a></span>~RecordBatchReader()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual arrow::RecordBatchReader::~RecordBatchReader </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> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="aaffe944df9d8a4c3e6592eb2f8f78f9f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aaffe944df9d8a4c3e6592eb2f8f78f9f">◆ </a></span>ReadNext()</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::RecordBatchReader::ReadNext </td> + <td>(</td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > * </td> + <td class="paramname"><em>batch</em></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"> + +<p>Read the next record batch in the stream. </p> +<p>Return nullptr for batch when reaching end of stream</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname"></td><td></td></tr> + </table> + </dd> +</dl> + +<p>Implemented in <a class="el" href="classarrow_1_1_table_batch_reader.html#a31d001eabe7404ee8e3d7a568eae0e93">arrow::TableBatchReader</a>, and <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#ae8a274f899c14b9b8d629e658609b96f">arrow::ipc::RecordBatchStreamReader</a>.</p> + +</div> +</div> +<a id="a8ac4623435d60509ac5a5ec22c98d59b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8ac4623435d60509ac5a5ec22c98d59b">◆ </a></span>ReadNextRecordBatch()</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::RecordBatchReader::ReadNextRecordBatch </td> + <td>(</td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > * </td> + <td class="paramname"><em>batch</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>Since 0.7.0 </dd></dl> + +</div> +</div> +<a id="ad2ded865a6720e61e4685cfd34ed377f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad2ded865a6720e61e4685cfd34ed377f">◆ </a></span>schema()</h2> + +<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_schema.html">Schema</a>> arrow::RecordBatchReader::schema </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">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the shared schema of the record batches in the stream </dd></dl> + +<p>Implemented in <a class="el" href="classarrow_1_1_table_batch_reader.html#a278674b3b9a78fdbccc3f3d52fc5d470">arrow::TableBatchReader</a>, and <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a6955614f73bb4a6a62cbac895648a322">arrow::ipc::RecordBatchStreamReader</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/wesm/code/arrow/cpp/src/arrow/<a class="el" href="table_8h_source.html">table.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_1_record_batch_reader.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_record_batch_reader.png b/docs/cpp/classarrow_1_1_record_batch_reader.png new file mode 100644 index 0000000..375bdd2 Binary files /dev/null and b/docs/cpp/classarrow_1_1_record_batch_reader.png differ