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 DD0DF200CD6 for ; Mon, 31 Jul 2017 21:29:24 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id DB9E91654AF; Mon, 31 Jul 2017 19:29:24 +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 42E16165383 for ; Mon, 31 Jul 2017 21:29:21 +0200 (CEST) Received: (qmail 47643 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 47560 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 803D3E96B2; 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:28 -0000 Message-Id: <2c1766c457cc4bd99af0c8361e620d84@git.apache.org> In-Reply-To: <6071de26214c4abb89b6232bba6bef9c@git.apache.org> References: <6071de26214c4abb89b6232bba6bef9c@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [10/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_fixed_size_binary_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_fixed_size_binary_builder.html b/docs/cpp/classarrow_1_1_fixed_size_binary_builder.html index c2259f0..06ad93e 100644 --- a/docs/cpp/classarrow_1_1_fixed_size_binary_builder.html +++ b/docs/cpp/classarrow_1_1_fixed_size_binary_builder.html @@ -3,7 +3,8 @@ - + + Apache Arrow (C++): arrow::FixedSizeBinaryBuilder Class Reference @@ -11,9 +12,6 @@ - @@ -32,43 +30,19 @@ - + - - + + + +
- + - + @@ -125,47 +99,49 @@ Public Member Functions - + - + + + - + - + - - - - - - - - + + + + + + + + - + - - + + - - + + - + - + - - - - + + + +

Public Member Functions

 FixedSizeBinaryBuilder (MemoryPool *pool, const std::shared_ptr< DataType > &type)
 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 uint8_t *data, int64_t length, const uint8_t *valid_bytes=nullptr)
 
Status Append (const std::string &value)
 
Status Init (int64_t elements) override
 Allocates initial capacity requirements for the builder. More...
 
Status Resize (int64_t capacity) override
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...
 
int64_t value_data_length () const
 
- 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
 
@@ -194,15 +170,19 @@ Protected Attributes + + - + - +

Protected Attributes

Additional Inherited Members

- 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 UnsafeAppendToBitmap (const uint8_t *valid_bytes, int64_t length)
 
void UnsafeSetNotNull (int64_t length)
void UnsafeSetNotNull (int64_t length)
 

Constructor & Destructor Documentation

- + +

◆ FixedSizeBinaryBuilder()

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

Member Function Documentation

- + +

◆ Append() [1/3]

+
@@ -245,7 +227,9 @@ Additional Inherited Members - + +

◆ Append() [2/3]

+
@@ -277,7 +261,9 @@ Additional Inherited Members - + +

◆ Append() [3/3]

+
@@ -293,7 +279,9 @@ Additional Inherited Members - + +

◆ AppendNull()

+
@@ -308,7 +296,9 @@ Additional Inherited Members - + +

◆ Finish()

+
@@ -330,7 +320,7 @@ 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.

Implements arrow::ArrayBuilder.

@@ -339,7 +329,9 @@ Additional Inherited Members
- + +

◆ Init()

+
@@ -370,7 +362,9 @@ Additional Inherited Members - + +

◆ Resize()

+
@@ -401,8 +395,36 @@ Additional Inherited Members + +

◆ value_data_length()

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

Member Data Documentation

- + +

◆ byte_builder_

+
@@ -422,7 +444,9 @@ Additional Inherited Members - + +

◆ byte_width_

+
@@ -443,15 +467,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_fixed_size_binary_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_fixed_size_binary_type-members.html b/docs/cpp/classarrow_1_1_fixed_size_binary_type-members.html index 527e18f..ad62d33 100644 --- a/docs/cpp/classarrow_1_1_fixed_size_binary_type-members.html +++ b/docs/cpp/classarrow_1_1_fixed_size_binary_type-members.html @@ -3,7 +3,8 @@ - + +Apache Arrow (C++): Member List @@ -11,9 +12,6 @@ - @@ -32,43 +30,19 @@
- + - - + + + +
Accept(TypeVisitor *visitor) const overridearrow::FixedSizeBinaryTypevirtual bit_width() const overridearrow::FixedSizeBinaryTypevirtual - byte_width() const arrow::FixedSizeBinaryTypeinline + byte_width() constarrow::FixedSizeBinaryTypeinline byte_width_arrow::FixedSizeBinaryTypeprotected - child(int i) const arrow::DataTypeinline - children() const arrow::DataTypeinline + child(int i) constarrow::DataTypeinline + children() constarrow::DataTypeinline children_arrow::DataTypeprotected DataType(Type::type id)arrow::DataTypeinlineexplicit - Equals(const DataType &other) const arrow::DataTypevirtual - Equals(const std::shared_ptr< DataType > &other) const arrow::DataType + 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::FixedSizeBinaryTypevirtual - id() const arrow::DataTypeinline + id() constarrow::DataTypeinline id_arrow::DataTypeprotected - num_children() const arrow::DataTypeinline - ToString() const overridearrow::FixedSizeBinaryTypevirtual - type_idarrow::FixedSizeBinaryTypestatic - ~DataType()arrow::DataTypevirtual + name()arrow::FixedSizeBinaryTypeinlinestatic + num_children() constarrow::DataTypeinline + ToString() const overridearrow::FixedSizeBinaryTypevirtual + type_idarrow::FixedSizeBinaryTypestatic + ~DataType()arrow::DataTypevirtual
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_fixed_size_binary_type.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_fixed_size_binary_type.html b/docs/cpp/classarrow_1_1_fixed_size_binary_type.html index c61fcd3..a27a2d0 100644 --- a/docs/cpp/classarrow_1_1_fixed_size_binary_type.html +++ b/docs/cpp/classarrow_1_1_fixed_size_binary_type.html @@ -3,7 +3,8 @@ - + + Apache Arrow (C++): arrow::FixedSizeBinaryType Class Reference @@ -11,9 +12,6 @@ - @@ -32,43 +30,19 @@
- + - - + + + +
Public Member Functions | +Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
@@ -114,9 +89,9 @@ Inheritance diagram for arrow::FixedSizeBinaryType:
- + - + @@ -124,27 +99,32 @@ Public Member Functions - - + + - + - - - - - - - - - - - - + + + + + + + + + + + + +

Public Member Functions

 FixedSizeBinaryType (int32_t byte_width)
 FixedSizeBinaryType (int32_t byte_width)
 
 FixedSizeBinaryType (int32_t byte_width, Type::type type_id)
 FixedSizeBinaryType (int32_t byte_width, Type::type type_id)
 
Status Accept (TypeVisitor *visitor) const override
 
 
std::vector< BufferDescr > GetBufferLayout () const override
 
int32_t byte_width () const
 
int32_t byte_width () const
 
int bit_width () const override
 
- Public Member Functions inherited from arrow::DataType
 DataType (Type::type id)
 DataType (Type::type id)
 
virtual ~DataType ()
 
virtual bool Equals (const DataType &other) const
 
bool Equals (const std::shared_ptr< DataType > &other) const
 
std::shared_ptr< Field > child (int i) const
 
const std::vector< std::shared_ptr< Field > > & children () const
 
int num_children () const
 
Type::type id () const
 
virtual bool Equals (const DataType &other) const
 
bool Equals (const std::shared_ptr< DataType > &other) const
 
std::shared_ptr< Field > child (int i) const
 
const std::vector< std::shared_ptr< Field > > & children () const
 
int num_children () const
 
Type::type id () const
 
+ + +

+Static Public Member Functions

static std::string name ()
 
@@ -162,7 +142,9 @@ Protected Attributes

Static Public Attributes

 

Constructor & Destructor Documentation

- + +

◆ FixedSizeBinaryType() [1/2]

+
@@ -186,7 +168,9 @@ Protected Attributes - + +

◆ FixedSizeBinaryType() [2/2]

+
@@ -221,7 +205,9 @@ Protected Attributes

Member Function Documentation

- + +

◆ Accept()

+
@@ -249,7 +235,9 @@ Protected Attributes - + +

◆ bit_width()

+
@@ -274,7 +262,9 @@ Protected Attributes - + +

◆ byte_width()

+
@@ -297,7 +287,9 @@ Protected Attributes - + +

◆ GetBufferLayout()

+
@@ -324,7 +316,34 @@ Protected Attributes - + +

◆ name()

+ +
+
+
+ + + + +
+ + + + + + + +
static std::string arrow::FixedSizeBinaryType::name ()
+ 		+inlinestatic
+
+ +
+
+ +

◆ ToString()

+
@@ -352,7 +371,9 @@ Protected Attributes

Member Data Documentation

- + +

◆ byte_width_

+
@@ -372,7 +393,9 @@ Protected Attributes - + +

◆ type_id

+
@@ -393,15 +416,15 @@ Protected Attributes
The documentation for this class was generated from the following files:
    -
  • /home/uwe/Development/arrow/cpp/src/arrow/type.h
    • -
  • /home/uwe/Development/arrow/cpp/src/arrow/type.cc
    • +
  • /home/wesm/code/arrow/cpp/src/arrow/type.h
    • +
  • /home/wesm/code/arrow/cpp/src/arrow/type.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_fixed_width_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_fixed_width_type-members.html b/docs/cpp/classarrow_1_1_fixed_width_type-members.html index 9a61aaa..ba224d4 100644 --- a/docs/cpp/classarrow_1_1_fixed_width_type-members.html +++ b/docs/cpp/classarrow_1_1_fixed_width_type-members.html @@ -3,7 +3,8 @@ - + +Apache Arrow (C++): Member List @@ -11,9 +12,6 @@ - @@ -32,43 +30,19 @@
- + - - + + + +
Accept(TypeVisitor *visitor) const =0arrow::DataTypepure virtual bit_width() const =0arrow::FixedWidthTypepure virtual - child(int i) const arrow::DataTypeinline - children() const arrow::DataTypeinline + child(int i) constarrow::DataTypeinline + children() constarrow::DataTypeinline children_arrow::DataTypeprotected DataType(Type::type id)arrow::DataTypeinlineexplicit - Equals(const DataType &other) const arrow::DataTypevirtual - Equals(const std::shared_ptr< DataType > &other) const arrow::DataType + Equals(const DataType &other) constarrow::DataTypevirtual + Equals(const std::shared_ptr< DataType > &other) constarrow::DataType GetBufferLayout() const overridearrow::FixedWidthTypevirtual - id() const arrow::DataTypeinline + id() constarrow::DataTypeinline id_arrow::DataTypeprotected - num_children() const arrow::DataTypeinline + num_children() constarrow::DataTypeinline ToString() const =0arrow::DataTypepure virtual ~DataType()arrow::DataTypevirtual
@@ -115,7 +89,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Generated by   doxygen - 1.8.11 + 1.8.13