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 724F1200CE6 for ; Wed, 16 Aug 2017 22:54:26 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 70BA2169945; Wed, 16 Aug 2017 20:54:26 +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 80A22169947 for ; Wed, 16 Aug 2017 22:54:22 +0200 (CEST) Received: (qmail 45773 invoked by uid 500); 16 Aug 2017 20:54:21 -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 45102 invoked by uid 99); 16 Aug 2017 20:54: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; Wed, 16 Aug 2017 20:54:20 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 36E9CF5EDA; Wed, 16 Aug 2017 20:54: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: Wed, 16 Aug 2017 20:54:34 -0000 Message-Id: <726b74190a3242ffa39e99d8611f2445@git.apache.org> In-Reply-To: <5f5849186c48461583477b0fdee445e7@git.apache.org> References: <5f5849186c48461583477b0fdee445e7@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [17/51] [partial] arrow-site git commit: Update Java and C++ API docs archived-at: Wed, 16 Aug 2017 20:54:26 -0000 http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_memory_pool.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_memory_pool.html b/docs/cpp/classarrow_1_1_memory_pool.html index da73c8c..825a0c2 100644 --- a/docs/cpp/classarrow_1_1_memory_pool.html +++ b/docs/cpp/classarrow_1_1_memory_pool.html @@ -89,8 +89,8 @@ Inheritance diagram for arrow::MemoryPool: - - + + @@ -103,9 +103,9 @@ Public Member Functions - - - + + +

Public Member Functions

virtual ~MemoryPool ()
 
virtual ~MemoryPool ()
 
virtual Status Allocate (int64_t size, uint8_t **out)=0
 Allocate a new memory region of at least size bytes. More...
 
virtual int64_t bytes_allocated () const =0
 The number of bytes that were allocated and not yet free'd through this allocator. More...
 
virtual int64_t max_memory () const
 Return peak memory allocation in this memory pool. More...
 
virtual int64_t max_memory () const
 Return peak memory allocation in this memory pool. More...
 
@@ -116,8 +116,8 @@ Protected Member Functions

Base class for memory allocation.

Besides tracking the number of allocated bytes, the allocator also should take care of the required 64-byte alignment.

Constructor & Destructor Documentation

- -

◆ ~MemoryPool()

+ +

◆ ~MemoryPool()

@@ -126,7 +126,7 @@ Protected Member Functions

Protected Member Functions

- + @@ -284,8 +284,8 @@ Protected Member Functions - -

◆ max_memory()

+ +

◆ max_memory()

