Apache Arrow (C++)
A columnar in-memory analytics layer designed to accelerate big data.
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
arrow::PrimitiveArray Class Reference

Base class for fixed-size logical types. More...

#include <arrow/array.h>

Inheritance diagram for arrow::PrimitiveArray:
arrow::FlatArray arrow::Array arrow::BooleanArray arrow::FixedSizeBinaryArray arrow::NumericArray< TYPE > arrow::DecimalArray

Public Member Functions

 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< Buffervalues () const
 Does not account for any slice offset. More...
 
const uint8_t * raw_values () const
 Return pointer to start of raw data. More...
 
- Public Member Functions inherited from arrow::Array
virtual ~Array ()=default
 
bool IsNull (int64_t i) const
 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...
 
int64_t offset () const
 A relative position into another array's data, to enable zero-copy slicing. More...
 
int64_t null_count () const
 The number of null entries in the array. More...
 
std::shared_ptr< DataTypetype () const
 
Type::type type_id () const
 
std::shared_ptr< Buffernull_bitmap () const
 Buffer for the null bitmap. More...
 
const uint8_t * null_bitmap_data () const
 Raw pointer to the null bitmap. More...
 
bool Equals (const Array &arr) const
 
bool Equals (const std::shared_ptr< Array > &arr) const
 
bool ApproxEquals (const std::shared_ptr< Array > &arr) const
 
bool ApproxEquals (const Array &arr) const
 
bool RangeEquals (int64_t start_idx, int64_t end_idx, int64_t other_start_idx, const std::shared_ptr< Array > &other) const
 Compare if the range of slots specified are equal for the given array and this array. More...
 
bool RangeEquals (const Array &other, int64_t start_idx, int64_t end_idx, int64_t other_start_idx) const
 
Status Accept (ArrayVisitor *visitor) const
 
std::shared_ptr< ArraySlice (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< ArraySlice (int64_t offset) const
 Slice from offset until end of the array. More...
 
std::shared_ptr< ArrayDatadata () const
 
int num_fields () const
 
std::string ToString () const
 

Protected Member Functions

 PrimitiveArray ()
 
void SetData (const std::shared_ptr< ArrayData > &data)
 
 PrimitiveArray (const std::shared_ptr< ArrayData > &data)
 
- Protected Member Functions inherited from arrow::Array
 Array ()
 
void SetData (const std::shared_ptr< ArrayData > &data)
 Protected method for constructors. More...
 

Protected Attributes

const uint8_t * raw_values_
 
- Protected Attributes inherited from arrow::Array
std::shared_ptr< ArrayDatadata_
 
const uint8_t * null_bitmap_data_
 

Detailed Description

Base class for fixed-size logical types.

Constructor & Destructor Documentation

◆ PrimitiveArray() [1/3]

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() [2/3]

arrow::PrimitiveArray::PrimitiveArray ( )
inlineprotected

◆ PrimitiveArray() [3/3]

arrow::PrimitiveArray::PrimitiveArray ( const std::shared_ptr< ArrayData > &  data)
inlineexplicitprotected

Member Function Documentation

◆ raw_values()

const uint8_t* arrow::PrimitiveArray::raw_values ( ) const

Return pointer to start of raw data.

◆ SetData()

void arrow::PrimitiveArray::SetData ( const std::shared_ptr< ArrayData > &  data)
inlineprotected

◆ values()

std::shared_ptr<Buffer> arrow::PrimitiveArray::values ( ) const
inline

Does not account for any slice offset.

Member Data Documentation

◆ raw_values_

const uint8_t* arrow::PrimitiveArray::raw_values_
protected

The documentation for this class was generated from the following file: