Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 56995200CEC for ; Mon, 31 Jul 2017 21:29:25 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 55572165AAD; Mon, 31 Jul 2017 19:29:25 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 987D71654C8 for ; Mon, 31 Jul 2017 21:29:21 +0200 (CEST) Received: (qmail 48045 invoked by uid 500); 31 Jul 2017 19:29:20 -0000 Mailing-List: contact commits-help@arrow.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@arrow.apache.org Delivered-To: mailing list commits@arrow.apache.org Received: (qmail 47912 invoked by uid 99); 31 Jul 2017 19:29:20 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 31 Jul 2017 19:29:20 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 34CA3F3217; Mon, 31 Jul 2017 19:29:19 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: wesm@apache.org To: commits@arrow.apache.org Date: Mon, 31 Jul 2017 19:29:45 -0000 Message-Id: <2353206a494f4db0b0d32b7b60bcb5b1@git.apache.org> In-Reply-To: <6071de26214c4abb89b6232bba6bef9c@git.apache.org> References: <6071de26214c4abb89b6232bba6bef9c@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [27/51] [partial] arrow-site git commit: Update C++ API docs to 0.5.0 archived-at: Mon, 31 Jul 2017 19:29:25 -0000 http://git-wip-us.apache.org/repos/asf/arrow-site/blob/b286da84/docs/cpp/classarrow_1_1_binary_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_binary_builder.html b/docs/cpp/classarrow_1_1_binary_builder.html index 048c767..307e283 100644 --- a/docs/cpp/classarrow_1_1_binary_builder.html +++ b/docs/cpp/classarrow_1_1_binary_builder.html @@ -3,7 +3,8 @@ - + + Apache Arrow (C++): arrow::BinaryBuilder Class Reference @@ -11,9 +12,6 @@ - @@ -32,43 +30,19 @@ - + - - + + + +
+

Builder class for variable-length binary data. + More...

+

#include <builder.h>

Inheritance diagram for arrow::BinaryBuilder:
@@ -105,9 +84,8 @@ Inheritance diagram for arrow::BinaryBuilder:
-arrow::ListBuilder arrow::ArrayBuilder -arrow::StringBuilder +arrow::StringBuilder
@@ -115,87 +93,90 @@ Inheritance diagram for arrow::BinaryBuilder: Public Member Functions - + - + - + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - + + + + + - + - + - - - - - - - - + + + + + + + + - + - - + + - - + + - + - + - - - - + + + + +
 BinaryBuilder (MemoryPool *pool)
 
 BinaryBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type)
 BinaryBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type)
 
Status Append (const uint8_t *value, int32_t length)
Status Append (const uint8_t *value, int32_t length)
 
Status Append (const char *value, int32_t length)
Status Append (const char *value, int32_t length)
 
Status Append (const std::string &value)
 
Status AppendNull ()
 
Status Init (int64_t elements) override
 Allocates initial capacity requirements for the builder. More...
 
Status Resize (int64_t capacity) override
 Resizes the null_bitmap array. More...
 
Status Finish (std::shared_ptr< Array > *out) override
 Creates new Array object to hold the contents of the builder and transfers ownership of the data. More...
 Creates new Array object to hold the contents of the builder and transfers ownership of the data. More...
 
- Public Member Functions inherited from arrow::ListBuilder
 ListBuilder (MemoryPool *pool, std::shared_ptr< ArrayBuilder > value_builder, const std::shared_ptr< DataType > &type=nullptr)
 Use this constructor to incrementally build the value array along with offsets and null bitmap. More...
 
 ListBuilder (MemoryPool *pool, std::shared_ptr< Array > values, const std::shared_ptr< DataType > &type=nullptr)
 Use this constructor to build the list with a pre-existing values array. More...
 
Status Init (int64_t elements) override
 Allocates initial capacity requirements for the builder. More...
 
Status Resize (int64_t capacity) override
 Resizes the null_bitmap array. More...
 
Status Append (const int32_t *offsets, int64_t length, const uint8_t *valid_bytes=nullptr)
 Vector append. More...
 
Status Append (bool is_valid=true)
 Start a new variable-length list slot. More...
 
Status AppendNull ()
 
std::shared_ptr< ArrayBuilder > value_builder () const
 
int64_t value_data_length () const
 
const uint8_t * GetValue (int64_t i, int32_t *out_length) const
 Temporary access to a value. More...
 
