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 EAFDF200C87 for ; Mon, 24 Apr 2017 05:03:13 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id E9D31160BC2; Mon, 24 Apr 2017 03:03:13 +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 989B6160BC6 for ; Mon, 24 Apr 2017 05:03:11 +0200 (CEST) Received: (qmail 21328 invoked by uid 500); 24 Apr 2017 03:03:10 -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 20644 invoked by uid 99); 24 Apr 2017 03:03:08 -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, 24 Apr 2017 03:03:08 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 11207F4A42; Mon, 24 Apr 2017 03:03:08 +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, 24 Apr 2017 03:03:32 -0000 Message-Id: <7450ad8a828b48f98534c82689a4ebbd@git.apache.org> In-Reply-To: <8acf4b9e3d914ea19cc941e54aa53d24@git.apache.org> References: <8acf4b9e3d914ea19cc941e54aa53d24@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [26/51] [partial] arrow-site git commit: Add current C++ doxygen API docs archived-at: Mon, 24 Apr 2017 03:03:14 -0000 http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_decimal_builder-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal_builder-members.html b/docs/cpp/classarrow_1_1_decimal_builder-members.html new file mode 100644 index 0000000..ea1d246 --- /dev/null +++ b/docs/cpp/classarrow_1_1_decimal_builder-members.html @@ -0,0 +1,143 @@ + + + + + + +Apache Arrow (C++): Member List + + + + + + + + + +
+
+ + + + + + +
+
Apache Arrow (C++) +
+
A columnar in-memory analytics layer designed to accelerate big data.
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
arrow::DecimalBuilder Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Advance(int64_t elements)arrow::ArrayBuilder
Append(const decimal::Decimal< T > &val)arrow::DecimalBuilder
Append(const decimal::Decimal128 &value)arrow::DecimalBuilder
arrow::FixedSizeBinaryBuilder::Append(const uint8_t *value)arrow::FixedSizeBinaryBuilder
arrow::FixedSizeBinaryBuilder::Append(const uint8_t *data, int64_t length, const uint8_t *valid_bytes=nullptr)arrow::FixedSizeBinaryBuilder
arrow::FixedSizeBinaryBuilder::Append(const std::string &value)arrow::FixedSizeBinaryBuilder
AppendNull()arrow::FixedSizeBinaryBuilder
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
byte_builder_arrow::FixedSizeBinaryBuilderprotected
byte_width_arrow::FixedSizeBinaryBuilderprotected
capacity() const arrow::ArrayBuilderinline
capacity_arrow::ArrayBuilderprotected
child(int i)arrow::ArrayBuilderinline
children_arrow::ArrayBuilderprotected
DecimalBuilder(MemoryPool *pool, const std::shared_ptr< DataType > &type)arrow::DecimalBuilderexplicit
Finish(std::shared_ptr< Array > *out) overridearrow::DecimalBuildervirtual
FixedSizeBinaryBuilder(MemoryPool *pool, const std::shared_ptr< DataType > &type)arrow::FixedSizeBinaryBuilder
Init(int64_t capacity) overridearrow::DecimalBuildervirtual
length() const arrow::ArrayBuilderinline
length_arrow::ArrayBuilderprotected
null_bitmap() const arrow::ArrayBuilderinline
null_bitmap_arrow::ArrayBuilderprotected
null_bitmap_data_arrow::ArrayBuilderprotected
null_count() const arrow::ArrayBuilderinline
null_count_arrow::ArrayBuilderprotected
num_children() const arrow::ArrayBuilderinline
pool_arrow::ArrayBuilderprotected
Reserve(int64_t elements)arrow::ArrayBuilder
Resize(int64_t capacity) overridearrow::DecimalBuildervirtual
SetNotNull(int64_t length)arrow::ArrayBuilder
type() const arrow::ArrayBuilderinline
type_arrow::ArrayBuilderprotected
UnsafeAppendToBitmap(bool is_valid)arrow::ArrayBuilderprotected
UnsafeAppendToBitmap(const uint8_t *valid_bytes, int64_t length)arrow::ArrayBuilderprotected
UnsafeSetNotNull(int64_t length)arrow::ArrayBuilderprotected
~ArrayBuilder()=defaultarrow::ArrayBuildervirtual
+ +
+Generated by   +doxygen + 1.8.6 +
+ + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_decimal_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal_builder.html b/docs/cpp/classarrow_1_1_decimal_builder.html new file mode 100644 index 0000000..b486003 --- /dev/null +++ b/docs/cpp/classarrow_1_1_decimal_builder.html @@ -0,0 +1,381 @@ + + + + + + +Apache Arrow (C++): arrow::DecimalBuilder Class Reference + + + + + + + + + +
+
+ + + + + + +
+
Apache Arrow (C++) +
+
A columnar in-memory analytics layer designed to accelerate big data.
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
arrow::DecimalBuilder Class Reference
+
+
+ +

#include <builder.h>

+
+Inheritance diagram for arrow::DecimalBuilder:
+
+
+ + +arrow::FixedSizeBinaryBuilder +arrow::ArrayBuilder + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 DecimalBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type)
 
template<typename T >
ARROW_EXPORT Status Append (const decimal::Decimal< T > &val)
 