@@ -294,7 +294,7 @@ Protected Member Functions
- - - - + + + + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_null_array-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_null_array-members.html b/docs/cpp/classarrow_1_1_null_array-members.html index d4d13b5..42ead52 100644 --- a/docs/cpp/classarrow_1_1_null_array-members.html +++ b/docs/cpp/classarrow_1_1_null_array-members.html @@ -91,8 +91,8 @@ $(function() { - - + + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_null_array.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_null_array.html b/docs/cpp/classarrow_1_1_null_array.html index 00cdaa0..4300c76 100644 --- a/docs/cpp/classarrow_1_1_null_array.html +++ b/docs/cpp/classarrow_1_1_null_array.html @@ -94,13 +94,13 @@ Public Types
arrow::MemoryPool::~MemoryPool virtual arrow::MemoryPool::~MemoryPool ( )
- + @@ -361,9 +361,8 @@ Protected Member Functions -
The documentation for this class was generated from the following files:
    +
    The documentation for this class was generated from the following file: http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_mutable_buffer.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_mutable_buffer.html b/docs/cpp/classarrow_1_1_mutable_buffer.html index caf9a90..3caa251 100644 --- a/docs/cpp/classarrow_1_1_mutable_buffer.html +++ b/docs/cpp/classarrow_1_1_mutable_buffer.html @@ -82,10 +82,9 @@ Inheritance diagram for arrow::MutableBuffer:
    -arrow::Buffer -arrow::io::MemoryMappedFile::MemoryMap -arrow::ResizableBuffer -arrow::PoolBuffer +arrow::Buffer +arrow::ResizableBuffer +arrow::PoolBuffer
int64_t arrow::MemoryPool::max_memory virtual int64_t arrow::MemoryPool::max_memory ( ) const
@@ -246,9 +245,8 @@ Additional Inherited Members -
The documentation for this class was generated from the following files:
    +
    The documentation for this class was generated from the following file:
    • /home/wesm/code/arrow/cpp/src/arrow/buffer.h
      • -
    • /home/wesm/code/arrow/cpp/src/arrow/buffer.cc
    http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_mutable_buffer.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_mutable_buffer.png b/docs/cpp/classarrow_1_1_mutable_buffer.png index abb4483..cb22dc8 100644 Binary files a/docs/cpp/classarrow_1_1_mutable_buffer.png and b/docs/cpp/classarrow_1_1_mutable_buffer.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_nested_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_nested_type-members.html b/docs/cpp/classarrow_1_1_nested_type-members.html index 9950140..e38a10a 100644 --- a/docs/cpp/classarrow_1_1_nested_type-members.html +++ b/docs/cpp/classarrow_1_1_nested_type-members.html @@ -75,7 +75,7 @@ $(function() {
- + @@ -83,7 +83,7 @@ $(function() { - +
children() constarrow::DataTypeinline
children_arrow::DataTypeprotected
DataType(Type::type id)arrow::DataTypeinlineexplicit
Equals(const DataType &other) constarrow::DataTypevirtual
Equals(const DataType &other) constarrow::DataTypevirtual
Equals(const std::shared_ptr< DataType > &other) constarrow::DataType
GetBufferLayout() const =0arrow::DataTypepure virtual
id() constarrow::DataTypeinline
name()arrow::NestedTypeinlinestatic
num_children() constarrow::DataTypeinline
ToString() const =0arrow::DataTypepure virtual
~DataType()arrow::DataTypevirtual
~DataType()arrow::DataTypevirtual
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_nested_type.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_nested_type.html b/docs/cpp/classarrow_1_1_nested_type.html index 14eaf14..44b70e0 100644 --- a/docs/cpp/classarrow_1_1_nested_type.html +++ b/docs/cpp/classarrow_1_1_nested_type.html @@ -95,10 +95,10 @@ Additional Inherited Members
- Public Member Functions inherited from arrow::DataType
 DataType (Type::type id)
 
virtual ~DataType ()
 
virtual bool Equals (const DataType &other) const
 
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
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
SetData(const std::shared_ptr< internal::ArrayData > &data)arrow::Arrayinlineprotected
Slice(int64_t offset, int64_t length) const overridearrow::NullArrayvirtual
arrow::FlatArray::Slice(int64_t offset) constarrow::Array
Slice(int64_t offset, int64_t length) const overridearrow::NullArrayvirtual
arrow::FlatArray::Slice(int64_t offset) constarrow::Array
ToString() constarrow::Array
type() constarrow::Arrayinline
type_id() constarrow::Arrayinline
- + - - - + + + @@ -141,10 +141,10 @@ Public Member Functions - - - - + + + + @@ -156,11 +156,11 @@ Additional Inherited Members - + - + @@ -195,7 +195,7 @@ Additional Inherited Members - + @@ -236,8 +236,8 @@ Additional Inherited Members

Member Function Documentation

- -

◆ Slice()

+ +

◆ Slice()

@@ -246,7 +246,7 @@ Additional Inherited Members
- + - + @@ -85,7 +85,7 @@ $(function() { - +

Public Member Functions

 NullArray (const std::shared_ptr< internal::ArrayData > &data)
 NullArray (const std::shared_ptr< internal::ArrayData > &data)
 
 NullArray (int64_t length)
 
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...
 
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) const
 Slice from offset until end of the array. More...
 
std::shared_ptr< internal::ArrayData > data () const
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
 
int num_fields () const
 
- Protected Member Functions inherited from arrow::Array
 Array ()
 
void SetData (const std::shared_ptr< internal::ArrayData > &data)
void SetData (const std::shared_ptr< internal::ArrayData > &data)
 Protected method for constructors. More...
 
- Protected Attributes inherited from arrow::Array
std::shared_ptr< internal::ArrayData > data_
std::shared_ptr< internal::ArrayData > data_
 
const uint8_t * null_bitmap_data_
 
arrow::NullArray::NullArray (const std::shared_ptr< internal::ArrayData > & const std::shared_ptr< internal::ArrayData > &  data)
- + @@ -284,9 +284,8 @@ Additional Inherited Members -
The documentation for this class was generated from the following files:
    +
    The documentation for this class was generated from the following file:
    • /home/wesm/code/arrow/cpp/src/arrow/array.h
      • -
    • /home/wesm/code/arrow/cpp/src/arrow/array.cc
    http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_null_builder-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_null_builder-members.html b/docs/cpp/classarrow_1_1_null_builder-members.html new file mode 100644 index 0000000..1f00d18 --- /dev/null +++ b/docs/cpp/classarrow_1_1_null_builder-members.html @@ -0,0 +1,112 @@ + + + + + + + +Apache Arrow (C++): Member List + + + + + + + + + +
    +
    +
std::shared_ptr< Array > arrow::NullArray::Slice std::shared_ptr<Array> arrow::NullArray::Slice ( int64_t  offset,
+ + + + + +
+
Apache Arrow (C++) +
+
A columnar in-memory analytics layer designed to accelerate big data.
+
+ + + + + + + + + +
+
+ + +
+ +
+ + + +
+
+
arrow::NullBuilder Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Advance(int64_t elements)arrow::ArrayBuilder
AppendNull()arrow::NullBuilderinline
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
capacity() constarrow::ArrayBuilderinline
capacity_arrow::ArrayBuilderprotected
child(int i)arrow::ArrayBuilderinline
children_arrow::ArrayBuilderprotected
Finish(std::shared_ptr< Array > *out) overridearrow::NullBuildervirtual
Init(int64_t capacity)arrow::ArrayBuildervirtual
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
NullBuilder(MemoryPool *pool=default_memory_pool())arrow::NullBuilderinlineexplicit
num_children() constarrow::ArrayBuilderinline
pool_arrow::ArrayBuilderprotected
Reserve(int64_t elements)arrow::ArrayBuilder
Reset()arrow::ArrayBuilderprotected
Resize(int64_t new_bits)arrow::ArrayBuildervirtual
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
UnsafeSetNotNull(int64_t length)arrow::ArrayBuilderprotected
~ArrayBuilder()=defaultarrow::ArrayBuildervirtual
+ +
+Generated by   +doxygen + 1.8.13 +
+ + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_null_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_null_builder.html b/docs/cpp/classarrow_1_1_null_builder.html new file mode 100644 index 0000000..40de71d --- /dev/null +++ b/docs/cpp/classarrow_1_1_null_builder.html @@ -0,0 +1,260 @@ + + + + + + + +Apache Arrow (C++): arrow::NullBuilder Class Reference + + + + + + + + + +
+
+ + + + + + +
+
Apache Arrow (C++) +
+
A columnar in-memory analytics layer designed to accelerate big data.
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
arrow::NullBuilder Class Reference
+
+
+ +

#include <builder.h>

+
+Inheritance diagram for arrow::NullBuilder:
+
+
+ + +arrow::ArrayBuilder + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NullBuilder (MemoryPool *pool=default_memory_pool())
 
Status AppendNull ()
 
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::ArrayBuilder
 ArrayBuilder (const std::shared_ptr< DataType > &type, MemoryPool *pool)
 
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...
 
virtual Status Init (int64_t capacity)
 Allocates initial capacity requirements for the builder. More...
 
virtual Status Resize (int64_t new_bits)
 Resizes the null_bitmap array. 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 Reset ()
 
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::ArrayBuilder
std::shared_ptr< DataType > type_
 
MemoryPool * pool_
 
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

+ +

◆ NullBuilder()

+ +
+
+ + + + + +
+ + + + + + + + +
arrow::NullBuilder::NullBuilder (MemoryPool * pool = default_memory_pool())
+ 		+inlineexplicit
+
+ +
+
+

Member Function Documentation

+ +

◆ AppendNull()

+ +
+
+ + + + + +
+ + + + + + + +
Status arrow::NullBuilder::AppendNull ()
+ 		+inline
+
+ +
+
+ +

◆ Finish()

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

+ +

Implements arrow::ArrayBuilder.

+ +
+
+
The documentation for this class was generated from the following file:
    +
  • /home/wesm/code/arrow/cpp/src/arrow/builder.h
    • +
+
+ +
+Generated by   +doxygen + 1.8.13 +
+ + http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_null_builder.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_null_builder.png b/docs/cpp/classarrow_1_1_null_builder.png new file mode 100644 index 0000000..06860e4 Binary files /dev/null and b/docs/cpp/classarrow_1_1_null_builder.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7c942e5c/docs/cpp/classarrow_1_1_null_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_null_type-members.html b/docs/cpp/classarrow_1_1_null_type-members.html index eea6f01..edde5d6 100644 --- a/docs/cpp/classarrow_1_1_null_type-members.html +++ b/docs/cpp/classarrow_1_1_null_type-members.html @@ -75,9 +75,9 @@ $(function() {
children() constarrow::DataTypeinline
children_arrow::DataTypeprotected
DataType(Type::type id)arrow::DataTypeinlineexplicit
Equals(const DataType &other) constarrow::DataTypevirtual
Equals(const DataType &other) constarrow::DataTypevirtual
Equals(const std::shared_ptr< DataType > &other) constarrow::DataType
GetBufferLayout() const overridearrow::NullTypevirtual
GetBufferLayout() const overridearrow::NullTypevirtual
id() constarrow::DataTypeinline
id_arrow::DataTypeprotected
name()arrow::NullTypeinlinestatic
num_children() constarrow::DataTypeinline
ToString() const overridearrow::NullTypevirtual
type_idarrow::NullTypestatic
~DataType()arrow::DataTypevirtual
~DataType()arrow::DataTypevirtual