- Public Member Functions inherited from arrow::ArrayBuilder
 ArrayBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type)
 ArrayBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type)
 
virtual ~ArrayBuilder ()=default
 
ArrayBuilder * child (int i)
 For nested types. More...
 For nested types. More...
 
int num_children () const
 
int64_t length () const
 
int64_t null_count () const
 
int64_t capacity () const
 
int num_children () const
 
int64_t length () const
 
int64_t null_count () const
 
int64_t capacity () const
 
Status AppendToBitmap (bool is_valid)
 Append to null bitmap. More...
 Append to null bitmap. More...
 
Status AppendToBitmap (const uint8_t *valid_bytes, int64_t length)
 Vector append. More...
Status AppendToBitmap (const uint8_t *valid_bytes, int64_t length)
 Vector append. More...
 
Status SetNotNull (int64_t length)
 Set the next length bits to not null (i.e. valid). More...
Status SetNotNull (int64_t length)
 Set the next length bits to not null (i.e. valid). More...
 
Status Reserve (int64_t elements)
 Ensures there is enough space for adding the number of elements by checking capacity and calling Resize if necessary. More...
 Ensures there is enough space for adding the number of elements by checking capacity and calling Resize if necessary. More...
 
Status Advance (int64_t elements)
 For cases where raw data was memcpy'd into the internal buffers, allows us to advance the length of the builder. More...
 For cases where raw data was memcpy'd into the internal buffers, allows us to advance the length of the builder. More...
 
std::shared_ptr< PoolBuffer > null_bitmap () const
 
std::shared_ptr< DataType > type () const
 
std::shared_ptr< PoolBuffer > null_bitmap () const
 
std::shared_ptr< DataType > type () const
 
+ + + + + + + + + + + + + + + +

+Protected Member Functions

Status AppendNextOffset ()
 
Status FinishInternal (std::shared_ptr< internal::ArrayData > *out)
 
void Reset ()
 
- Protected Member Functions inherited from arrow::ArrayBuilder
void Reset ()
 
void UnsafeAppendToBitmap (bool is_valid)
 
void UnsafeAppendToBitmap (const uint8_t *valid_bytes, int64_t length)
 
void UnsafeSetNotNull (int64_t length)
 
- - - - - - - - - + + + + @@ -214,21 +195,17 @@ Protected Attributes

Protected Attributes

UInt8Builder * byte_builder_
 
- Protected Attributes inherited from arrow::ListBuilder
BufferBuilder offset_builder_
 
std::shared_ptr< ArrayBuilder > value_builder_
 
std::shared_ptr< Array > values_
 
TypedBufferBuilder< int32_t > offsets_builder_
 
TypedBufferBuilder< uint8_t > value_data_builder_
 
- Protected Attributes inherited from arrow::ArrayBuilder
MemoryPool * pool_
 
std::vector< std::unique_ptr< ArrayBuilder > > children_
 
- - - - - - - - - - - + + +

-Additional Inherited Members

- Protected Member Functions inherited from arrow::ListBuilder
void Reset ()
 
- Protected Member Functions inherited from arrow::ArrayBuilder
void UnsafeAppendToBitmap (bool is_valid)
 
void UnsafeAppendToBitmap (const uint8_t *valid_bytes, int64_t length)
 
void UnsafeSetNotNull (int64_t length)
 

+Static Protected Attributes

static constexpr int64_t kMaximumCapacity = std::numeric_limits<int32_t>::max() - 1
 
-

Constructor & Destructor Documentation

- +

Detailed Description

+

Builder class for variable-length binary data.

+

Constructor & Destructor Documentation

+ +

◆ BinaryBuilder() [1/2]

+
@@ -252,7 +229,9 @@ Additional Inherited Members - + +

◆ BinaryBuilder() [2/2]

+
@@ -287,12 +266,11 @@ Additional Inherited Members

Member Function Documentation

- + +

◆ Append() [1/3]

+
-
- - - - -
@@ -312,16 +290,13 @@ Additional Inherited Members
Status arrow::BinaryBuilder::Append
- 		-inline
- + +

◆ Append() [2/3]

+
@@ -355,7 +330,9 @@ Additional Inherited Members - + +

◆ Append() [3/3]

+
@@ -379,7 +356,51 @@ Additional Inherited Members - + +

◆ AppendNextOffset()

+ +
+
+
+ + + + +
+ + + + + + + +
Status arrow::BinaryBuilder::AppendNextOffset ()
+ 		+protected
+
+ +
+
+ +