Status Init (int64_t capacity) 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...
 
template<>
ARROW_EXPORT Status Append (const decimal::Decimal128 &value)
 
- Public Member Functions inherited from arrow::FixedSizeBinaryBuilder
 FixedSizeBinaryBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type)
 
Status Append (const uint8_t *value)
 
Status Append (const uint8_t *data, int64_t length, const uint8_t *valid_bytes=nullptr)
 
Status Append (const std::string &value)
 
Status AppendNull ()
 
- Public Member Functions inherited from arrow::ArrayBuilder
 ArrayBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type)
 
virtual ~ArrayBuilder ()=default
 
ArrayBuilder * child (int i)
 For nested types. More...
 
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...
 
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 Reserve (int64_t elements)
 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...
 
std::shared_ptr< PoolBuffer > null_bitmap () const
 
std::shared_ptr< DataType > type () const
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- 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)
 
- Protected Attributes inherited from arrow::FixedSizeBinaryBuilder
int32_t byte_width_
 
BufferBuilder byte_builder_
 
- Protected Attributes inherited from arrow::ArrayBuilder
MemoryPool * pool_
 
std::shared_ptr< DataType > type_
 
std::shared_ptr< PoolBuffer > null_bitmap_
 
int64_t null_count_
 
uint8_t * null_bitmap_data_
 
int64_t length_
 
int64_t capacity_
 
std::vector< std::unique_ptr
+< ArrayBuilder > > 		children_
 
+

Constructor & Destructor Documentation

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
arrow::DecimalBuilder::DecimalBuilder (MemoryPool * pool,
const std::shared_ptr< DataType > & type 
)
+ 		+explicit
+
+ +
+
+

Member Function Documentation

+ +
+
+
+template<>
+ + + + + + + + +
ARROW_EXPORT Status arrow::DecimalBuilder::Append (const decimal::Decimal128 & value)
+
+ +
+
+ +
+
+
+template<typename T >
+ + + + + + + + +
template ARROW_EXPORT Status arrow::DecimalBuilder::Append (const decimal::Decimal< T > & val)
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Status arrow::DecimalBuilder::Finish (std::shared_ptr< Array > * out)
+ 		+overridevirtual
+
+ +

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

+

This resets all variables on the builder.

+

TODO(phillipc): not sure where to get the offset argument here

+ +

Reimplemented from arrow::FixedSizeBinaryBuilder.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Status arrow::DecimalBuilder::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::FixedSizeBinaryBuilder.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Status arrow::DecimalBuilder::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::FixedSizeBinaryBuilder.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • /home/wesm/code/arrow/cpp/src/arrow/builder.h
    • +
  • /home/wesm/code/arrow/cpp/src/arrow/builder.cc
    • +
+
+ +
+Generated by   +doxygen + 1.8.6 +
+ + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_decimal_builder.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal_builder.png b/docs/cpp/classarrow_1_1_decimal_builder.png new file mode 100644 index 0000000..86acfe2 Binary files /dev/null and b/docs/cpp/classarrow_1_1_decimal_builder.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_decimal_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal_type-members.html b/docs/cpp/classarrow_1_1_decimal_type-members.html new file mode 100644 index 0000000..c211ee4 --- /dev/null +++ b/docs/cpp/classarrow_1_1_decimal_type-members.html @@ -0,0 +1,128 @@ + + + + + + +Apache Arrow (C++): Member List + + + + + + + + + +
+
+ + + + + + +
+
Apache Arrow (C++) +
+
A columnar in-memory analytics layer designed to accelerate big data.
+
+
+ + + + + + + + + +
+ +
+ + +
+
+
+
arrow::DecimalType Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + + + + +
Accept(TypeVisitor *visitor) const overridearrow::DecimalTypevirtual
bit_width() const overridearrow::FixedSizeBinaryTypevirtual
byte_width() const arrow::FixedSizeBinaryTypeinline
byte_width_arrow::FixedSizeBinaryTypeprotected
child(int i) const arrow::DataTypeinline
children() const arrow::DataTypeinline
children_arrow::DataTypeprotected
DataType(Type::type id)arrow::DataTypeinlineexplicit
DecimalType(int precision, int scale)arrow::DecimalTypeinlineexplicit
Equals(const DataType &other) const arrow::DataTypevirtual
Equals(const std::shared_ptr< DataType > &other) const arrow::DataType
FixedSizeBinaryType(int32_t byte_width)arrow::FixedSizeBinaryTypeinlineexplicit
FixedSizeBinaryType(int32_t byte_width, Type::type type_id)arrow::FixedSizeBinaryTypeinlineexplicit
GetBufferLayout() const overridearrow::DecimalTypevirtual
id() const arrow::DataTypeinline
id_arrow::DataTypeprotected
name()arrow::DecimalTypeinlinestatic
num_children() const arrow::DataTypeinline
precision() const arrow::DecimalTypeinline
scale() const arrow::DecimalTypeinline
ToString() const overridearrow::DecimalTypevirtual
type_idarrow::DecimalTypestatic
~DataType()arrow::DataTypevirtual
+ +
+Generated by   +doxygen + 1.8.6 +
+ +