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 6E17F200D3F for ; Sat, 4 Nov 2017 11:37:28 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 6C963160BD5; Sat, 4 Nov 2017 10:37:28 +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 C0DA9160C11 for ; Sat, 4 Nov 2017 11:37:23 +0100 (CET) Received: (qmail 16386 invoked by uid 500); 4 Nov 2017 10:37:23 -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 16245 invoked by uid 99); 4 Nov 2017 10:37:22 -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; Sat, 04 Nov 2017 10:37:22 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 9F962F5E12; Sat, 4 Nov 2017 10:37:20 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: uwe@apache.org To: commits@arrow.apache.org Date: Sat, 04 Nov 2017 10:37:51 -0000 Message-Id: <75d4e895568942089253ecd85c4d9251@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [33/51] [partial] arrow-site git commit: API doc update archived-at: Sat, 04 Nov 2017 10:37:28 -0000 http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1_decimal_array-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal_array-members.html b/docs/cpp/classarrow_1_1_decimal_array-members.html index 39b5878..38f347a 100644 --- a/docs/cpp/classarrow_1_1_decimal_array-members.html +++ b/docs/cpp/classarrow_1_1_decimal_array-members.html @@ -82,34 +82,35 @@ $(function() { Equals(const Array &arr) constarrow::Array Equals(const std::shared_ptr< Array > &arr) constarrow::Array FixedSizeBinaryArray(const std::shared_ptr< ArrayData > &data)arrow::FixedSizeBinaryArrayexplicit - FixedSizeBinaryArray(const std::shared_ptr< DataType > &type, int64_t length, const std::shared_ptr< Buffer > &data, const std::shared_ptr< Buffer > &null_bitmap=nullptr, int64_t null_count=0, int64_t offset=0)arrow::FixedSizeBinaryArray + FixedSizeBinaryArray(const std::shared_ptr< DataType > &type, int64_t length, const std::shared_ptr< Buffer > &data, const std::shared_ptr< Buffer > &null_bitmap=NULLPTR, int64_t null_count=0, int64_t offset=0)arrow::FixedSizeBinaryArray FormatValue(int64_t i) constarrow::DecimalArray GetValue(int64_t i) constarrow::FixedSizeBinaryArray IsNull(int64_t i) constarrow::Arrayinline - length() constarrow::Arrayinline - null_bitmap() constarrow::Arrayinline - null_bitmap_data() constarrow::Arrayinline - null_bitmap_data_arrow::Arrayprotected - null_count() constarrow::Array - num_fields() constarrow::Arrayinline - offset() constarrow::Arrayinline - PrimitiveArray(const std::shared_ptr< DataType > &type, int64_t length, const std::shared_ptr< Buffer > &data, const std::shared_ptr< Buffer > &null_bitmap=nullptr, int64_t null_count=0, int64_t offset=0)arrow::PrimitiveArray - PrimitiveArray()arrow::PrimitiveArrayinlineprotected - PrimitiveArray(const std::shared_ptr< ArrayData > &data)arrow::PrimitiveArrayinlineexplicitprotected - RangeEquals(int64_t start_idx, int64_t end_idx, int64_t other_start_idx, const std::shared_ptr< Array > &other) constarrow::Array - RangeEquals(const Array &other, int64_t start_idx, int64_t end_idx, int64_t other_start_idx) constarrow::Array - raw_values() constarrow::PrimitiveArray - raw_values_arrow::PrimitiveArrayprotected - SetData(const std::shared_ptr< ArrayData > &data)arrow::FixedSizeBinaryArrayinlineprotected - Slice(int64_t offset, int64_t length) constarrow::Array - Slice(int64_t offset) constarrow::Array - ToString() constarrow::Array - type() constarrow::Arrayinline - type_id() constarrow::Arrayinline - TypeClass typedefarrow::DecimalArray - Value(int64_t i) constarrow::FixedSizeBinaryArrayinline - values() constarrow::PrimitiveArrayinline - ~Array()=defaultarrow::Arrayvirtual + IsValid(int64_t i) constarrow::Arrayinline + length() constarrow::Arrayinline + null_bitmap() constarrow::Arrayinline + null_bitmap_data() constarrow::Arrayinline + null_bitmap_data_arrow::Arrayprotected + null_count() constarrow::Array + num_fields() constarrow::Arrayinline + offset() constarrow::Arrayinline + PrimitiveArray(const std::shared_ptr< DataType > &type, int64_t length, const std::shared_ptr< Buffer > &data, const std::shared_ptr< Buffer > &null_bitmap=NULLPTR, int64_t null_count=0, int64_t offset=0)arrow::PrimitiveArray + PrimitiveArray()arrow::PrimitiveArrayinlineprotected + PrimitiveArray(const std::shared_ptr< ArrayData > &data)arrow::PrimitiveArrayinlineexplicitprotected + RangeEquals(int64_t start_idx, int64_t end_idx, int64_t other_start_idx, const std::shared_ptr< Array > &other) constarrow::Array + RangeEquals(const Array &other, int64_t start_idx, int64_t end_idx, int64_t other_start_idx) constarrow::Array + raw_values() constarrow::PrimitiveArray + raw_values_arrow::PrimitiveArrayprotected + SetData(const std::shared_ptr< ArrayData > &data)arrow::FixedSizeBinaryArrayinlineprotected + Slice(int64_t offset, int64_t length) constarrow::Array + Slice(int64_t offset) constarrow::Array + ToString() constarrow::Array + type() constarrow::Arrayinline + type_id() constarrow::Arrayinline + TypeClass typedefarrow::DecimalArray + Value(int64_t i) constarrow::FixedSizeBinaryArrayinline + values() constarrow::PrimitiveArrayinline + ~Array()=defaultarrow::Arrayvirtual
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1_decimal_array.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal_array.html b/docs/cpp/classarrow_1_1_decimal_array.html index 93c444f..9855665 100644 --- a/docs/cpp/classarrow_1_1_decimal_array.html +++ b/docs/cpp/classarrow_1_1_decimal_array.html @@ -72,7 +72,7 @@ $(function() {
-

#include <array.h>

+

#include <arrow/array.h>

Inheritance diagram for arrow::DecimalArray:
@@ -104,8 +104,8 @@ Public Member Functions - Public Member Functions inherited from arrow::FixedSizeBinaryArray  FixedSizeBinaryArray (const std::shared_ptr< ArrayData > &data)   - FixedSizeBinaryArray (const std::shared_ptr< DataType > &type, int64_t length, const std::shared_ptr< Buffer > &data, const std::shared_ptr< Buffer > &nu ll_bitmap=nullptr, int64_t null_count=0, int64_t offset=0) -  + FixedSizeBinaryArray (const std::shared_ptr< DataType > &type, int64_t length, const std::shared_ptr< Buffer > &data, const std::shared_ptr< Buffer > &nu ll_bitmap=NULLPTR, int64_t null_count=0, int64_t offset=0) +  const uint8_t * GetValue (int64_t i) const   const uint8_t * Value (int64_t i) const @@ -113,8 +113,8 @@ Public Member Functions int32_t byte_width () const   - Public Member Functions inherited from arrow::PrimitiveArray - PrimitiveArray (const std::shared_ptr< DataType > &type, int64_t length, const std::shared_ptr< Buffer > &data, const std::shared_ptr< Buffer > &null_bitmap=nullptr, int64_t null_count=0, int64_t offset=0) -  + PrimitiveArray (const std::shared_ptr< DataType > &type, int64_t length, const std::shared_ptr< Buffer > &data, const std::shared_ptr< Buffer > &null_bitmap=NULLPTR, int64_t null_count=0, int64_t offset=0) +  std::shared_ptr< Buffer > values () const  Does not account for any slice offset. More...
  @@ -125,8 +125,11 @@ Public Member Functions virtual ~Array ()=default   bool IsNull (int64_t i) const - Determine if a slot is null. For inner loops. Does not boundscheck. More...
+ Return true if value at index is null. Does not boundscheck. More...
  +bool IsValid (int64_t i) const + Return true if value at index is valid (not null). More...
+  int64_t length () const  Size in the number of elements this array contains. More...
  http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/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 index 6c5b866..be51cba 100644 --- a/docs/cpp/classarrow_1_1_decimal_builder-members.html +++ b/docs/cpp/classarrow_1_1_decimal_builder-members.html @@ -74,7 +74,7 @@ $(function() { Append(const Decimal128 &val)arrow::DecimalBuilder arrow::FixedSizeBinaryBuilder::Append(const uint8_t *value)arrow::FixedSizeBinaryBuilder arrow::FixedSizeBinaryBuilder::Append(const std::array< uint8_t, NBYTES > &value)arrow::FixedSizeBinaryBuilderinline - arrow::FixedSizeBinaryBuilder::Append(const uint8_t *data, int64_t length, const uint8_t *valid_bytes=nullptr)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 @@ -88,33 +88,32 @@ $(function() { child(int i)arrow::ArrayBuilderinline children_arrow::ArrayBuilderprotected DecimalBuilder(const std::shared_ptr< DataType > &type, MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)arrow::DecimalBuilderexplicit - 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 - FixedSizeBinaryBuilder(const std::shared_ptr< DataType > &type, MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)arrow::FixedSizeBinaryBuilder - GetValue(int64_t i) constarrow::FixedSizeBinaryBuilder - Init(int64_t elements) overridearrow::FixedSizeBinaryBuildervirtual - length() constarrow::ArrayBuilderinline - length_arrow::ArrayBuilderprotected - 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::FixedSizeBinaryBuildervirtual - SetNotNull(int64_t length)arrow::ArrayBuilder - type() constarrow::ArrayBuilderinline - type_arrow::ArrayBuilderprotected - UnsafeAppendToBitmap(bool is_valid)arrow::ArrayBuilderinlineprotected - UnsafeAppendToBitmap(const uint8_t *valid_bytes, int64_t length)arrow::ArrayBuilderprotected - UnsafeAppendToBitmap(const std::vector< bool > &is_valid)arrow::ArrayBuilderprotected - UnsafeSetNotNull(int64_t length)arrow::ArrayBuilderprotected - value_data_length() constarrow::FixedSizeBinaryBuilderinline - ~ArrayBuilder()=defaultarrow::ArrayBuildervirtual + Finish(std::shared_ptr< Array > *out)arrow::ArrayBuilder + FinishInternal(std::shared_ptr< ArrayData > *out) overridearrow::DecimalBuildervirtual + FixedSizeBinaryBuilder(const std::shared_ptr< DataType > &type, MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)arrow::FixedSizeBinaryBuilder + GetValue(int64_t i) constarrow::FixedSizeBinaryBuilder + Init(int64_t elements) overridearrow::FixedSizeBinaryBuildervirtual + length() constarrow::ArrayBuilderinline + length_arrow::ArrayBuilderprotected + 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::FixedSizeBinaryBuildervirtual + SetNotNull(int64_t length)arrow::ArrayBuilder + type() constarrow::ArrayBuilderinline + type_arrow::ArrayBuilderprotected + UnsafeAppendToBitmap(bool is_valid)arrow::ArrayBuilderinlineprotected + UnsafeAppendToBitmap(const uint8_t *valid_bytes, int64_t length)arrow::ArrayBuilderprotected + UnsafeAppendToBitmap(const std::vector< bool > &is_valid)arrow::ArrayBuilderprotected + UnsafeSetNotNull(int64_t length)arrow::ArrayBuilderprotected + value_data_length() constarrow::FixedSizeBinaryBuilderinline + ~ArrayBuilder()=defaultarrow::ArrayBuildervirtual
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/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 index 74239e2..e147fdc 100644 --- a/docs/cpp/classarrow_1_1_decimal_builder.html +++ b/docs/cpp/classarrow_1_1_decimal_builder.html @@ -71,7 +71,7 @@ $(function() {
-

#include <builder.h>

+

#include <arrow/builder.h>

Inheritance diagram for arrow::DecimalBuilder:
@@ -87,16 +87,12 @@ Inheritance diagram for arrow::DecimalBuilder:
Public Member Functions  DecimalBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)   - DecimalBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type) -  Status Append (const Decimal128 &val)   -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...
-  +Status FinishInternal (std::shared_ptr< ArrayData > *out) override + Return result of builder as an internal generic ArrayData object. More...
+  - Public Member Functions inherited from arrow::FixedSizeBinaryBuilder - FixedSizeBinaryBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type) -   FixedSizeBinaryBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)   Status Append (const uint8_t *value) @@ -104,8 +100,8 @@ Public Member Functions template<size_t NBYTES> Status Append (const std::array< uint8_t, NBYTES > &value)   -Status Append (const uint8_t *data, int64_t length, const uint8_t *valid_bytes=nullptr) -  +Status Append (const uint8_t *data, int64_t length, const uint8_t *valid_bytes=NULLPTR) +  Status Append (const std::string &value)   Status AppendNull () @@ -154,6 +150,9 @@ Public Member Functions   std::shared_ptr< PoolBuffer > null_bitmap () const   +Status Finish (std::shared_ptr< Array > *out) + Return result of builder as an Array object. More...
+  std::shared_ptr< DataType > type () const   @@ -197,7 +196,7 @@ Additional Inherited Members

Constructor & Destructor Documentation

-

◆ DecimalBuilder() [1/2]

+

◆ DecimalBuilder()

@@ -232,43 +231,6 @@ Additional Inherited Members
- -

◆ DecimalBuilder() [2/2]

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
arrow::DecimalBuilder::DecimalBuilder (MemoryPool * pool,
const std::shared_ptr< DataType > & type 
)
- 		-explicit
-
-
Deprecated:
Since 0.6.0
- -
-

Member Function Documentation

◆ Append()

@@ -288,8 +250,8 @@ Additional Inherited Members
- -

◆ Finish()

+ +

◆ FinishInternal()

@@ -298,9 +260,9 @@ Additional Inherited Members - + - + @@ -312,10 +274,17 @@ Additional Inherited Members
Status arrow::DecimalBuilder::Finish Status arrow::DecimalBuilder::FinishInternal (std::shared_ptr< Array > * std::shared_ptr< ArrayData > *  out)
-

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

-

This resets all variables on the builder.

+

Return result of builder as an internal generic ArrayData object.

+

Resets builder

+
Parameters
+ + +
[out]outthe finalized ArrayData object
+
+
+
Returns
Status
-

Reimplemented from arrow::FixedSizeBinaryBuilder.

+

Reimplemented from arrow::FixedSizeBinaryBuilder.

http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1_decimal_type.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal_type.html b/docs/cpp/classarrow_1_1_decimal_type.html index 0e8600b..be145b8 100644 --- a/docs/cpp/classarrow_1_1_decimal_type.html +++ b/docs/cpp/classarrow_1_1_decimal_type.html @@ -72,15 +72,16 @@ $(function() {
-

#include <type.h>

+

#include <arrow/type.h>

Inheritance diagram for arrow::DecimalType:
-arrow::FixedSizeBinaryType +arrow::FixedSizeBinaryType arrow::FixedWidthType +arrow::ParametricType arrow::DataType
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1_decimal_type.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_decimal_type.png b/docs/cpp/classarrow_1_1_decimal_type.png index d91242b..4c26d47 100644 Binary files a/docs/cpp/classarrow_1_1_decimal_type.png and b/docs/cpp/classarrow_1_1_decimal_type.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1_dictionary_array-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_dictionary_array-members.html b/docs/cpp/classarrow_1_1_dictionary_array-members.html index a81fb72..0005e6d 100644 --- a/docs/cpp/classarrow_1_1_dictionary_array-members.html +++ b/docs/cpp/classarrow_1_1_dictionary_array-members.html @@ -84,22 +84,23 @@ $(function() { Equals(const std::shared_ptr< Array > &arr) constarrow::Array indices() constarrow::DictionaryArray IsNull(int64_t i) constarrow::Arrayinline - length() constarrow::Arrayinline - null_bitmap() constarrow::Arrayinline - null_bitmap_data() constarrow::Arrayinline - null_bitmap_data_arrow::Arrayprotected - null_count() constarrow::Array - num_fields() constarrow::Arrayinline - offset() constarrow::Arrayinline - RangeEquals(int64_t start_idx, int64_t end_idx, int64_t other_start_idx, const std::shared_ptr< Array > &other) constarrow::Array - RangeEquals(const Array &other, int64_t start_idx, int64_t end_idx, int64_t other_start_idx) constarrow::Array - Slice(int64_t offset, int64_t length) constarrow::Array - Slice(int64_t offset) constarrow::Array - ToString() constarrow::Array - type() constarrow::Arrayinline - type_id() constarrow::Arrayinline - TypeClass typedefarrow::DictionaryArray - ~Array()=defaultarrow::Arrayvirtual + IsValid(int64_t i) constarrow::Arrayinline + length() constarrow::Arrayinline + null_bitmap() constarrow::Arrayinline + null_bitmap_data() constarrow::Arrayinline + null_bitmap_data_arrow::Arrayprotected + null_count() constarrow::Array + num_fields() constarrow::Arrayinline + offset() constarrow::Arrayinline + RangeEquals(int64_t start_idx, int64_t end_idx, int64_t other_start_idx, const std::shared_ptr< Array > &other) constarrow::Array + RangeEquals(const Array &other, int64_t start_idx, int64_t end_idx, int64_t other_start_idx) constarrow::Array + Slice(int64_t offset, int64_t length) constarrow::Array + Slice(int64_t offset) constarrow::Array + ToString() constarrow::Array + type() constarrow::Arrayinline + type_id() constarrow::Arrayinline + TypeClass typedefarrow::DictionaryArray + ~Array()=defaultarrow::Arrayvirtual
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1_dictionary_array.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_dictionary_array.html b/docs/cpp/classarrow_1_1_dictionary_array.html index 4fd487d..e52d8f4 100644 --- a/docs/cpp/classarrow_1_1_dictionary_array.html +++ b/docs/cpp/classarrow_1_1_dictionary_array.html @@ -72,7 +72,7 @@ $(function() {
-

#include <array.h>

+

#include <arrow/array.h>

Inheritance diagram for arrow::DictionaryArray:
@@ -104,8 +104,11 @@ Public Member Functions virtual ~Array ()=default   bool IsNull (int64_t i) const - Determine if a slot is null. For inner loops. Does not boundscheck. More...
+ Return true if value at index is null. Does not boundscheck. More...
  +bool IsValid (int64_t i) const + Return true if value at index is valid (not null). More...
+  int64_t length () const  Size in the number of elements this array contains. More...