http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_buffer_builder-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_buffer_builder-members.html b/docs/cpp/classarrow_1_1_buffer_builder-members.html index 06cb9e7..d87a7c3 100644 --- a/docs/cpp/classarrow_1_1_buffer_builder-members.html +++ b/docs/cpp/classarrow_1_1_buffer_builder-members.html @@ -74,10 +74,10 @@ $(function() { <p>This is the complete list of members for <a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a>, including all inherited members.</p> <table class="directory"> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#ab7ba2e8716f69a8bccd68aa33cc12286">Advance</a>(const int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#a861a36589ea59cee1125d3251bfae30c">Append</a>(const uint8_t *data, int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#a1954e434193889884ee894cc15052db7">Append</a>(const void *data, int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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_buffer_builder.html#a6d1756245bb061a66e69e0e8ffbd4aac">Append</a>(const std::array< uint8_t, NBYTES > &data)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#a17f7b6b8005f1f14be61c5270776158a">buffer_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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_buffer_builder.html#ac574703fa5c840f84056200bc553365a">BufferBuilder</a>(MemoryPool *pool)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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_buffer_builder.html#a89b37be7cfb50fe27cf7b93ec7417add">BufferBuilder</a>(MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#a1728b024c99b4255177659c6dcd0b650">capacity</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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_buffer_builder.html#a91cd1d83d90defa391115f3fbdc03d63">capacity_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#a44d11575460cb39216ae61999a29fa2f">data</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> @@ -85,10 +85,11 @@ $(function() { <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#a3ca4455a595c3b8864feae94044f399e">Finish</a>(std::shared_ptr< Buffer > *out)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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_buffer_builder.html#a9c3803b7ecb1c2c122a95b2346fbb0a2">length</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#ad4b857975203084d5856758a90f669a4">pool_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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_buffer_builder.html#ae8d4ba958542c2f74dbab41d1456e6aa">Reset</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#a8bdd654fab07e1151945e8ba4e6ee39e">Resize</a>(const int64_t elements)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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_buffer_builder.html#ae2580f25b0c08e4bf6e0656d365b0bff">size_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#acb2881c13261f9755518d76ed5c4b9b6">UnsafeAppend</a>(const uint8_t *data, int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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_buffer_builder.html#afac16a92de1d0349a9395addfe7d67bb">Reserve</a>(const int64_t size)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#ae8d4ba958542c2f74dbab41d1456e6aa">Reset</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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_buffer_builder.html#a7d037234bc80bdf7505c953e1317a429">Resize</a>(const int64_t elements, bool shrink_to_fit=true)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#ae2580f25b0c08e4bf6e0656d365b0bff">size_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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_buffer_builder.html#a026c9ae142a22641e9ef26afcf850641">UnsafeAppend</a>(const void *data, int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> </table></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_buffer_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_buffer_builder.html b/docs/cpp/classarrow_1_1_buffer_builder.html index 50a4e69..c55f2c3 100644 --- a/docs/cpp/classarrow_1_1_buffer_builder.html +++ b/docs/cpp/classarrow_1_1_buffer_builder.html @@ -75,6 +75,9 @@ $(function() { </div><!--header--> <div class="contents"> +<p>A class for incrementally building a contiguous chunk of in-memory data. + <a href="classarrow_1_1_buffer_builder.html#details">More...</a></p> + <p><code>#include <<a class="el" href="buffer_8h_source.html">arrow/buffer.h</a>></code></p> <div class="dynheader"> Inheritance diagram for arrow::BufferBuilder:</div> @@ -90,20 +93,23 @@ Inheritance diagram for arrow::BufferBuilder:</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:ac574703fa5c840f84056200bc553365a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#ac574703fa5c840f84056200bc553365a">BufferBuilder</a> (<a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool)</td></tr> -<tr class="separator:ac574703fa5c840f84056200bc553365a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a8bdd654fab07e1151945e8ba4e6ee39e"><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_buffer_builder.html#a8bdd654fab07e1151945e8ba4e6ee39e">Resize</a> (const int64_t elements)</td></tr> -<tr class="memdesc:a8bdd654fab07e1151945e8ba4e6ee39e"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the buffer to the nearest multiple of 64 bytes per Layout.md. <a href="#a8bdd654fab07e1151945e8ba4e6ee39e">More...</a><br /></td></tr> -<tr class="separator:a8bdd654fab07e1151945e8ba4e6ee39e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a861a36589ea59cee1125d3251bfae30c"><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_buffer_builder.html#a861a36589ea59cee1125d3251bfae30c">Append</a> (const uint8_t *<a class="el" href="classarrow_1_1_buffer_builder.html#a44d11575460cb39216ae61999a29fa2f">data</a>, int64_t <a class="el" href="classarrow_1_1_buffer_builder.html#a9c3803b7ecb1c2c122a95b2346fbb0a2">length</a>)</td></tr> -<tr class="separator:a861a36589ea59cee1125d3251bfae30c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a89b37be7cfb50fe27cf7b93ec7417add"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#a89b37be7cfb50fe27cf7b93ec7417add">BufferBuilder</a> (<a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool <a class="el" href="memory__pool_8h.html#a45892ac769df8063a376c306735ff637">ARROW_MEMORY_POOL_DEFAULT</a>)</td></tr> +<tr class="separator:a89b37be7cfb50fe27cf7b93ec7417add"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7d037234bc80bdf7505c953e1317a429"><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_buffer_builder.html#a7d037234bc80bdf7505c953e1317a429">Resize</a> (const int64_t elements, bool shrink_to_fit=true)</td></tr> +<tr class="memdesc:a7d037234bc80bdf7505c953e1317a429"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the buffer to the nearest multiple of 64 bytes. <a href="#a7d037234bc80bdf7505c953e1317a429">More...</a><br /></td></tr> +<tr class="separator:a7d037234bc80bdf7505c953e1317a429"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afac16a92de1d0349a9395addfe7d67bb"><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_buffer_builder.html#afac16a92de1d0349a9395addfe7d67bb">Reserve</a> (const int64_t size)</td></tr> +<tr class="memdesc:afac16a92de1d0349a9395addfe7d67bb"><td class="mdescLeft"> </td><td class="mdescRight">Ensure that builder can accommodate the additional number of bytes without the need to perform allocations. <a href="#afac16a92de1d0349a9395addfe7d67bb">More...</a><br /></td></tr> +<tr class="separator:afac16a92de1d0349a9395addfe7d67bb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1954e434193889884ee894cc15052db7"><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_buffer_builder.html#a1954e434193889884ee894cc15052db7">Append</a> (const void *<a class="el" href="classarrow_1_1_buffer_builder.html#a44d11575460cb39216ae61999a29fa2f">data</a>, int64_t <a class="el" href="classarrow_1_1_buffer_builder.html#a9c3803b7ecb1c2c122a95b2346fbb0a2">length</a>)</td></tr> +<tr class="separator:a1954e434193889884ee894cc15052db7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6d1756245bb061a66e69e0e8ffbd4aac"><td class="memTemplParams" colspan="2">template<size_t NBYTES> </td></tr> <tr class="memitem:a6d1756245bb061a66e69e0e8ffbd4aac"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#a6d1756245bb061a66e69e0e8ffbd4aac">Append</a> (const std::array< uint8_t, NBYTES > &<a class="el" href="classarrow_1_1_buffer_builder.html#a44d11575460cb39216ae61999a29fa2f">data</a>)</td></tr> <tr class="separator:a6d1756245bb061a66e69e0e8ffbd4aac"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab7ba2e8716f69a8bccd68aa33cc12286"><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_buffer_builder.html#ab7ba2e8716f69a8bccd68aa33cc12286">Advance</a> (const int64_t <a class="el" href="classarrow_1_1_buffer_builder.html#a9c3803b7ecb1c2c122a95b2346fbb0a2">length</a>)</td></tr> <tr class="separator:ab7ba2e8716f69a8bccd68aa33cc12286"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:acb2881c13261f9755518d76ed5c4b9b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#acb2881c13261f9755518d76ed5c4b9b6">UnsafeAppend</a> (const uint8_t *<a class="el" href="classarrow_1_1_buffer_builder.html#a44d11575460cb39216ae61999a29fa2f">data</a>, int64_t <a class="el" href="classarrow_1_1_buffer_builder.html#a9c3803b7ecb1c2c122a95b2346fbb0a2">length</a>)</td></tr> -<tr class="separator:acb2881c13261f9755518d76ed5c4b9b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a026c9ae142a22641e9ef26afcf850641"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#a026c9ae142a22641e9ef26afcf850641">UnsafeAppend</a> (const void *<a class="el" href="classarrow_1_1_buffer_builder.html#a44d11575460cb39216ae61999a29fa2f">data</a>, int64_t <a class="el" href="classarrow_1_1_buffer_builder.html#a9c3803b7ecb1c2c122a95b2346fbb0a2">length</a>)</td></tr> +<tr class="separator:a026c9ae142a22641e9ef26afcf850641"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3ca4455a595c3b8864feae94044f399e"><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_buffer_builder.html#a3ca4455a595c3b8864feae94044f399e">Finish</a> (std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > *out)</td></tr> <tr class="separator:a3ca4455a595c3b8864feae94044f399e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae8d4ba958542c2f74dbab41d1456e6aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#ae8d4ba958542c2f74dbab41d1456e6aa">Reset</a> ()</td></tr> @@ -128,9 +134,11 @@ Protected Attributes</h2></td></tr> <tr class="memitem:ae2580f25b0c08e4bf6e0656d365b0bff"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#ae2580f25b0c08e4bf6e0656d365b0bff">size_</a></td></tr> <tr class="separator:ae2580f25b0c08e4bf6e0656d365b0bff"><td class="memSeparator" colspan="2"> </td></tr> </table> -<h2 class="groupheader">Constructor & Destructor Documentation</h2> -<a id="ac574703fa5c840f84056200bc553365a"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ac574703fa5c840f84056200bc553365a">◆ </a></span>BufferBuilder()</h2> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>A class for incrementally building a contiguous chunk of in-memory data. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a89b37be7cfb50fe27cf7b93ec7417add"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a89b37be7cfb50fe27cf7b93ec7417add">◆ </a></span>BufferBuilder()</h2> <div class="memitem"> <div class="memproto"> @@ -141,8 +149,8 @@ Protected Attributes</h2></td></tr> <tr> <td class="memname">arrow::BufferBuilder::BufferBuilder </td> <td>(</td> - <td class="paramtype"><a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> * </td> - <td class="paramname"><em>pool</em></td><td>)</td> + <td class="paramtype"><a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool </td> + <td class="paramname"><em>ARROW_MEMORY_POOL_DEFAULT</em></td><td>)</td> <td></td> </tr> </table> @@ -182,8 +190,8 @@ Protected Attributes</h2></td></tr> </div> </div> -<a id="a861a36589ea59cee1125d3251bfae30c"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a861a36589ea59cee1125d3251bfae30c">◆ </a></span>Append() <span class="overload">[1/2]</span></h2> +<a id="a1954e434193889884ee894cc15052db7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1954e434193889884ee894cc15052db7">◆ </a></span>Append() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> @@ -194,7 +202,7 @@ Protected Attributes</h2></td></tr> <tr> <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::BufferBuilder::Append </td> <td>(</td> - <td class="paramtype">const uint8_t * </td> + <td class="paramtype">const void * </td> <td class="paramname"><em>data</em>, </td> </tr> <tr> @@ -347,6 +355,41 @@ template<size_t NBYTES> </div> </div> </div> +<a id="afac16a92de1d0349a9395addfe7d67bb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afac16a92de1d0349a9395addfe7d67bb">◆ </a></span>Reserve()</h2> + +<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::BufferBuilder::Reserve </td> + <td>(</td> + <td class="paramtype">const int64_t </td> + <td class="paramname"><em>size</em></td><td>)</td> + <td></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>Ensure that builder can accommodate the additional number of bytes without the need to perform allocations. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">size</td><td>number of additional bytes to make space for </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="ae8d4ba958542c2f74dbab41d1456e6aa"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae8d4ba958542c2f74dbab41d1456e6aa">◆ </a></span>Reset()</h2> @@ -372,8 +415,8 @@ template<size_t NBYTES> </div> </div> </div> -<a id="a8bdd654fab07e1151945e8ba4e6ee39e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a8bdd654fab07e1151945e8ba4e6ee39e">◆ </a></span>Resize()</h2> +<a id="a7d037234bc80bdf7505c953e1317a429"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7d037234bc80bdf7505c953e1317a429">◆ </a></span>Resize()</h2> <div class="memitem"> <div class="memproto"> @@ -385,8 +428,18 @@ template<size_t NBYTES> </div> <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::BufferBuilder::Resize </td> <td>(</td> <td class="paramtype">const int64_t </td> - <td class="paramname"><em>elements</em></td><td>)</td> + <td class="paramname"><em>elements</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>shrink_to_fit</em> = <code>true</code> </td> + </tr> + <tr> <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> </td> @@ -396,12 +449,20 @@ template<size_t NBYTES> </div> </table> </div><div class="memdoc"> -<p>Resizes the buffer to the nearest multiple of 64 bytes per Layout.md. </p> +<p>Resizes the buffer to the nearest multiple of 64 bytes. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">elements</td><td>the new capacity of the of the builder. Will be rounded up to a multiple of 64 bytes for padding </td></tr> + <tr><td class="paramname">shrink_to_fit</td><td>if new capacity smaller than existing size, reallocate internal buffer. Set to false to avoid reallocations when shrinking the builder </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="acb2881c13261f9755518d76ed5c4b9b6"></a> -<h2 class="memtitle"><span class="permalink"><a href="#acb2881c13261f9755518d76ed5c4b9b6">◆ </a></span>UnsafeAppend()</h2> +<a id="a026c9ae142a22641e9ef26afcf850641"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a026c9ae142a22641e9ef26afcf850641">◆ </a></span>UnsafeAppend()</h2> <div class="memitem"> <div class="memproto"> @@ -412,7 +473,7 @@ template<size_t NBYTES> </div> <tr> <td class="memname">void arrow::BufferBuilder::UnsafeAppend </td> <td>(</td> - <td class="paramtype">const uint8_t * </td> + <td class="paramtype">const void * </td> <td class="paramname"><em>data</em>, </td> </tr> <tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_chunked_array-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_chunked_array-members.html b/docs/cpp/classarrow_1_1_chunked_array-members.html index 95f3683..d3b615f 100644 --- a/docs/cpp/classarrow_1_1_chunked_array-members.html +++ b/docs/cpp/classarrow_1_1_chunked_array-members.html @@ -84,6 +84,8 @@ $(function() { <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html#a962541b044ac5a7a6a87499cef7957bb">null_count</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html">arrow::ChunkedArray</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html#a45ef30e6a7823f1666b0f50ecde903a7">null_count_</a></td><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html">arrow::ChunkedArray</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_chunked_array.html#afa477fd2e9a3ce9131d9d7f4391de52b">num_chunks</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html">arrow::ChunkedArray</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html#a99573028501f20b3f0707d85e8cce2ad">Slice</a>(int64_t offset, int64_t length) const</td><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html">arrow::ChunkedArray</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html#abf30b26c92cf037191e8574763e22a2e">Slice</a>(int64_t offset) const</td><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html">arrow::ChunkedArray</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html#adb15afa228802d9fab0f3993a4f82df2">type</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_chunked_array.html">arrow::ChunkedArray</a></td><td class="entry"></td></tr> </table></div><!-- contents --> <!-- start footer part --> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_chunked_array.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_chunked_array.html b/docs/cpp/classarrow_1_1_chunked_array.html index fe76de1..06455d7 100644 --- a/docs/cpp/classarrow_1_1_chunked_array.html +++ b/docs/cpp/classarrow_1_1_chunked_array.html @@ -94,6 +94,12 @@ Public Member Functions</h2></td></tr> <tr class="separator:a92ec02f5904ac3e4dac5328e44ebf0fb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af53b92e2594cbe9d84710256e295586a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacearrow.html#ad77c54b51dac02d857f3a26d11ed58b3">ArrayVector</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_chunked_array.html#af53b92e2594cbe9d84710256e295586a">chunks</a> () const</td></tr> <tr class="separator:af53b92e2594cbe9d84710256e295586a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a99573028501f20b3f0707d85e8cce2ad"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_chunked_array.html">ChunkedArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_chunked_array.html#a99573028501f20b3f0707d85e8cce2ad">Slice</a> (int64_t offset, int64_t <a class="el" href="classarrow_1_1_chunked_array.html#a4df41bf1a05cd1083a2c4502e0a85f87">length</a>) const</td></tr> +<tr class="memdesc:a99573028501f20b3f0707d85e8cce2ad"><td class="mdescLeft"> </td><td class="mdescRight">Construct a zero-copy slice of the chunked array with the indicated offset and length. <a href="#a99573028501f20b3f0707d85e8cce2ad">More...</a><br /></td></tr> +<tr class="separator:a99573028501f20b3f0707d85e8cce2ad"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abf30b26c92cf037191e8574763e22a2e"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_chunked_array.html">ChunkedArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_chunked_array.html#abf30b26c92cf037191e8574763e22a2e">Slice</a> (int64_t offset) const</td></tr> +<tr class="memdesc:abf30b26c92cf037191e8574763e22a2e"><td class="mdescLeft"> </td><td class="mdescRight">Slice from offset until end of the chunked array. <a href="#abf30b26c92cf037191e8574763e22a2e">More...</a><br /></td></tr> +<tr class="separator:abf30b26c92cf037191e8574763e22a2e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adb15afa228802d9fab0f3993a4f82df2"><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_chunked_array.html#adb15afa228802d9fab0f3993a4f82df2">type</a> () const</td></tr> <tr class="separator:adb15afa228802d9fab0f3993a4f82df2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab7ad74cc587d5d622c7e62cbf1b0b9f9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_chunked_array.html#ab7ad74cc587d5d622c7e62cbf1b0b9f9">Equals</a> (const <a class="el" href="classarrow_1_1_chunked_array.html">ChunkedArray</a> &other) const</td></tr> @@ -276,6 +282,7 @@ Protected Attributes</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the total number of nulls among all chunks </dd></dl> </div> </div> @@ -304,6 +311,64 @@ Protected Attributes</h2></td></tr> </div> </div> +<a id="a99573028501f20b3f0707d85e8cce2ad"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a99573028501f20b3f0707d85e8cce2ad">◆ </a></span>Slice() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_chunked_array.html">ChunkedArray</a>> arrow::ChunkedArray::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> +</div><div class="memdoc"> + +<p>Construct a zero-copy slice of the chunked 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 chunked 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<ChunkedArray> </dd></dl> + +</div> +</div> +<a id="abf30b26c92cf037191e8574763e22a2e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abf30b26c92cf037191e8574763e22a2e">◆ </a></span>Slice() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_chunked_array.html">ChunkedArray</a>> arrow::ChunkedArray::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 chunked array. </p> + +</div> +</div> <a id="adb15afa228802d9fab0f3993a4f82df2"></a> <h2 class="memtitle"><span class="permalink"><a href="#adb15afa228802d9fab0f3993a4f82df2">◆ </a></span>type()</h2> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_column-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_column-members.html b/docs/cpp/classarrow_1_1_column-members.html index 9069122..ab5776f 100644 --- a/docs/cpp/classarrow_1_1_column-members.html +++ b/docs/cpp/classarrow_1_1_column-members.html @@ -86,6 +86,8 @@ $(function() { <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_column.html#aafda8e7be9dbc335820622b4e98e9bdd">length</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_column.html">arrow::Column</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_column.html#a6e9aad20d90a5584d46a773dfafc3d2d">name</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_column.html">arrow::Column</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_column.html#ab8d98c9a76cae4bc7ac69085b3841d38">null_count</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_column.html">arrow::Column</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_column.html#acbb4e294e3858fdc815ff8882667953a">Slice</a>(int64_t offset, int64_t length) const</td><td class="entry"><a class="el" href="classarrow_1_1_column.html">arrow::Column</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_column.html#a1554f89be714c2f6ec5ba2da4baf1930">Slice</a>(int64_t offset) const</td><td class="entry"><a class="el" href="classarrow_1_1_column.html">arrow::Column</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_column.html#a3654c4e1f5272c46a287b4f31ae3175a">type</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_column.html">arrow::Column</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_column.html#a1a26dc8ee0f1ddca5da50bab6f39f1d7">ValidateData</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_column.html">arrow::Column</a></td><td class="entry"></td></tr> </table></div><!-- contents --> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_column.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_column.html b/docs/cpp/classarrow_1_1_column.html index c43c859..5422b84 100644 --- a/docs/cpp/classarrow_1_1_column.html +++ b/docs/cpp/classarrow_1_1_column.html @@ -75,7 +75,7 @@ $(function() { </div><!--header--> <div class="contents"> -<p>An immutable column data structure consisting of a field (type metadata) and a logical chunked data array. +<p>An immutable column data structure consisting of a field (type metadata) and a chunked data array. <a href="classarrow_1_1_column.html#details">More...</a></p> <p><code>#include <<a class="el" href="table_8h_source.html">arrow/table.h</a>></code></p> @@ -105,6 +105,12 @@ Public Member Functions</h2></td></tr> <tr class="memitem:abc25d5b5897d669939df0db721837aa4"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_chunked_array.html">ChunkedArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_column.html#abc25d5b5897d669939df0db721837aa4">data</a> () const</td></tr> <tr class="memdesc:abc25d5b5897d669939df0db721837aa4"><td class="mdescLeft"> </td><td class="mdescRight">The column data as a chunked array. <a href="#abc25d5b5897d669939df0db721837aa4">More...</a><br /></td></tr> <tr class="separator:abc25d5b5897d669939df0db721837aa4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acbb4e294e3858fdc815ff8882667953a"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_column.html">Column</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_column.html#acbb4e294e3858fdc815ff8882667953a">Slice</a> (int64_t offset, int64_t <a class="el" href="classarrow_1_1_column.html#aafda8e7be9dbc335820622b4e98e9bdd">length</a>) const</td></tr> +<tr class="memdesc:acbb4e294e3858fdc815ff8882667953a"><td class="mdescLeft"> </td><td class="mdescRight">Construct a zero-copy slice of the column with the indicated offset and length. <a href="#acbb4e294e3858fdc815ff8882667953a">More...</a><br /></td></tr> +<tr class="separator:acbb4e294e3858fdc815ff8882667953a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1554f89be714c2f6ec5ba2da4baf1930"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_column.html">Column</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_column.html#a1554f89be714c2f6ec5ba2da4baf1930">Slice</a> (int64_t offset) const</td></tr> +<tr class="memdesc:a1554f89be714c2f6ec5ba2da4baf1930"><td class="mdescLeft"> </td><td class="mdescRight">Slice from offset until end of the column. <a href="#a1554f89be714c2f6ec5ba2da4baf1930">More...</a><br /></td></tr> +<tr class="separator:a1554f89be714c2f6ec5ba2da4baf1930"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af6902c7344ca9df35f457738799ae106"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_column.html#af6902c7344ca9df35f457738799ae106">Equals</a> (const <a class="el" href="classarrow_1_1_column.html">Column</a> &other) const</td></tr> <tr class="separator:af6902c7344ca9df35f457738799ae106"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a314e522c6eed10bda3548082c2b79167"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_column.html#a314e522c6eed10bda3548082c2b79167">Equals</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_column.html">Column</a> > &other) const</td></tr> @@ -121,7 +127,7 @@ Protected Attributes</h2></td></tr> <tr class="separator:ad362479f06033fdcf67cd45a7e354ab1"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>An immutable column data structure consisting of a field (type metadata) and a logical chunked data array. </p> +<div class="textblock"><p>An immutable column data structure consisting of a field (type metadata) and a chunked data array. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a74650f1bf16d445640a4abaa77f6f704"></a> <h2 class="memtitle"><span class="permalink"><a href="#a74650f1bf16d445640a4abaa77f6f704">◆ </a></span>Column() <span class="overload">[1/4]</span></h2> @@ -403,6 +409,80 @@ Protected Attributes</h2></td></tr> </div> </div> +<a id="acbb4e294e3858fdc815ff8882667953a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acbb4e294e3858fdc815ff8882667953a">◆ </a></span>Slice() <span class="overload">[1/2]</span></h2> + +<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_column.html">Column</a>> arrow::Column::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">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Construct a zero-copy slice of the column 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 column, 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<Column> </dd></dl> + +</div> +</div> +<a id="a1554f89be714c2f6ec5ba2da4baf1930"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1554f89be714c2f6ec5ba2da4baf1930">◆ </a></span>Slice() <span class="overload">[2/2]</span></h2> + +<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_column.html">Column</a>> arrow::Column::Slice </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>offset</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>Slice from offset until end of the column. </p> + +</div> +</div> <a id="a3654c4e1f5272c46a287b4f31ae3175a"></a> <h2 class="memtitle"><span class="permalink"><a href="#a3654c4e1f5272c46a287b4f31ae3175a">◆ </a></span>type()</h2> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_data_type.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_data_type.png b/docs/cpp/classarrow_1_1_data_type.png index 3da717a..1062385 100644 Binary files a/docs/cpp/classarrow_1_1_data_type.png and b/docs/cpp/classarrow_1_1_data_type.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_decimal128-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal128-members.html b/docs/cpp/classarrow_1_1_decimal128-members.html index af5974b..5bd7681 100644 --- a/docs/cpp/classarrow_1_1_decimal128-members.html +++ b/docs/cpp/classarrow_1_1_decimal128-members.html @@ -80,7 +80,7 @@ $(function() { <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html#ab928a342ae5a879b692f1337a45a111c">Decimal128</a>(const std::string &value)</td><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html">arrow::Decimal128</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html#aee95c36d704d1e0c314c44ae62013ed9">Decimal128</a>(const uint8_t *bytes)</td><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html">arrow::Decimal128</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html#a0f3e4c6498720d3e276b0541ac0249f3">Divide</a>(const Decimal128 &divisor, Decimal128 *result, Decimal128 *remainder) const</td><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html">arrow::Decimal128</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html#a49c97a5085b396ab44182b1dc4037ddc">FromString</a>(const std::string &s, Decimal128 *out, int *precision=NULLPTR, int *scale=NULLPTR)</td><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html">arrow::Decimal128</a></td><td class="entry"><span class="mlabel">static</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html#ac21945a7921b98e76d13a478a718a065">FromString</a>(const std::string &s, Decimal128 *out, int32_t *precision=NULLPTR, int32_t *scale=NULLPTR)</td><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html">arrow::Decimal128</a></td><td class="entry"><span class="mlabel">static</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html#aba1a88ab68d88695c980ea2475e21967">high_bits</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html">arrow::Decimal128</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html#a33dffd62ff64fff5c01db140d30d2058">low_bits</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html">arrow::Decimal128</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_decimal128.html#af8f8bdeee73d160fd5c2c3bbe2899eca">Negate</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_decimal128.html">arrow::Decimal128</a></td><td class="entry"></td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_decimal128.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal128.html b/docs/cpp/classarrow_1_1_decimal128.html index 03152b4..7f3c2d8 100644 --- a/docs/cpp/classarrow_1_1_decimal128.html +++ b/docs/cpp/classarrow_1_1_decimal128.html @@ -157,9 +157,9 @@ Public Member Functions</h2></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> -<tr class="memitem:a49c97a5085b396ab44182b1dc4037ddc"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_decimal128.html#a49c97a5085b396ab44182b1dc4037ddc">FromString</a> (const std::string &s, <a class="el" href="classarrow_1_1_decimal128.html">Decimal128</a> *out, int *precision=<a class="el" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>, int *scale=<a class="el" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>)</td></tr> -<tr class="memdesc:a49c97a5085b396ab44182b1dc4037ddc"><td class="mdescLeft"> </td><td class="mdescRight">Convert a decimal string to an <a class="el" href="classarrow_1_1_decimal128.html" title="Represents a signed 128-bit integer in two's complement. ">Decimal128</a> value, optionally including precision and scale if they're passed in and not null. <a href="#a49c97a5085b396ab44182b1dc4037ddc">More...</a><br /></td></tr> -<tr class="separator:a49c97a5085b396ab44182b1dc4037ddc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac21945a7921b98e76d13a478a718a065"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_decimal128.html#ac21945a7921b98e76d13a478a718a065">FromString</a> (const std::string &s, <a class="el" href="classarrow_1_1_decimal128.html">Decimal128</a> *out, int32_t *precision=<a class="el" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>, int32_t *scale=<a class="el" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>)</td></tr> +<tr class="memdesc:ac21945a7921b98e76d13a478a718a065"><td class="mdescLeft"> </td><td class="mdescRight">Convert a decimal string to an <a class="el" href="classarrow_1_1_decimal128.html" title="Represents a signed 128-bit integer in two's complement. ">Decimal128</a> value, optionally including precision and scale if they're passed in and not null. <a href="#ac21945a7921b98e76d13a478a718a065">More...</a><br /></td></tr> +<tr class="separator:ac21945a7921b98e76d13a478a718a065"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Represents a signed 128-bit integer in two's complement. </p> @@ -382,8 +382,8 @@ template<typename T , typename = typename std::enable_if<std::is_integral </div> </div> -<a id="a49c97a5085b396ab44182b1dc4037ddc"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a49c97a5085b396ab44182b1dc4037ddc">◆ </a></span>FromString()</h2> +<a id="ac21945a7921b98e76d13a478a718a065"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac21945a7921b98e76d13a478a718a065">◆ </a></span>FromString()</h2> <div class="memitem"> <div class="memproto"> @@ -406,13 +406,13 @@ template<typename T , typename = typename std::enable_if<std::is_integral <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">int * </td> + <td class="paramtype">int32_t * </td> <td class="paramname"><em>precision</em> = <code><a class="el" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a></code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">int * </td> + <td class="paramtype">int32_t * </td> <td class="paramname"><em>scale</em> = <code><a class="el" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a></code> </td> </tr> <tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_decimal128_array.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal128_array.html b/docs/cpp/classarrow_1_1_decimal128_array.html index 2550093..248036c 100644 --- a/docs/cpp/classarrow_1_1_decimal128_array.html +++ b/docs/cpp/classarrow_1_1_decimal128_array.html @@ -127,9 +127,6 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a0c05d9ba21020050abe94e1446a3cee1 inherit pub_methods_classarrow_1_1_primitive_array"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_primitive_array.html#a0c05d9ba21020050abe94e1446a3cee1">values</a> () const</td></tr> <tr class="memdesc:a0c05d9ba21020050abe94e1446a3cee1 inherit pub_methods_classarrow_1_1_primitive_array"><td class="mdescLeft"> </td><td class="mdescRight">Does not account for any slice offset. <a href="classarrow_1_1_primitive_array.html#a0c05d9ba21020050abe94e1446a3cee1">More...</a><br /></td></tr> <tr class="separator:a0c05d9ba21020050abe94e1446a3cee1 inherit pub_methods_classarrow_1_1_primitive_array"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a26a2b63695331ef963249f1390fb4d8c inherit pub_methods_classarrow_1_1_primitive_array"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_primitive_array.html#a26a2b63695331ef963249f1390fb4d8c">raw_values</a> () const</td></tr> -<tr class="memdesc:a26a2b63695331ef963249f1390fb4d8c inherit pub_methods_classarrow_1_1_primitive_array"><td class="mdescLeft"> </td><td class="mdescRight">Return pointer to start of raw data. <a href="classarrow_1_1_primitive_array.html#a26a2b63695331ef963249f1390fb4d8c">More...</a><br /></td></tr> -<tr class="separator:a26a2b63695331ef963249f1390fb4d8c inherit pub_methods_classarrow_1_1_primitive_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classarrow_1_1_array"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarrow_1_1_array')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td></tr> <tr class="memitem:addd582eec9488bca2b3379b71fef6ce5 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#addd582eec9488bca2b3379b71fef6ce5">~Array</a> ()=default</td></tr> <tr class="separator:addd582eec9488bca2b3379b71fef6ce5 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> @@ -153,7 +150,7 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a155d9d827415438f976e3cb31e0a55f6 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a155d9d827415438f976e3cb31e0a55f6">type_id</a> () const</td></tr> <tr class="separator:a155d9d827415438f976e3cb31e0a55f6 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">null_bitmap</a> () const</td></tr> -<tr class="memdesc:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> for the null bitmap. <a href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">More...</a><br /></td></tr> +<tr class="memdesc:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classarrow_1_1_buffer.html" title="Object containing a pointer to a piece of contiguous memory with a particular size. ">Buffer</a> for the null bitmap. <a href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">More...</a><br /></td></tr> <tr class="separator:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7a8838fbc97b9b3b8ca15cb163b2027c inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a7a8838fbc97b9b3b8ca15cb163b2027c">null_bitmap_data</a> () const</td></tr> <tr class="memdesc:a7a8838fbc97b9b3b8ca15cb163b2027c inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight">Raw pointer to the null bitmap. <a href="classarrow_1_1_array.html#a7a8838fbc97b9b3b8ca15cb163b2027c">More...</a><br /></td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_decimal128_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal128_builder.html b/docs/cpp/classarrow_1_1_decimal128_builder.html index 36cabd0..04e1a08 100644 --- a/docs/cpp/classarrow_1_1_decimal128_builder.html +++ b/docs/cpp/classarrow_1_1_decimal128_builder.html @@ -357,7 +357,7 @@ template<size_t NBYTES> </div> </div><div class="memdoc"> <p>Return result of builder as an internal generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object. </p> -<p>Resets builder</p> +<p>Resets builder except for dictionary builder</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the finalized <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a> object </td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_dictionary_array-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_dictionary_array-members.html b/docs/cpp/classarrow_1_1_dictionary_array-members.html index 59feb0c..aa68852 100644 --- a/docs/cpp/classarrow_1_1_dictionary_array-members.html +++ b/docs/cpp/classarrow_1_1_dictionary_array-members.html @@ -85,25 +85,26 @@ $(function() { <tr><td class="entry"><a class="el" href="classarrow_1_1_dictionary_array.html#a51b8312f900592a4d3a9c416b3f1cdb6">DictionaryArray</a>(const std::shared_ptr< DataType > &type, const std::shared_ptr< Array > &indices)</td><td class="entry"><a class="el" href="classarrow_1_1_dictionary_array.html">arrow::DictionaryArray</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array.html#ae8c4584a4d64d724c1956c2e6d5ad353">Equals</a>(const Array &arr) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#ab52cf46d3f819acc25209e4afbfe4292">Equals</a>(const std::shared_ptr< Array > &arr) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_dictionary_array.html#a27372a98ddc7a7d01c48cdf6077150c3">indices</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_dictionary_array.html">arrow::DictionaryArray</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a18c61cd4c8c158a30f30023eabc83acb">IsNull</a>(int64_t i) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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.html#ae554bfb313cd6b161f63fb2966dbd662">IsValid</a>(int64_t i) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a49c7fb3f73d2d43e7338591c5a8bd8bf">length</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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.html#a76c4756ac85b29f9135064d68d2ef908">null_bitmap</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a7a8838fbc97b9b3b8ca15cb163b2027c">null_bitmap_data</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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.html#aed59d9e8608229ff3808983cdc908ccd">null_bitmap_data_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a0537d3b69a889b951e88be2fe9f3d96a">null_count</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array.html#a183e69c91c531609f42a29b593119d58">num_fields</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a1a0c6c1aa06cffd1dcb3813f0d24b2fd">offset</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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.html#a537467bcecb4471b18d3271f14ca9ad2">RangeEquals</a>(int64_t start_idx, int64_t end_idx, int64_t other_start_idx, const std::shared_ptr< Array > &other) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#acf138d427e7f8a8c56cac7f9d9e64db3">RangeEquals</a>(const Array &other, int64_t start_idx, int64_t end_idx, int64_t other_start_idx) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array.html#ae32f72c78fe10ce17f0a817e302e17d1">Slice</a>(int64_t offset, int64_t length) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a5cf4c3330e850670aa52dab3b21869ea">Slice</a>(int64_t offset) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array.html#a41c7af0e40ac55f2ce11785fea3e051e">ToString</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a635a694fbadb0bfa731beb97df2ef7ea">type</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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.html#a155d9d827415438f976e3cb31e0a55f6">type_id</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_dictionary_array.html#acd352de67775187d93c6e34b2ba55440">TypeClass</a> typedef</td><td class="entry"><a class="el" href="classarrow_1_1_dictionary_array.html">arrow::DictionaryArray</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array.html#addd582eec9488bca2b3379b71fef6ce5">~Array</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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_dictionary_array.html#a7d280025b617d4aa1db5624509cd3c4e">FromArrays</a>(const std::shared_ptr< DataType > &type, const std::shared_ptr< Array > &indices, std::shared_ptr< Array > *out)</td><td class="entry"><a class="el" href="classarrow_1_1_dictionary_array.html">arrow::DictionaryArray</a></td><td class="entry"><span class="mlabel">static</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_dictionary_array.html#a27372a98ddc7a7d01c48cdf6077150c3">indices</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_dictionary_array.html">arrow::DictionaryArray</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array.html#a18c61cd4c8c158a30f30023eabc83acb">IsNull</a>(int64_t i) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#ae554bfb313cd6b161f63fb2966dbd662">IsValid</a>(int64_t i) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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.html#a49c7fb3f73d2d43e7338591c5a8bd8bf">length</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">null_bitmap</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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.html#a7a8838fbc97b9b3b8ca15cb163b2027c">null_bitmap_data</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#aed59d9e8608229ff3808983cdc908ccd">null_bitmap_data_</a></td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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.html#a0537d3b69a889b951e88be2fe9f3d96a">null_count</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a183e69c91c531609f42a29b593119d58">num_fields</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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.html#a1a0c6c1aa06cffd1dcb3813f0d24b2fd">offset</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a537467bcecb4471b18d3271f14ca9ad2">RangeEquals</a>(int64_t start_idx, int64_t end_idx, int64_t other_start_idx, const std::shared_ptr< Array > &other) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array.html#acf138d427e7f8a8c56cac7f9d9e64db3">RangeEquals</a>(const Array &other, int64_t start_idx, int64_t end_idx, int64_t other_start_idx) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#ae32f72c78fe10ce17f0a817e302e17d1">Slice</a>(int64_t offset, int64_t length) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array.html#a5cf4c3330e850670aa52dab3b21869ea">Slice</a>(int64_t offset) const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a41c7af0e40ac55f2ce11785fea3e051e">ToString</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_array.html#a635a694fbadb0bfa731beb97df2ef7ea">type</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#a155d9d827415438f976e3cb31e0a55f6">type_id</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</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_dictionary_array.html#acd352de67775187d93c6e34b2ba55440">TypeClass</a> typedef</td><td class="entry"><a class="el" href="classarrow_1_1_dictionary_array.html">arrow::DictionaryArray</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_array.html#addd582eec9488bca2b3379b71fef6ce5">~Array</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> </table></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/classarrow_1_1_dictionary_array.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_dictionary_array.html b/docs/cpp/classarrow_1_1_dictionary_array.html index b0e5eb2..d74aca6 100644 --- a/docs/cpp/classarrow_1_1_dictionary_array.html +++ b/docs/cpp/classarrow_1_1_dictionary_array.html @@ -69,6 +69,7 @@ $(function() { <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-methods">Static Public Member Functions</a> | <a href="classarrow_1_1_dictionary_array-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">arrow::DictionaryArray Class Reference</div> </div> @@ -126,7 +127,7 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a155d9d827415438f976e3cb31e0a55f6 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a155d9d827415438f976e3cb31e0a55f6">type_id</a> () const</td></tr> <tr class="separator:a155d9d827415438f976e3cb31e0a55f6 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">null_bitmap</a> () const</td></tr> -<tr class="memdesc:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> for the null bitmap. <a href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">More...</a><br /></td></tr> +<tr class="memdesc:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classarrow_1_1_buffer.html" title="Object containing a pointer to a piece of contiguous memory with a particular size. ">Buffer</a> for the null bitmap. <a href="classarrow_1_1_array.html#a76c4756ac85b29f9135064d68d2ef908">More...</a><br /></td></tr> <tr class="separator:a76c4756ac85b29f9135064d68d2ef908 inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7a8838fbc97b9b3b8ca15cb163b2027c inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a7a8838fbc97b9b3b8ca15cb163b2027c">null_bitmap_data</a> () const</td></tr> <tr class="memdesc:a7a8838fbc97b9b3b8ca15cb163b2027c inherit pub_methods_classarrow_1_1_array"><td class="mdescLeft"> </td><td class="mdescRight">Raw pointer to the null bitmap. <a href="classarrow_1_1_array.html#a7a8838fbc97b9b3b8ca15cb163b2027c">More...</a><br /></td></tr> @@ -159,6 +160,12 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a41c7af0e40ac55f2ce11785fea3e051e inherit pub_methods_classarrow_1_1_array"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array.html#a41c7af0e40ac55f2ce11785fea3e051e">ToString</a> () const</td></tr> <tr class="separator:a41c7af0e40ac55f2ce11785fea3e051e inherit pub_methods_classarrow_1_1_array"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:a7d280025b617d4aa1db5624509cd3c4e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_dictionary_array.html#a7d280025b617d4aa1db5624509cd3c4e">FromArrays</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > &<a class="el" href="classarrow_1_1_array.html#a635a694fbadb0bfa731beb97df2ef7ea">type</a>, const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > &<a class="el" href="classarrow_1_1_dictionary_array.html#a27372a98ddc7a7d01c48cdf6077150c3">indices</a>, std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > *out)</td></tr> +<tr class="memdesc:a7d280025b617d4aa1db5624509cd3c4e"><td class="mdescLeft"> </td><td class="mdescRight">Construct <a class="el" href="classarrow_1_1_dictionary_array.html">DictionaryArray</a> from dictonary data type and indices array. <a href="#a7d280025b617d4aa1db5624509cd3c4e">More...</a><br /></td></tr> +<tr class="separator:a7d280025b617d4aa1db5624509cd3c4e"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> <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"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1_array')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1_array.html">arrow::Array</a></td></tr> @@ -286,6 +293,59 @@ Additional Inherited Members</h2></td></tr> </div> </div> +<a id="a7d280025b617d4aa1db5624509cd3c4e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7d280025b617d4aa1db5624509cd3c4e">◆ </a></span>FromArrays()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classarrow_1_1_status.html">Status</a> arrow::DictionaryArray::FromArrays </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">const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > & </td> + <td class="paramname"><em>indices</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > * </td> + <td class="paramname"><em>out</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Construct <a class="el" href="classarrow_1_1_dictionary_array.html">DictionaryArray</a> from dictonary data type and indices array. </p> +<p>This function does the validation of the indices and input type. It checks if all indices are non-negative and smaller than the size of the dictionary</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>a data type containing a dictionary </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">indices</td><td>an array of non-negative signed integers smaller than the size of the dictionary </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the resulting <a class="el" href="classarrow_1_1_dictionary_array.html">DictionaryArray</a> instance </td></tr> + </table> + </dd> +</dl> + +</div> +</div> <a id="a27372a98ddc7a7d01c48cdf6077150c3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a27372a98ddc7a7d01c48cdf6077150c3">◆ </a></span>indices()</h2>
