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 52A10200D14 for ; Mon, 18 Sep 2017 22:42:06 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 513BD1609DB; Mon, 18 Sep 2017 20:42:06 +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 8D6571609DF for ; Mon, 18 Sep 2017 22:42:03 +0200 (CEST) Received: (qmail 4294 invoked by uid 500); 18 Sep 2017 20:42:02 -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 4234 invoked by uid 99); 18 Sep 2017 20:42:02 -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, 18 Sep 2017 20:42:02 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id A53F7F5827; Mon, 18 Sep 2017 20:42:01 +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, 18 Sep 2017 20:42:30 -0000 Message-Id: In-Reply-To: <5c8e60681c78469197d08432882f646f@git.apache.org> References: <5c8e60681c78469197d08432882f646f@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [31/51] [partial] arrow-site git commit: Update C++ and Python API documentation for 0.7.0 archived-at: Mon, 18 Sep 2017 20:42:06 -0000 http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/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 44ce926..88c46cd 100644 --- a/docs/cpp/classarrow_1_1_decimal_builder.html +++ b/docs/cpp/classarrow_1_1_decimal_builder.html @@ -85,37 +85,42 @@ Inheritance diagram for arrow::DecimalBuilder: - - + + - - - - - - - - - + + - - + + + + + + + + + + + + + + @@ -155,12 +160,16 @@ Public Member Functions + + + + @@ -187,8 +196,8 @@ Additional Inherited Members

Public Member Functions

 DecimalBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool=default_memory_pool())
 
 DecimalBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)
 
 DecimalBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type)
 
template<typename T >
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 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...
 
- 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=default_memory_pool())
 
 FixedSizeBinaryBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)
 
Status Append (const uint8_t *value)
 
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 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...
 
int64_t value_data_length () const
 
const uint8_t * GetValue (int64_t i) const
 Temporary access to a value. More...
 
- Public Member Functions inherited from arrow::ArrayBuilder
 ArrayBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool)
 

Additional Inherited Members

- Protected Member Functions inherited from arrow::ArrayBuilder
 ArrayBuilder ()
 
void Reset ()
 
void UnsafeAppendToBitmap (bool is_valid)
 
void UnsafeAppendToBitmap (const uint8_t *valid_bytes, int64_t length)
 
void UnsafeAppendToBitmap (const std::vector< bool > &is_valid)
 
void UnsafeSetNotNull (int64_t length)
 
- Protected Attributes inherited from arrow::FixedSizeBinaryBuilder
 

Constructor & Destructor Documentation

- -

◆ DecimalBuilder() [1/2]

+ +

◆ DecimalBuilder() [1/2]

@@ -205,8 +214,8 @@ Additional Inherited Members - MemoryPool *  - pool = default_memory_pool()  + MemoryPool *pool  + ARROW_MEMORY_POOL_DEFAULT  @@ -256,23 +265,21 @@ Additional Inherited Members
-
Deprecated:
Since 0.6.0
+
Deprecated:
Since 0.6.0

Member Function Documentation

- -

◆ Append()

+ +

◆ Append()

-
-template<typename T >
- + @@ -312,68 +319,6 @@ template<typename T > - -

◆ Init()

- -
-
-
Status arrow::DecimalBuilder::Append (const decimal::Decimal< T > & const Decimal128 &  val)
- - - - -
- - - - - - - - -
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.

- -
-
- -

◆ Resize()

