http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/md_tutorials_plasma.html ---------------------------------------------------------------------- diff --git a/docs/cpp/md_tutorials_plasma.html b/docs/cpp/md_tutorials_plasma.html index f55c3fa..ad92bdf 100644 --- a/docs/cpp/md_tutorials_plasma.html +++ b/docs/cpp/md_tutorials_plasma.html @@ -96,11 +96,11 @@ $(function() { <p>Now that you learned about Object IDs that are used to refer to objects, let's look at how objects can be stored in Plasma.</p> <p>Storing objects is a two-stage process. First a buffer is allocated with a call to <code>Create</code>. Then it can be constructed in place by the client. Then it is made immutable and shared with other clients via a call to <code>Seal</code>.</p> <p>The <code>Create</code> call blocks while the Plasma store allocates a buffer of the appropriate size. The client will then map the buffer into its own address space. At this point the object can be constructed in place using a pointer that was written by the <code>Create</code> command.</p> -<div class="fragment"><div class="line">int64_t data_size = 100;</div><div class="line"><span class="comment">// The address of the buffer allocated by the Plasma store will be written at</span></div><div class="line"><span class="comment">// this address.</span></div><div class="line">uint8_t* data;</div><div class="line"><span class="comment">// Create a Plasma object by specifying its ID and size.</span></div><div class="line"><a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#ac18ab9cc792c620a97a3dcb165e0ecd7">Create</a>(object_id, data_size, NULL, 0, &data));</div></div><!-- fragment --><p>You can also specify metadata for the object; the third argument is the metadata (as raw bytes) and the fourth argument is the size of the metadata.</p> -<div class="fragment"><div class="line"><span class="comment">// Create a Plasma object with metadata.</span></div><div class="line">int64_t data_size = 100;</div><div class="line">std::string metadata = <span class="stringliteral">"{'author': 'john'}"</span>;</div><div class="line">uint8_t* data;</div><div class="line">client.<a class="code" href="classplasma_1_1_plasma_client.html#ac18ab9cc792c620a97a3dcb165e0ecd7">Create</a>(object_id, data_size, (uint8_t*) metadata.data(), metadata.size(), &data);</div></div><!-- fragment --><p>Now that we've obtained a pointer to our object's data, we can write our data to it:</p> +<div class="fragment"><div class="line">int64_t data_size = 100;</div><div class="line"><span class="comment">// The address of the buffer allocated by the Plasma store will be written at</span></div><div class="line"><span class="comment">// this address.</span></div><div class="line">uint8_t* data;</div><div class="line"><span class="comment">// Create a Plasma object by specifying its ID and size.</span></div><div class="line"><a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#a0b6e4bc16429191e1449c60f020b4dd7">Create</a>(object_id, data_size, NULL, 0, &data));</div></div><!-- fragment --><p>You can also specify metadata for the object; the third argument is the metadata (as raw bytes) and the fourth argument is the size of the metadata.</p> +<div class="fragment"><div class="line"><span class="comment">// Create a Plasma object with metadata.</span></div><div class="line">int64_t data_size = 100;</div><div class="line">std::string metadata = <span class="stringliteral">"{'author': 'john'}"</span>;</div><div class="line">uint8_t* data;</div><div class="line">client.<a class="code" href="classplasma_1_1_plasma_client.html#a0b6e4bc16429191e1449c60f020b4dd7">Create</a>(object_id, data_size, (uint8_t*) metadata.data(), metadata.size(), &data);</div></div><!-- fragment --><p>Now that we've obtained a pointer to our object's data, we can write our data to it:</p> <div class="fragment"><div class="line"><span class="comment">// Write some data for the Plasma object.</span></div><div class="line"><span class="keywordflow">for</span> (int64_t i = 0; i < data_size; i++) {</div><div class="line"> data[i] = <span class="keyword">static_cast<</span>uint8_t<span class="keyword">></span>(i % 4);</div><div class="line">}</div></div><!-- fragment --><p>When the client is done, the client <b>seals</b> the buffer, making the object immutable, and making it available to other Plasma clients:</p> <div class="fragment"><div class="line"><span class="comment">// Seal the object. This makes it available for all clients.</span></div><div class="line">client.<a class="code" href="classplasma_1_1_plasma_client.html#ae06a7b43528f66b2dd28abf7138e5b6d">Seal</a>(object_id);</div></div><!-- fragment --><p>Here is an example that combines all these features:</p> -<div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="client_8h.html">plasma/client.h</a>></span></div><div class="line"></div><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespaceplasma.html">plasma</a>;</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv) {</div><div class="line"> <span class="comment">// Start up and connect a Plasma client.</span></div><div class="line"> <a class="code" href="classplasma_1_1_plasma_client.html">PlasmaClient</a> client;</div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#ac024b42271ad80c467636fc5b16968a3">Connect</a>(<span class="stringliteral">"/tmp/plasma"</span>, <span class="stringliteral">&q uot;"</span>, <a class="code" href="client_8h.html#ac6a4959f813315451e993a3dfe28cac7">PLASMA_DEFAULT_RELEASE_DELAY</a>));</div><div class="line"> <span class="comment">// Create an object with a fixed ObjectID.</span></div><div class="line"> <a class="code" href="classplasma_1_1_unique_i_d.html">ObjectID</a> object_id = <a class="code" href="classplasma_1_1_unique_i_d.html#a35bce29897b79eb6215fbd1b9ebe99bb">ObjectID::from_binary</a>(<span class="stringliteral">"00000000000000000000"</span>);</div><div class="line"> int64_t data_size = 1000;</div><div class="line"> uint8_t *data;</div><div class="line"> std::string metadata = <span class="stringliteral">"{'author': 'john'}"</span>;</div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#ac18ab9cc792c620a97a3dcb165e0ecd7">Create</a>(object_id, data_size, (uint8_t*) me tadata.data(), metadata.size(), &data));</div><div class="line"> <span class="comment">// Write some data into the object.</span></div><div class="line"> <span class="keywordflow">for</span> (int64_t i = 0; i < data_size; i++) {</div><div class="line"> data[i] = <span class="keyword">static_cast<</span>uint8_t<span class="keyword">></span>(i % 4);</div><div class="line"> }</div><div class="line"> <span class="comment">// Seal the object.</span></div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#ae06a7b43528f66b2dd28abf7138e5b6d">Seal</a>(object_id));</div><div class="line"> <span class="comment">// Disconnect the client.</span></div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#a82ff4d7b988c040aa46674a2fa907e ff">Disconnect</a>());</div><div class="line">}</div></div><!-- fragment --><p>This example can be compiled with</p> +<div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="client_8h.html">plasma/client.h</a>></span></div><div class="line"></div><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespaceplasma.html">plasma</a>;</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv) {</div><div class="line"> <span class="comment">// Start up and connect a Plasma client.</span></div><div class="line"> <a class="code" href="classplasma_1_1_plasma_client.html">PlasmaClient</a> client;</div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#ac024b42271ad80c467636fc5b16968a3">Connect</a>(<span class="stringliteral">"/tmp/plasma"</span>, <span class="stringliteral">&q uot;"</span>, <a class="code" href="client_8h.html#ac6a4959f813315451e993a3dfe28cac7">PLASMA_DEFAULT_RELEASE_DELAY</a>));</div><div class="line"> <span class="comment">// Create an object with a fixed ObjectID.</span></div><div class="line"> <a class="code" href="classplasma_1_1_unique_i_d.html">ObjectID</a> object_id = <a class="code" href="classplasma_1_1_unique_i_d.html#a35bce29897b79eb6215fbd1b9ebe99bb">ObjectID::from_binary</a>(<span class="stringliteral">"00000000000000000000"</span>);</div><div class="line"> int64_t data_size = 1000;</div><div class="line"> uint8_t *data;</div><div class="line"> std::string metadata = <span class="stringliteral">"{'author': 'john'}"</span>;</div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#a0b6e4bc16429191e1449c60f020b4dd7">Create</a>(object_id, data_size, (uint8_t*) me tadata.data(), metadata.size(), &data));</div><div class="line"> <span class="comment">// Write some data into the object.</span></div><div class="line"> <span class="keywordflow">for</span> (int64_t i = 0; i < data_size; i++) {</div><div class="line"> data[i] = <span class="keyword">static_cast<</span>uint8_t<span class="keyword">></span>(i % 4);</div><div class="line"> }</div><div class="line"> <span class="comment">// Seal the object.</span></div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#ae06a7b43528f66b2dd28abf7138e5b6d">Seal</a>(object_id));</div><div class="line"> <span class="comment">// Disconnect the client.</span></div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#a82ff4d7b988c040aa46674a2fa907e ff">Disconnect</a>());</div><div class="line">}</div></div><!-- fragment --><p>This example can be compiled with</p> <div class="fragment"><div class="line">g++ create.cc `pkg-config --cflags --libs plasma` --std=c++11 -o create</div></div><!-- fragment --><p>To verify that an object exists in the Plasma object store, you can call <code>PlasmaClient::Contains()</code> to check if an object has been created and sealed for a given Object ID. Note that this function will still return False if the object has been created, but not yet sealed:</p> <div class="fragment"><div class="line"><span class="comment">// Check if an object has been created and sealed.</span></div><div class="line"><span class="keywordtype">bool</span> has_object;</div><div class="line">client.<a class="code" href="classplasma_1_1_plasma_client.html#af573b2ba35f48bf012393e9438ef086d">Contains</a>(object_id, &has_object);</div><div class="line"><span class="keywordflow">if</span> (has_object) {</div><div class="line"> <span class="comment">// Object has been created and sealed, proceed</span></div><div class="line">}</div></div><!-- fragment --><h2>Getting an Object </h2> <p>After an object has been sealed, any client who knows the Object ID can get the object. To store the retrieved object contents, you should create an <code>ObjectBuffer</code>, then call <code>PlasmaClient::Get()</code> as follows:</p>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/md_tutorials_row_wise_conversion.html ---------------------------------------------------------------------- diff --git a/docs/cpp/md_tutorials_row_wise_conversion.html b/docs/cpp/md_tutorials_row_wise_conversion.html index c890fc9..ed95416 100644 --- a/docs/cpp/md_tutorials_row_wise_conversion.html +++ b/docs/cpp/md_tutorials_row_wise_conversion.html @@ -69,7 +69,7 @@ $(function() { <div class="textblock"><h1>Convert a vector of row-wise data into an Arrow table </h1> <p>While we want to use columnar data structures to build efficient operations, we often receive data in a row-wise fashion from other systems. In the following, we want give a brief introduction into the classes provided by Apache Arrow by showing how to transform row-wise data into a columnar table.</p> <p>The data in this example is stored in the following struct:</p> -<div class="fragment"><div class="line">struct data_row {</div><div class="line"> int64_t id;</div><div class="line"> double cost;</div><div class="line"> std::vector<double> cost_components;</div><div class="line">};</div><div class="line"></div><div class="line">std::vector<data_row> rows;</div></div><!-- fragment --><p>The final representation should be an <code><a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">arrow::Table</a></code> which in turn is made up of an <code><a class="el" href="classarrow_1_1_schema.html" title="Sequence of arrow::Field objects describing the columns of a record batch or table data structure...">arrow::Schema</a></code> and a list of <code><a class="el" href="classarrow_1_1_column.html" title="An immutable column data structure consisting of a field (type metadata) and a logical chunked data a...">arrow::Column</a></code>. An <code><a class="el" href="classarrow_1_1_column.html" title="An immutable column data structure consisting of a field (type metadata) and a logical chunked data a...">arrow::Column</a></code> is again a named collection of one or more <code><a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">arrow::Array</a></code> instances. As the first step, we will iterate over the data and build up the arrays incrementally. For this task, we provide <code><a class="el" href="classarrow_1_1_array_builder.html" title="Base class for all data array builders. ">arrow::ArrayBuilder</a></code> classes that help in the construction of the final <code><a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">arrow::Array</a></code> instances.</p> +<div class="fragment"><div class="line">struct data_row {</div><div class="line"> int64_t id;</div><div class="line"> double cost;</div><div class="line"> std::vector<double> cost_components;</div><div class="line">};</div><div class="line"></div><div class="line">std::vector<data_row> rows;</div></div><!-- fragment --><p>The final representation should be an <code><a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">arrow::Table</a></code> which in turn is made up of an <code><a class="el" href="classarrow_1_1_schema.html" title="Sequence of arrow::Field objects describing the columns of a record batch or table data structure...">arrow::Schema</a></code> and a list of <code><a class="el" href="classarrow_1_1_column.html" title="An immutable column data structure consisting of a field (type metadata) and a chunked data array...">arrow::Column</a></code>. An <code><a class="el" href="classarrow_1_1_column.html" titl e="An immutable column data structure consisting of a field (type metadata) and a chunked data array...">arrow::Column</a></code> is again a named collection of one or more <code><a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">arrow::Array</a></code> instances. As the first step, we will iterate over the data and build up the arrays incrementally. For this task, we provide <code><a class="el" href="classarrow_1_1_array_builder.html" title="Base class for all data array builders. ">arrow::ArrayBuilder</a></code> classes that help in the construction of the final <code><a class="el" href="classarrow_1_1_array.html" title="Array base type Immutable data array with some logical type and some length. ">arrow::Array</a></code> instances.</p> <p>For each type, Arrow has a specially typed builder class. For the primitive values <code>id</code> and <code>cost</code> we can use the respective <code><a class="el" href="namespacearrow.html#a08fa80026c56e0f1ff24b43c4dc33e61">arrow::Int64Builder</a></code> and <code><a class="el" href="namespacearrow.html#ab98cad76b29efffe92c6c88af8947873">arrow::DoubleBuilder</a></code>. For the <code>cost_components</code> vector, we need to have two builders, a top-level <code><a class="el" href="classarrow_1_1_list_builder.html" title="Builder class for variable-length list array value types. ">arrow::ListBuilder</a></code> that builds the array of offsets and a nested <code><a class="el" href="namespacearrow.html#ab98cad76b29efffe92c6c88af8947873">arrow::DoubleBuilder</a></code> that constructs the underlying values array that is referenced by the offsets in the former array.</p> <div class="fragment"><div class="line">// The builders are more efficient using</div><div class="line">// arrow::jemalloc::MemoryPool::default_pool() as this can increase the size of</div><div class="line">// the underlying memory regions in-place. At the moment, arrow::jemalloc is only</div><div class="line">// supported on Unix systems, not Windows.</div><div class="line"></div><div class="line">using arrow::DoubleBuilder;</div><div class="line">using arrow::Int64Builder;</div><div class="line">using arrow::ListBuilder;</div><div class="line"></div><div class="line">arrow::MemoryPool* pool = arrow::default_memory_pool();</div><div class="line">Int64Builder id_builder(pool);</div><div class="line">DoubleBuilder cost_builder(pool);</div><div class="line">std::unique_ptr<DoubleBuilder> components_values_builder(new DoubleBuilder(pool));</div><div class="line">ListBuilder components_builder(pool, std::move(components_values_builder));</div></div><!-- fragment --><p>Now we can l oop over our existing data and insert it into the builders. The <code>Append</code> calls here may fail (e.g. we cannot allocate enough additional memory). Thus we need to check their return values. For more information on these values, check the documentation about <code><a class="el" href="classarrow_1_1_status.html">arrow::Status</a></code>.</p> <div class="fragment"><div class="line">for (const data_row& row : rows) {</div><div class="line"> ARROW_RETURN_NOT_OK(id_builder.Append(row.id));</div><div class="line"> ARROW_RETURN_NOT_OK(cost_builder.Append(row.cost));</div><div class="line"></div><div class="line"> // Indicate the start of a new list row. This will memorise the current</div><div class="line"> // offset in the values builder.</div><div class="line"> ARROW_RETURN_NOT_OK(components_builder.Append());</div><div class="line"> // Store the actual values. The final nullptr argument tells the underyling</div><div class="line"> // builder that all added values are valid, i.e. non-null.</div><div class="line"> ARROW_RETURN_NOT_OK(components_values_builder->Append(</div><div class="line"> row.cost_components.data(), row.cost_components.size(),</div><div class="line"> nullptr);</div><div class="line">}</div></div><!-- fragment --><p>At the end, we finalise the arrays, declare th e (type) schema and combine them into a single <code><a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">arrow::Table</a></code>:</p> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/memory__pool_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/memory__pool_8h_source.html b/docs/cpp/memory__pool_8h_source.html index 27b75fd..c6e14e1 100644 --- a/docs/cpp/memory__pool_8h_source.html +++ b/docs/cpp/memory__pool_8h_source.html @@ -70,7 +70,7 @@ $(function() { <div class="title">memory_pool.h</div> </div> </div><!--header--> <div class="contents"> -<a href="memory__pool_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distribu ted under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_MEMORY_POOL_H</span></div><div class="line"><a name="l00019"></a><span class="lin eno"> 19</span> <span class="preprocessor">#define ARROW_MEMORY_POOL_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <atomic></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arro w</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classarrow_1_1_memory_pool.html"> 34</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>();</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name=" l00041"></a><span class="lineno"> 41</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Allocate(int64_t size, uint8_t** out) = 0;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Reallocate(int64_t old_size, int64_t new_size, uint8_t** ptr) = 0;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Free(uint8_t* buffer, int64_t size) = 0;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="ke yword">virtual</span> int64_t bytes_allocated() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> int64_t max_memory() <span class="keyword">const</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>();</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classarrow_1_1_logging_ memory_pool.html"> 71</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1_logging_memory_pool.html">LoggingMemoryPool</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a> {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1_logging_memory_pool.html">LoggingMemoryPool</a>(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1_logging_memory_pool.html">LoggingMemoryPool</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00075"></a><span cla ss="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Allocate(int64_t size, uint8_t** out) <span class="keyword">override</span>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Reallocate(int64_t old_size, int64_t new_size, uint8_t** ptr) <span class="keyword">override</span>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">void</span> Free(uint8_t* buffer, int64_t size) <span class="keyword">override</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  int64_t bytes_allocated() <span class="keywor d">const override</span>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  int64_t max_memory() <span class="keyword">const override</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool_;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> };</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> ARROW_EXPORT <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* <a class="code" href="namespac earrow.html#aebe81d544faaf827b8f32c5a80b99820">default_memory_pool</a>();</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#ifdef ARROW_NO_DEFAULT_MEMORY_POOL</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#define ARROW_MEMORY_POOL_DEFAULT</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="memory__pool_8h.html#a45892ac769df8063a376c306735ff637"> 94</a></span> <span class="preprocessor">#define ARROW_MEMORY_POOL_DEFAULT = default_memory_pool()</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#endif</span></div><div class="line"><a name= "l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif // ARROW_MEMORY_POOL_H</span></div><div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:106</div></div> +<a href="memory__pool_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distribu ted under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_MEMORY_POOL_H</span></div><div class="line"><a name="l00019"></a><span class="lin eno"> 19</span> <span class="preprocessor">#define ARROW_MEMORY_POOL_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <atomic></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arro w</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classarrow_1_1_memory_pool.html"> 34</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>();</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name=" l00041"></a><span class="lineno"> 41</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Allocate(int64_t size, uint8_t** out) = 0;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Reallocate(int64_t old_size, int64_t new_size, uint8_t** ptr) = 0;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Free(uint8_t* buffer, int64_t size) = 0;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="ke yword">virtual</span> int64_t bytes_allocated() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> int64_t max_memory() <span class="keyword">const</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>();</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classarrow_1_1_logging_ memory_pool.html"> 71</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1_logging_memory_pool.html">LoggingMemoryPool</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a> {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1_logging_memory_pool.html">LoggingMemoryPool</a>(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  ~<a class="code" href="classarrow_1_1_logging_memory_pool.html">LoggingMemoryPool</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00075"></a><span cl ass="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Allocate(int64_t size, uint8_t** out) <span class="keyword">override</span>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Reallocate(int64_t old_size, int64_t new_size, uint8_t** ptr) <span class="keyword">override</span>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">void</span> Free(uint8_t* buffer, int64_t size) <span class="keyword">override</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  int64_t bytes_allocated() <span class="keywo rd">const override</span>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  int64_t max_memory() <span class="keyword">const override</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool_;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> };</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> ARROW_EXPORT <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* <a class="code" href="namespa cearrow.html#aebe81d544faaf827b8f32c5a80b99820">default_memory_pool</a>();</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#ifdef ARROW_NO_DEFAULT_MEMORY_POOL</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#define ARROW_MEMORY_POOL_DEFAULT</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="memory__pool_8h.html#a45892ac769df8063a376c306735ff637"> 94</a></span> <span class="preprocessor">#define ARROW_MEMORY_POOL_DEFAULT = default_memory_pool()</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#endif</span></div><div class="line"><a name ="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif // ARROW_MEMORY_POOL_H</span></div><div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:106</div></div> <div class="ttc" id="namespacearrow_html_aebe81d544faaf827b8f32c5a80b99820"><div class="ttname"><a href="namespacearrow.html#aebe81d544faaf827b8f32c5a80b99820">arrow::default_memory_pool</a></div><div class="ttdeci">MemoryPool * default_memory_pool()</div></div> <div class="ttc" id="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div> <div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/menudata.js ---------------------------------------------------------------------- diff --git a/docs/cpp/menudata.js b/docs/cpp/menudata.js index 462b6e9..8e11f06 100644 --- a/docs/cpp/menudata.js +++ b/docs/cpp/menudata.js @@ -69,7 +69,12 @@ var menudata={children:[ {text:"u",url:"namespacemembers_func_u.html#index_u"}, {text:"v",url:"namespacemembers_func_v.html#index_v"}, {text:"w",url:"namespacemembers_func_w.html#index_w"}]}, -{text:"Variables",url:"namespacemembers_vars.html"}, +{text:"Variables",url:"namespacemembers_vars.html",children:[ +{text:"c",url:"namespacemembers_vars.html#index_c"}, +{text:"k",url:"namespacemembers_vars.html#index_k"}, +{text:"n",url:"namespacemembers_vars.html#index_n"}, +{text:"o",url:"namespacemembers_vars.html#index_o"}, +{text:"p",url:"namespacemembers_vars.html#index_p"}]}, {text:"Typedefs",url:"namespacemembers_type.html",children:[ {text:"a",url:"namespacemembers_type.html#index_a"}, {text:"b",url:"namespacemembers_type.html#index_b"}, @@ -166,6 +171,7 @@ var menudata={children:[ {text:"b",url:"functions_type.html#index_b"}, {text:"c",url:"functions_type.html#index_c"}, {text:"d",url:"functions_type.html#index_d"}, +{text:"e",url:"functions_type.html#index_e"}, {text:"f",url:"functions_type.html#index_f"}, {text:"o",url:"functions_type.html#index_o"}, {text:"p",url:"functions_type.html#index_p"}, @@ -207,6 +213,7 @@ var menudata={children:[ {text:"g",url:"globals_g.html#index_g"}, {text:"h",url:"globals_h.html#index_h"}, {text:"i",url:"globals_i.html#index_i"}, +{text:"k",url:"globals_k.html#index_k"}, {text:"m",url:"globals_m.html#index_m"}, {text:"n",url:"globals_n.html#index_n"}, {text:"p",url:"globals_p.html#index_p"}, @@ -223,6 +230,7 @@ var menudata={children:[ {text:"r",url:"globals_func.html#index_r"}, {text:"s",url:"globals_func.html#index_s"}, {text:"x",url:"globals_func.html#index_x"}]}, +{text:"Variables",url:"globals_vars.html"}, {text:"Typedefs",url:"globals_type.html"}, {text:"Enumerations",url:"globals_enum.html"}, {text:"Enumerator",url:"globals_eval.html"}, http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/namespacearrow.html ---------------------------------------------------------------------- diff --git a/docs/cpp/namespacearrow.html b/docs/cpp/namespacearrow.html index 5ecf98c..1a263df 100644 --- a/docs/cpp/namespacearrow.html +++ b/docs/cpp/namespacearrow.html @@ -89,8 +89,12 @@ Namespaces</h2></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:namespacearrow_1_1ipc"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html">ipc</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:namespacearrow_1_1meta"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1meta.html">meta</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:namespacearrow_1_1py"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1py.html">py</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:namespacearrow_1_1stl"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1stl.html">stl</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:namespacearrow_1_1util"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1util.html">util</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> @@ -135,9 +139,10 @@ Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_brotli_codec.html">BrotliCodec</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html">Buffer</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Immutable API for a chunk of bytes which may or may not be owned by the class instance. <a href="classarrow_1_1_buffer.html#details">More...</a><br /></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Object containing a pointer to a piece of contiguous memory with a particular size. <a href="classarrow_1_1_buffer.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html">BufferBuilder</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class for incrementally building a contiguous chunk of in-memory data. <a href="classarrow_1_1_buffer_builder.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_chunked_array.html">ChunkedArray</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A data structure managing a list of primitive Arrow arrays logically as one large array. <a href="classarrow_1_1_chunked_array.html#details">More...</a><br /></td></tr> @@ -145,7 +150,7 @@ Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_codec.html">Codec</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_column.html">Column</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An immutable column data structure consisting of a field (type metadata) and a logical chunked data array. <a href="classarrow_1_1_column.html#details">More...</a><br /></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">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><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1_compression.html">Compression</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> @@ -178,7 +183,7 @@ Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_dictionary_array.html">DictionaryArray</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_dictionary_builder.html">DictionaryBuilder</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><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> builder for created encoded <a class="el" href="classarrow_1_1_dictionary_array.html">DictionaryArray</a> from dense array data. <a href="classarrow_1_1_dictionary_builder.html#details">More...</a><br /></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><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> builder for created encoded <a class="el" href="classarrow_1_1_dictionary_array.html">DictionaryArray</a> from dense array. <a href="classarrow_1_1_dictionary_builder.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_dictionary_builder_3_01_null_type_01_4.html">DictionaryBuilder< NullType ></a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> @@ -254,7 +259,7 @@ Classes</h2></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for memory allocation. <a href="classarrow_1_1_memory_pool.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_mutable_buffer.html">MutableBuffer</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A <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> whose contents can be mutated. May or may not own its data. <a href="classarrow_1_1_mutable_buffer.html#details">More...</a><br /></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A <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> whose contents can be mutated. <a href="classarrow_1_1_mutable_buffer.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_nested_type.html">NestedType</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> @@ -280,7 +285,7 @@ Classes</h2></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A superclass for types having additional metadata. <a href="classarrow_1_1_parametric_type.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_pool_buffer.html">PoolBuffer</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A <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> whose lifetime is tied to a particular <a class="el" href="classarrow_1_1_memory_pool.html" title="Base class for memory allocation. ">MemoryPool</a>. <a href="classarrow_1_1_pool_buffer.html#details">More...</a><br /></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A <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> whose lifetime is tied to a particular <a class="el" href="classarrow_1_1_memory_pool.html" title="Base class for memory allocation. ">MemoryPool</a>. <a href="classarrow_1_1_pool_buffer.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1_pretty_print_options.html">PrettyPrintOptions</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> @@ -301,6 +306,7 @@ Classes</h2></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Abstract interface for reading stream of record batches. <a href="classarrow_1_1_record_batch_reader.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_resizable_buffer.html">ResizableBuffer</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A mutable buffer that can be resized. <a href="classarrow_1_1_resizable_buffer.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_rle_decoder.html">RleDecoder</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Utility classes to do run length encoding (RLE) for fixed bit width values. <a href="classarrow_1_1_rle_decoder.html#details">More...</a><br /></td></tr> @@ -528,9 +534,6 @@ Functions</h2></td></tr> <tr class="memitem:aaaffa5e80489838d1a7a8fcb67a8fb17"><td class="memTemplParams" colspan="2">template<class T1 , class T2 > </td></tr> <tr class="memitem:aaaffa5e80489838d1a7a8fcb67a8fb17"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearrow.html#aaaffa5e80489838d1a7a8fcb67a8fb17">operator!=</a> (const <a class="el" href="classarrow_1_1stl__allocator.html">stl_allocator</a>< T1 > &lhs, const <a class="el" href="classarrow_1_1stl__allocator.html">stl_allocator</a>< T2 > &rhs) noexcept</td></tr> <tr class="separator:aaaffa5e80489838d1a7a8fcb67a8fb17"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:afb8595b074fc27a018140f07a26ac23e"><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="namespacearrow.html#afb8595b074fc27a018140f07a26ac23e">MakeArray</a> (const std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > &data, std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > *out)</td></tr> -<tr class="memdesc:afb8595b074fc27a018140f07a26ac23e"><td class="mdescLeft"> </td><td class="mdescRight">Create a strongly-typed <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> instance from generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a>. <a href="#afb8595b074fc27a018140f07a26ac23e">More...</a><br /></td></tr> -<tr class="separator:afb8595b074fc27a018140f07a26ac23e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7edcc7f88dec3ddcfcd8ccf1882cb833"><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="namespacearrow.html#a7edcc7f88dec3ddcfcd8ccf1882cb833">MakeArray</a> (const std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > &data)</td></tr> <tr class="memdesc:a7edcc7f88dec3ddcfcd8ccf1882cb833"><td class="mdescLeft"> </td><td class="mdescRight">Create a strongly-typed <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> instance from generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a>. <a href="#a7edcc7f88dec3ddcfcd8ccf1882cb833">More...</a><br /></td></tr> <tr class="separator:a7edcc7f88dec3ddcfcd8ccf1882cb833"><td class="memSeparator" colspan="2"> </td></tr> @@ -548,20 +551,6 @@ Functions</h2></td></tr> <tr class="separator:a9c3ce000978a518fad942be4a54e9870"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a08900491dab187842698af9cca156b17"><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="namespacearrow.html#a08900491dab187842698af9cca156b17">MakeBuilder</a> (<a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool, const std::shared_ptr< <a class="el" href="classarrow_1_1_data_type.html">DataType</a> > &type, std::unique_ptr< <a class="el" href="classarrow_1_1_array_builder.html">ArrayBuilder</a> > *out)</td></tr> <tr class="separator:a08900491dab187842698af9cca156b17"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a8753654b0dc794946d5205aa30fa54c6"><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="namespacearrow.html#a8753654b0dc794946d5205aa30fa54c6">ArrayEquals</a> (const <a class="el" href="classarrow_1_1_array.html">Array</a> &left, const <a class="el" href="classarrow_1_1_array.html">Array</a> &right, bool *are_equal)</td></tr> -<tr class="memdesc:a8753654b0dc794946d5205aa30fa54c6"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the arrays are exactly equal. <a href="#a8753654b0dc794946d5205aa30fa54c6">More...</a><br /></td></tr> -<tr class="separator:a8753654b0dc794946d5205aa30fa54c6"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a94b24ab7fc29a4ccfd9035f008e6e7e9"><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="namespacearrow.html#a94b24ab7fc29a4ccfd9035f008e6e7e9">TensorEquals</a> (const <a class="el" href="classarrow_1_1_tensor.html">Tensor</a> &left, const <a class="el" href="classarrow_1_1_tensor.html">Tensor</a> &right, bool *are_equal)</td></tr> -<tr class="separator:a94b24ab7fc29a4ccfd9035f008e6e7e9"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aefba3083236a8c610ba6e47b1e8f077f"><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="namespacearrow.html#aefba3083236a8c610ba6e47b1e8f077f">ArrayApproxEquals</a> (const <a class="el" href="classarrow_1_1_array.html">Array</a> &left, const <a class="el" href="classarrow_1_1_array.html">Array</a> &right, bool *are_equal)</td></tr> -<tr class="memdesc:aefba3083236a8c610ba6e47b1e8f077f"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the arrays are approximately equal. <a href="#aefba3083236a8c610ba6e47b1e8f077f">More...</a><br /></td></tr> -<tr class="separator:aefba3083236a8c610ba6e47b1e8f077f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6f9150ffb3b41c37044eea962e0e0845"><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="namespacearrow.html#a6f9150ffb3b41c37044eea962e0e0845">ArrayRangeEquals</a> (const <a class="el" href="classarrow_1_1_array.html">Array</a> &left, const <a class="el" href="classarrow_1_1_array.html">Array</a> &right, int64_t start_idx, int64_t end_idx, int64_t other_start_idx, bool *are_equal)</td></tr> -<tr class="memdesc:a6f9150ffb3b41c37044eea962e0e0845"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if indicated equal-length segment of arrays is exactly equal. <a href="#a6f9150ffb3b41c37044eea962e0e0845">More...</a><br /></td></tr> -<tr class="separator:a6f9150ffb3b41c37044eea962e0e0845"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a73533bccd4b4e0d9ddb068f2b4876ded"><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="namespacearrow.html#a73533bccd4b4e0d9ddb068f2b4876ded">TypeEquals</a> (const <a class="el" href="classarrow_1_1_data_type.html">DataType</a> &left, const <a class="el" href="classarrow_1_1_data_type.html">DataType</a> &right, bool *are_equal)</td></tr> -<tr class="memdesc:a73533bccd4b4e0d9ddb068f2b4876ded"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the type metadata are exactly equal. <a href="#a73533bccd4b4e0d9ddb068f2b4876ded">More...</a><br /></td></tr> -<tr class="separator:a73533bccd4b4e0d9ddb068f2b4876ded"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a48cc628afeb953d5acb013f89d82b54e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a48cc628afeb953d5acb013f89d82b54e">ArrayEquals</a> (const <a class="el" href="classarrow_1_1_array.html">Array</a> &left, const <a class="el" href="classarrow_1_1_array.html">Array</a> &right)</td></tr> <tr class="memdesc:a48cc628afeb953d5acb013f89d82b54e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the arrays are exactly equal. <a href="#a48cc628afeb953d5acb013f89d82b54e">More...</a><br /></td></tr> <tr class="separator:a48cc628afeb953d5acb013f89d82b54e"><td class="memSeparator" colspan="2"> </td></tr> @@ -593,9 +582,6 @@ Functions</h2></td></tr> <tr class="memitem:a28fe3ae0374aa37d7321c23e4f0cafce"><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="namespacearrow.html#a28fe3ae0374aa37d7321c23e4f0cafce">ConcatenateTables</a> (const std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_table.html">Table</a> >> &tables, std::shared_ptr< <a class="el" href="classarrow_1_1_table.html">Table</a> > *table)</td></tr> <tr class="memdesc:a28fe3ae0374aa37d7321c23e4f0cafce"><td class="mdescLeft"> </td><td class="mdescRight">Construct table from multiple input tables. <a href="#a28fe3ae0374aa37d7321c23e4f0cafce">More...</a><br /></td></tr> <tr class="separator:a28fe3ae0374aa37d7321c23e4f0cafce"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a3aa59f9996c2d3d15b2848b4a3df6859"><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="namespacearrow.html#a3aa59f9996c2d3d15b2848b4a3df6859">MakeTable</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>, const std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> >> &arrays, std::shared_ptr< <a class="el" href="classarrow_1_1_table.html">Table</a> > *table)</td></tr> -<tr class="memdesc:a3aa59f9996c2d3d15b2848b4a3df6859"><td class="mdescLeft"> </td><td class="mdescRight">Construct table from multiple input tables. <a href="#a3aa59f9996c2d3d15b2848b4a3df6859">More...</a><br /></td></tr> -<tr class="separator:a3aa59f9996c2d3d15b2848b4a3df6859"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5709505547e744fa9cf7ddb09b1c2984"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a5709505547e744fa9cf7ddb09b1c2984">operator<<</a> (std::ostream &os, const <a class="el" href="classarrow_1_1_data_type.html">DataType</a> &type)</td></tr> <tr class="separator:a5709505547e744fa9cf7ddb09b1c2984"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acaf5c20d8caef81e01621a3cad7cc9c2"><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="namespacearrow.html#acaf5c20d8caef81e01621a3cad7cc9c2">fixed_size_binary</a> (int32_t byte_width)</td></tr> @@ -761,6 +747,12 @@ Variables</h2></td></tr> <tr class="separator:a2ce8c26ae281746cdfc6f7c5cbde7df9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad6271e8c021240991a109f9776cd0c89"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#ad6271e8c021240991a109f9776cd0c89">NumericArray< TimestampType ></a></td></tr> <tr class="separator:ad6271e8c021240991a109f9776cd0c89"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6c4f8bc1a6b7bfa3386005a0bede3640"><td class="memItemLeft" align="right" valign="top">constexpr int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a6c4f8bc1a6b7bfa3386005a0bede3640">kBinaryMemoryLimit</a> = std::numeric_limits<int32_t>::max() - 1</td></tr> +<tr class="separator:a6c4f8bc1a6b7bfa3386005a0bede3640"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab64d5a2a0d35fbe0ae87fc18d2a5c0ee"><td class="memItemLeft" align="right" valign="top">constexpr int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#ab64d5a2a0d35fbe0ae87fc18d2a5c0ee">kListMaximumElements</a> = std::numeric_limits<int32_t>::max() - 1</td></tr> +<tr class="separator:ab64d5a2a0d35fbe0ae87fc18d2a5c0ee"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4cd38814abf185253aa1c8f68c9ca5ab"><td class="memItemLeft" align="right" valign="top">constexpr int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a4cd38814abf185253aa1c8f68c9ca5ab">kMinBuilderCapacity</a> = 1 << 5</td></tr> +<tr class="separator:a4cd38814abf185253aa1c8f68c9ca5ab"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Top-level namespace for Apache Arrow C++ API. </p> @@ -1330,45 +1322,8 @@ template<typename T , typename... Args> </div> </div> </div> -<a id="aefba3083236a8c610ba6e47b1e8f077f"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aefba3083236a8c610ba6e47b1e8f077f">◆ </a></span>ArrayApproxEquals() <span class="overload">[1/2]</span></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::ArrayApproxEquals </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classarrow_1_1_array.html">Array</a> & </td> - <td class="paramname"><em>left</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const <a class="el" href="classarrow_1_1_array.html">Array</a> & </td> - <td class="paramname"><em>right</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">bool * </td> - <td class="paramname"><em>are_equal</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns true if the arrays are approximately equal. </p> -<p>For non-floating point types, this is equivalent to ArrayEquals(left, right) </p><dl class="section note"><dt>Note</dt><dd>Deprecated since 0.8.0 </dd></dl> - -</div> -</div> <a id="ab018fcebde82b4d98fb4cd19a477813e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ab018fcebde82b4d98fb4cd19a477813e">◆ </a></span>ArrayApproxEquals() <span class="overload">[2/2]</span></h2> +<h2 class="memtitle"><span class="permalink"><a href="#ab018fcebde82b4d98fb4cd19a477813e">◆ </a></span>ArrayApproxEquals()</h2> <div class="memitem"> <div class="memproto"> @@ -1398,45 +1353,8 @@ template<typename T , typename... Args> </div> </div> </div> -<a id="a8753654b0dc794946d5205aa30fa54c6"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a8753654b0dc794946d5205aa30fa54c6">◆ </a></span>ArrayEquals() <span class="overload">[1/2]</span></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::ArrayEquals </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classarrow_1_1_array.html">Array</a> & </td> - <td class="paramname"><em>left</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const <a class="el" href="classarrow_1_1_array.html">Array</a> & </td> - <td class="paramname"><em>right</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">bool * </td> - <td class="paramname"><em>are_equal</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns true if the arrays are exactly equal. </p> -<dl class="section note"><dt>Note</dt><dd>Deprecated since 0.8.0 </dd></dl> - -</div> -</div> <a id="a48cc628afeb953d5acb013f89d82b54e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a48cc628afeb953d5acb013f89d82b54e">◆ </a></span>ArrayEquals() <span class="overload">[2/2]</span></h2> +<h2 class="memtitle"><span class="permalink"><a href="#a48cc628afeb953d5acb013f89d82b54e">◆ </a></span>ArrayEquals()</h2> <div class="memitem"> <div class="memproto"> @@ -1465,63 +1383,8 @@ template<typename T , typename... Args> </div> </div> </div> -<a id="a6f9150ffb3b41c37044eea962e0e0845"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a6f9150ffb3b41c37044eea962e0e0845">◆ </a></span>ArrayRangeEquals() <span class="overload">[1/2]</span></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::ArrayRangeEquals </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classarrow_1_1_array.html">Array</a> & </td> - <td class="paramname"><em>left</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const <a class="el" href="classarrow_1_1_array.html">Array</a> & </td> - <td class="paramname"><em>right</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int64_t </td> - <td class="paramname"><em>start_idx</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int64_t </td> - <td class="paramname"><em>end_idx</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int64_t </td> - <td class="paramname"><em>other_start_idx</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">bool * </td> - <td class="paramname"><em>are_equal</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns true if indicated equal-length segment of arrays is exactly equal. </p> -<dl class="section note"><dt>Note</dt><dd>Deprecated since 0.8.0 </dd></dl> - -</div> -</div> <a id="a1d4576fdd48ce9e8484b30e3b94fd00d"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a1d4576fdd48ce9e8484b30e3b94fd00d">◆ </a></span>ArrayRangeEquals() <span class="overload">[2/2]</span></h2> +<h2 class="memtitle"><span class="permalink"><a href="#a1d4576fdd48ce9e8484b30e3b94fd00d">◆ </a></span>ArrayRangeEquals()</h2> <div class="memitem"> <div class="memproto"> @@ -2220,47 +2083,8 @@ template<typename T , typename... Args> </div> </div> </div> -<a id="afb8595b074fc27a018140f07a26ac23e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#afb8595b074fc27a018140f07a26ac23e">◆ </a></span>MakeArray() <span class="overload">[1/2]</span></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::MakeArray </td> - <td>(</td> - <td class="paramtype">const std::shared_ptr< <a class="el" href="structarrow_1_1_array_data.html">ArrayData</a> > & </td> - <td class="paramname"><em>data</em>, </td> - </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> -</div><div class="memdoc"> - -<p>Create a strongly-typed <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> instance from generic <a class="el" href="structarrow_1_1_array_data.html" title="Mutable container for generic Arrow array data. ">ArrayData</a>. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>the array contents </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the resulting <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> instance </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> -<dl class="section note"><dt>Note</dt><dd>Deprecated since 0.8.0 </dd></dl> - -</div> -</div> <a id="a7edcc7f88dec3ddcfcd8ccf1882cb833"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a7edcc7f88dec3ddcfcd8ccf1882cb833">◆ </a></span>MakeArray() <span class="overload">[2/2]</span></h2> +<h2 class="memtitle"><span class="permalink"><a href="#a7edcc7f88dec3ddcfcd8ccf1882cb833">◆ </a></span>MakeArray()</h2> <div class="memitem"> <div class="memproto"> @@ -2320,44 +2144,6 @@ template<typename T , typename... Args> </div> </div> </div> -<a id="a3aa59f9996c2d3d15b2848b4a3df6859"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a3aa59f9996c2d3d15b2848b4a3df6859">◆ </a></span>MakeTable()</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::MakeTable </td> - <td>(</td> - <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > & </td> - <td class="paramname"><em>schema</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> >> & </td> - <td class="paramname"><em>arrays</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_table.html">Table</a> > * </td> - <td class="paramname"><em>table</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Construct table from multiple input tables. </p> -<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a>, fails if any schemas are different </dd></dl> -<dl class="section note"><dt>Note</dt><dd>Deprecated since 0.8.0 </dd></dl> - -</div> -</div> <a id="af642d53dac1a6b6b686fb5984d33bc9a"></a> <h2 class="memtitle"><span class="permalink"><a href="#af642d53dac1a6b6b686fb5984d33bc9a">◆ </a></span>null()</h2> @@ -3140,43 +2926,8 @@ template<class FUNCTION > </div> </div> </div> -<a id="a94b24ab7fc29a4ccfd9035f008e6e7e9"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a94b24ab7fc29a4ccfd9035f008e6e7e9">◆ </a></span>TensorEquals() <span class="overload">[1/2]</span></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::TensorEquals </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classarrow_1_1_tensor.html">Tensor</a> & </td> - <td class="paramname"><em>left</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const <a class="el" href="classarrow_1_1_tensor.html">Tensor</a> & </td> - <td class="paramname"><em>right</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">bool * </td> - <td class="paramname"><em>are_equal</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<dl class="section note"><dt>Note</dt><dd>Deprecated since 0.8.0 </dd></dl> - -</div> -</div> <a id="a417a6eae2db5c774057fd4f6adce5700"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a417a6eae2db5c774057fd4f6adce5700">◆ </a></span>TensorEquals() <span class="overload">[2/2]</span></h2> +<h2 class="memtitle"><span class="permalink"><a href="#a417a6eae2db5c774057fd4f6adce5700">◆ </a></span>TensorEquals()</h2> <div class="memitem"> <div class="memproto"> @@ -3293,45 +3044,8 @@ template<class FUNCTION > </div> </div> </div> -<a id="a73533bccd4b4e0d9ddb068f2b4876ded"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a73533bccd4b4e0d9ddb068f2b4876ded">◆ </a></span>TypeEquals() <span class="overload">[1/2]</span></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::TypeEquals </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classarrow_1_1_data_type.html">DataType</a> & </td> - <td class="paramname"><em>left</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const <a class="el" href="classarrow_1_1_data_type.html">DataType</a> & </td> - <td class="paramname"><em>right</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">bool * </td> - <td class="paramname"><em>are_equal</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Returns true if the type metadata are exactly equal. </p> -<dl class="section note"><dt>Note</dt><dd>Deprecated since 0.8.0 </dd></dl> - -</div> -</div> <a id="a143d6d46b882b0cc100584b69283d07e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a143d6d46b882b0cc100584b69283d07e">◆ </a></span>TypeEquals() <span class="overload">[2/2]</span></h2> +<h2 class="memtitle"><span class="permalink"><a href="#a143d6d46b882b0cc100584b69283d07e">◆ </a></span>TypeEquals()</h2> <div class="memitem"> <div class="memproto"> @@ -3616,6 +3330,48 @@ template<typename VISITOR > </div> </div> </div> <h2 class="groupheader">Variable Documentation</h2> +<a id="a6c4f8bc1a6b7bfa3386005a0bede3640"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6c4f8bc1a6b7bfa3386005a0bede3640">◆ </a></span>kBinaryMemoryLimit</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">constexpr int64_t arrow::kBinaryMemoryLimit = std::numeric_limits<int32_t>::max() - 1</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="ab64d5a2a0d35fbe0ae87fc18d2a5c0ee"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab64d5a2a0d35fbe0ae87fc18d2a5c0ee">◆ </a></span>kListMaximumElements</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">constexpr int64_t arrow::kListMaximumElements = std::numeric_limits<int32_t>::max() - 1</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a4cd38814abf185253aa1c8f68c9ca5ab"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4cd38814abf185253aa1c8f68c9ca5ab">◆ </a></span>kMinBuilderCapacity</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">constexpr int64_t arrow::kMinBuilderCapacity = 1 << 5</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> <a id="a2bc89c993234944fd7bdbdfe95812080"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2bc89c993234944fd7bdbdfe95812080">◆ </a></span>kUnknownNullCount</h2>