◆ AppendNull()

+ +
+
+ + + + + + + +
Status arrow::BinaryBuilder::AppendNull ()
+
+ +
+
+ +

◆ Finish()

+
@@ -401,17 +422,233 @@ Additional Inherited Members
-

Creates new Array object to hold the contents of the builder and transfers ownership of the data.

+

Creates new Array object to hold the contents of the builder and transfers ownership of the data.

This resets all variables on the builder.

-

Reimplemented from arrow::ListBuilder.

+

Implements arrow::ArrayBuilder.

Reimplemented in arrow::StringBuilder.

+ +

◆ FinishInternal()

+ +
+
+ + + + + +
+ + + + + + + + +
Status arrow::BinaryBuilder::FinishInternal (std::shared_ptr< internal::ArrayData > * out)
+ 		+protected
+
+ +
+
+ +

◆ GetValue()

+ +
+
+ + + + + + + + + + + + + + + + + + +
const uint8_t * arrow::BinaryBuilder::GetValue (int64_t i,
int32_t * out_length 
) const
+
+ +

Temporary access to a value.

+

This pointer becomes invalid on the next modifying operation.

+ +
+
+ +

◆ Init()

+ +
+
+ + + + + +
+ + + + + + + + +
Status arrow::BinaryBuilder::Init (int64_t capacity)
+ 		+overridevirtual
+
+ +

Allocates initial capacity requirements for the builder.

+

In most cases subclasses should override and call their parent class's method as well.

+ +

Reimplemented from arrow::ArrayBuilder.

+ +
+
+ +

◆ Reset()

+ +
+
+ + + + + +
+ + + + + + + +
void arrow::BinaryBuilder::Reset ()
+ 		+protected
+
+ +
+
+ +

◆ Resize()

+ +
+
+ + + + + +
+ + + + + + + + +
Status arrow::BinaryBuilder::Resize (int64_t new_bits)
+ 		+overridevirtual
+
+ +

Resizes the null_bitmap array.

+

In most cases subclasses should override and call their parent class's method as well.

+ +

Reimplemented from arrow::ArrayBuilder.

+ +
+
+ +

◆ value_data_length()

+ +
+
+ + + + + +
+ + + + + + + +
int64_t arrow::BinaryBuilder::value_data_length () const
+ 		+inline
+
+
Returns
size of values buffer so far
+ +
+

Member Data Documentation

- + +

◆ kMaximumCapacity

+ +
+
+ + + + + +
+ + + + +
constexpr int64_t arrow::BinaryBuilder::kMaximumCapacity = std::numeric_limits<int32_t>::max() - 1
+ 		+staticprotected
+
+ +
+
+ +

◆ offsets_builder_

+ +
+
+ + + + + +
+ + + + +
TypedBufferBuilder<int32_t> arrow::BinaryBuilder::offsets_builder_
+ 		+protected
+
+ +
+
+ +

◆ value_data_builder_

+
@@ -419,7 +656,7 @@ Additional Inherited Members @@ -432,15 +669,15 @@ Additional Inherited Members
The documentation for this class was generated from the following files:
    -
  • /home/uwe/Development/arrow/cpp/src/arrow/builder.h
    • -
  • /home/uwe/Development/arrow/cpp/src/arrow/builder.cc
    • +
  • /home/wesm/code/arrow/cpp/src/arrow/builder.h
    • +
  • /home/wesm/code/arrow/cpp/src/arrow/builder.cc
Generated by   doxygen - 1.8.11 + 1.8.13
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/b286da84/docs/cpp/classarrow_1_1_binary_builder.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_binary_builder.png b/docs/cpp/classarrow_1_1_binary_builder.png index 223f674..ca734e9 100644 Binary files a/docs/cpp/classarrow_1_1_binary_builder.png and b/docs/cpp/classarrow_1_1_binary_builder.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/b286da84/docs/cpp/classarrow_1_1_binary_dictionary_builder-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_binary_dictionary_builder-members.html b/docs/cpp/classarrow_1_1_binary_dictionary_builder-members.html new file mode 100644 index 0000000..cce4e5e --- /dev/null +++ b/docs/cpp/classarrow_1_1_binary_dictionary_builder-members.html @@ -0,0 +1,130 @@ + + + + + + + +Apache Arrow (C++): Member List + + + + + + + + + +
+
+
- +
UInt8Builder* arrow::BinaryBuilder::byte_builder_TypedBufferBuilder<uint8_t> arrow::BinaryBuilder::value_data_builder_
+ + + + + +
+
Apache Arrow (C++) +
+
A columnar in-memory analytics layer designed to accelerate big data.
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
arrow::BinaryDictionaryBuilder Member List
+
+
+ +