- -
-
- - - - - -
- - - - - - - - -
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 file:
  • /home/wesm/code/arrow/cpp/src/arrow/builder.h
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/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 index dbd840b..a3e6c31 100644 --- a/docs/cpp/classarrow_1_1_decimal_type-members.html +++ b/docs/cpp/classarrow_1_1_decimal_type-members.html @@ -78,18 +78,18 @@ $(function() { children() constarrow::DataTypeinline children_arrow::DataTypeprotected DataType(Type::type id)arrow::DataTypeinlineexplicit - DecimalType(int precision, int scale)arrow::DecimalTypeinlineexplicit + DecimalType(int32_t precision, int32_t scale)arrow::DecimalTypeinlineexplicit Equals(const DataType &other) constarrow::DataTypevirtual Equals(const std::shared_ptr< DataType > &other) constarrow::DataType FixedSizeBinaryType(int32_t byte_width)arrow::FixedSizeBinaryTypeinlineexplicit FixedSizeBinaryType(int32_t byte_width, Type::type type_id)arrow::FixedSizeBinaryTypeinlineexplicit - GetBufferLayout() const overridearrow::DecimalTypevirtual + GetBufferLayout() const overridearrow::FixedSizeBinaryTypevirtual id() constarrow::DataTypeinline id_arrow::DataTypeprotected - name()arrow::DecimalTypeinlinestatic + name() const overridearrow::DecimalTypeinlinevirtual num_children() constarrow::DataTypeinline - precision() constarrow::DecimalTypeinline - scale() constarrow::DecimalTypeinline + precision() constarrow::DecimalTypeinline + scale() constarrow::DecimalTypeinline ToString() const overridearrow::DecimalTypevirtual type_idarrow::DecimalTypestatic ~DataType()arrow::DataTypevirtual http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/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 4b8b339..a031bdc 100644 --- a/docs/cpp/classarrow_1_1_decimal_type.html +++ b/docs/cpp/classarrow_1_1_decimal_type.html @@ -65,7 +65,6 @@ $(function() {
Public Member Functions | -Static Public Member Functions | Static Public Attributes | List of all members
@@ -88,23 +87,27 @@ Inheritance diagram for arrow::DecimalType:
- - - - + + + - - - - + + + + + + + + + @@ -127,14 +130,6 @@ Public Member Functions

Public Member Functions

 DecimalType (int precision, int scale)
 
std::vector< BufferDescr > GetBufferLayout () const override
 
 DecimalType (int32_t precision, int32_t scale)
 
Status Accept (TypeVisitor *visitor) const override
 
std::string ToString () const override
 A string representation of the type, including any children. More...
 
int precision () const
 
int scale () const
 
std::string name () const override
 A string name of the type, omitting any child fields. More...
 
int32_t precision () const
 
int32_t scale () const
 
- Public Member Functions inherited from arrow::FixedSizeBinaryType
 FixedSizeBinaryType (int32_t byte_width)
 
 FixedSizeBinaryType (int32_t byte_width, Type::type type_id)
 
std::vector< BufferDescr > GetBufferLayout () const override
 
int32_t byte_width () const
 
int bit_width () const override
Type::type id () const
 
- - - - - - -

-Static Public Member Functions

static std::string name ()
 
- Static Public Member Functions inherited from arrow::FixedSizeBinaryType
static std::string name ()
 
@@ -155,8 +150,8 @@ Additional Inherited Members

Static Public Attributes

static constexpr Type::type type_id = Type::DECIMAL
 

Constructor & Destructor Documentation

- -

◆ DecimalType()

+ +

◆ DecimalType()

@@ -167,13 +162,13 @@ Additional Inherited Members arrow::DecimalType::DecimalType ( - int  + int32_t  precision, - int  + int32_t  scale  @@ -220,8 +215,8 @@ Additional Inherited Members
- -

◆ GetBufferLayout()

+ +

◆ name()

@@ -230,7 +225,7 @@ Additional Inherited Members - + @@ -238,42 +233,21 @@ Additional Inherited Members
std::vector<BufferDescr> arrow::DecimalType::GetBufferLayout std::string arrow::DecimalType::name ( ) const
-overridevirtual +inlineoverridevirtual
-

Reimplemented from arrow::FixedSizeBinaryType.

+

A string name of the type, omitting any child fields.

+
Note
Experimental API
+
Since
0.7.0
-
-
- -

◆ name()

- -
-
- - - - - -
- - - - - - - -
static std::string arrow::DecimalType::name ()
- 		-inlinestatic
-
+

Reimplemented from arrow::FixedSizeBinaryType.

- -

◆ precision()

+ +

◆ precision()

@@ -282,7 +256,7 @@ Additional Inherited Members - + @@ -297,8 +271,8 @@ Additional Inherited Members - -

◆ scale()

+ +

◆ scale()

@@ -307,7 +281,7 @@ Additional Inherited Members
- - + + - + @@ -93,8 +93,8 @@ $(function() { - - + + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/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 3365593..cc82a33 100644 --- a/docs/cpp/classarrow_1_1_dictionary_array.html +++ b/docs/cpp/classarrow_1_1_dictionary_array.html @@ -90,8 +90,8 @@ Public Types
int arrow::DecimalType::precision int32_t arrow::DecimalType::precision ( ) const
- + @@ -345,6 +319,8 @@ Additional Inherited Members
int arrow::DecimalType::scale int32_t arrow::DecimalType::scale ( ) const
+

A string representation of the type, including any children.

+

Reimplemented from arrow::FixedSizeBinaryType.

http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/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 125920b..a81fb72 100644 --- a/docs/cpp/classarrow_1_1_dictionary_array-members.html +++ b/docs/cpp/classarrow_1_1_dictionary_array-members.html @@ -74,11 +74,11 @@ $(function() {
ApproxEquals(const std::shared_ptr< Array > &arr) constarrow::Array
ApproxEquals(const Array &arr) constarrow::Array
Array()arrow::Arrayinlineprotected
data() constarrow::Arrayinline
data_arrow::Arrayprotected
data() constarrow::Arrayinline
data_arrow::Arrayprotected
dict_type() constarrow::DictionaryArrayinline
dictionary() constarrow::DictionaryArray
DictionaryArray(const std::shared_ptr< internal::ArrayData > &data)arrow::DictionaryArrayexplicit
DictionaryArray(const std::shared_ptr< ArrayData > &data)arrow::DictionaryArrayexplicit
DictionaryArray(const std::shared_ptr< DataType > &type, const std::shared_ptr< Array > &indices)arrow::DictionaryArray
Equals(const Array &arr) constarrow::Array
Equals(const std::shared_ptr< Array > &arr) constarrow::Array
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) const overridearrow::DictionaryArrayvirtual
arrow::Array::Slice(int64_t offset) 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
- - + + @@ -100,9 +100,6 @@ Public Member Functions - - - @@ -143,11 +140,14 @@ Public Member Functions + + + - - + + @@ -158,12 +158,12 @@ Additional Inherited Members - - - + + + - - + +

Public Member Functions

 DictionaryArray (const std::shared_ptr< internal::ArrayData > &data)
 
 DictionaryArray (const std::shared_ptr< ArrayData > &data)
 
 DictionaryArray (const std::shared_ptr< DataType > &type, const std::shared_ptr< Array > &indices)
 
std::shared_ptr< Array > indices () const
 
const DictionaryType * dict_type () const
 
std::shared_ptr< Array > Slice (int64_t offset, int64_t length) const override
 Construct a zero-copy slice of the array with the indicated offset and length. More...
 
- Public Member Functions inherited from arrow::Array
virtual ~Array ()=default
 
 
Status Accept (ArrayVisitor *visitor) const
 
std::shared_ptr< Array > Slice (int64_t offset, int64_t length) const
 Construct a zero-copy slice of the array with the indicated offset and length. More...
 
std::shared_ptr< Array > Slice (int64_t offset) const
 Slice from offset until end of the array. More...
 
std::shared_ptr< internal::ArrayData > data () const
 
std::shared_ptr< ArrayData > data () const
 
int num_fields () const
 
std::string ToString () const
- Protected Member Functions inherited from arrow::Array
 Array ()
 
void SetData (const std::shared_ptr< internal::ArrayData > &data)
 Protected method for constructors. More...
 
void SetData (const std::shared_ptr< ArrayData > &data)
 Protected method for constructors. More...
 
- Protected Attributes inherited from arrow::Array
std::shared_ptr< internal::ArrayData > data_
 
std::shared_ptr< ArrayData > data_
 
const uint8_t * null_bitmap_data_
 
@@ -183,8 +183,8 @@ Additional Inherited Members

Constructor & Destructor Documentation

- -

◆ DictionaryArray() [1/2]

+ +

◆ DictionaryArray() [1/2]

@@ -195,7 +195,7 @@ Additional Inherited Members arrow::DictionaryArray::DictionaryArray ( - const std::shared_ptr< internal::ArrayData > &  + const std::shared_ptr< ArrayData > &  data) @@ -297,54 +297,6 @@ Additional Inherited Members
- -

◆ Slice()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
std::shared_ptr<Array> arrow::DictionaryArray::Slice (int64_t offset,
int64_t length 
) const
- 		-overridevirtual
-
- -

Construct a zero-copy slice of the array with the indicated offset and length.

-
Parameters
- - - -
[in]offsetthe position of the first element in the constructed slice
[in]lengththe length of the slice. If there are not enough elements in the array, the length will be adjusted accordingly
-
-
-
Returns
a new object wrapped in std::shared_ptr<Array>
- -

Implements arrow::Array.

- -
-
The documentation for this class was generated from the following file:
  • /home/wesm/code/arrow/cpp/src/arrow/array.h
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_dictionary_builder-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_dictionary_builder-members.html b/docs/cpp/classarrow_1_1_dictionary_builder-members.html index d62eb9a..ee92021 100644 --- a/docs/cpp/classarrow_1_1_dictionary_builder-members.html +++ b/docs/cpp/classarrow_1_1_dictionary_builder-members.html @@ -78,6 +78,8 @@ $(function() { AppendToBitmap(bool is_valid)arrow::ArrayBuilder AppendToBitmap(const uint8_t *valid_bytes, int64_t length)arrow::ArrayBuilder ArrayBuilder(const std::shared_ptr< DataType > &type, MemoryPool *pool)arrow::ArrayBuilderinlineexplicit + ArrayBuilder()arrow::ArrayBuilderinlineprotected + byte_width_arrow::DictionaryBuilder< T >protected capacity() constarrow::ArrayBuilderinline capacity_arrow::ArrayBuilderprotected child(int i)arrow::ArrayBuilderinline @@ -114,10 +116,11 @@ $(function() { 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< T >protected - ~ArrayBuilder()=defaultarrow::ArrayBuildervirtual - ~DictionaryBuilder()arrow::DictionaryBuilder< T >inline + UnsafeAppendToBitmap(const std::vector< bool > &is_valid)arrow::ArrayBuilderprotected + UnsafeSetNotNull(int64_t length)arrow::ArrayBuilderprotected + values_builder_arrow::DictionaryBuilder< T >protected + ~ArrayBuilder()=defaultarrow::ArrayBuildervirtual + ~DictionaryBuilder()arrow::DictionaryBuilder< T >inline