This is the complete list of members for arrow::BinaryDictionaryBuilder, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Advance(int64_t elements)arrow::ArrayBuilder
Append(const uint8_t *value, int32_t length)arrow::BinaryDictionaryBuilderinline
Append(const char *value, int32_t length)arrow::BinaryDictionaryBuilderinline
Append(const std::string &value)arrow::BinaryDictionaryBuilderinline
DictionaryBuilder< BinaryType >::Append(const Scalar &value)arrow::DictionaryBuilder< BinaryType >
AppendArray(const Array &array)arrow::DictionaryBuilder< BinaryType >
AppendDictionary(const Scalar &value)arrow::DictionaryBuilder< BinaryType >protected
AppendNull()arrow::DictionaryBuilder< BinaryType >
AppendToBitmap(bool is_valid)arrow::ArrayBuilder
AppendToBitmap(const uint8_t *valid_bytes, int64_t length)arrow::ArrayBuilder
ArrayBuilder(MemoryPool *pool, const std::shared_ptr< DataType > &type)arrow::ArrayBuilderinlineexplicit
capacity() constarrow::ArrayBuilderinline
capacity_arrow::ArrayBuilderprotected
child(int i)arrow::ArrayBuilderinline
children_arrow::ArrayBuilderprotected
dict_builder_arrow::DictionaryBuilder< BinaryType >protected
DictionaryBuilder(MemoryPool *pool, const std::shared_ptr< DataType > &type)arrow::DictionaryBuilder< BinaryType >explicit
DictionaryBuilder(typename std::enable_if< TypeTraits< T1 >::is_parameter_free, MemoryPool * >::type pool)arrow::DictionaryBuilder< BinaryType >inlineexplicit
DoubleTableSize()arrow::DictionaryBuilder< BinaryType >protected
Finish(std::shared_ptr< Array > *out) overridearrow::DictionaryBuilder< BinaryType >virtual
GetDictionaryValue(int64_t index)arrow::DictionaryBuilder< BinaryType >protected
hash_slots_arrow::DictionaryBuilder< BinaryType >protected
hash_table_arrow::DictionaryBuilder< BinaryType >protected
hash_table_size_arrow::DictionaryBuilder< BinaryType >protected
HashValue(const Scalar &value)arrow::DictionaryBuilder< BinaryType >protected
Init(int64_t elements) overridearrow::DictionaryBuilder< BinaryType >virtual
length() constarrow::ArrayBuilderinline
length_arrow::ArrayBuilderprotected
mod_bitmask_arrow::DictionaryBuilder< BinaryType >protected
null_bitmap() constarrow::ArrayBuilderinline
null_bitmap_arrow::ArrayBuilderprotected
null_bitmap_data_arrow::ArrayBuilderprotected
null_count() constarrow::ArrayBuilderinline
null_count_arrow::ArrayBuilderprotected
num_children() constarrow::ArrayBuilderinline
pool_arrow::ArrayBuilderprotected
Reserve(int64_t elements)arrow::ArrayBuilder
Reset()arrow::ArrayBuilderprotected
Resize(int64_t capacity) overridearrow::DictionaryBuilder< BinaryType >virtual
Scalar typedefarrow::DictionaryBuilder< BinaryType >
SetNotNull(int64_t length)arrow::ArrayBuilder
SlotDifferent(hash_slot_t slot, const Scalar &value)arrow::DictionaryBuilder< BinaryType >protected
type() constarrow::ArrayBuilderinline
type_arrow::ArrayBuilderprotected
UnsafeAppendToBitmap(bool is_valid)arrow::ArrayBuilderinlineprotected
UnsafeAppendToBitmap(const uint8_t *valid_bytes, int64_t length)arrow::ArrayBuilderprotected
UnsafeSetNotNull(int64_t length)arrow::ArrayBuilderprotected
values_builder_arrow::DictionaryBuilder< BinaryType >protected
~ArrayBuilder()=defaultarrow::ArrayBuildervirtual
+ +
+Generated by   +doxygen + 1.8.13 +
+ +