Public API for the "Feather" file format, originally created at http://github.com/wesm/feather. More...

Namespaces
	BitUtil

	decimal

	internal

	io

	ipc

	py

	random_internal

	test

Classes
class	AdaptiveIntBuilder

class	AdaptiveIntBuilderBase

class	AdaptiveUIntBuilder

class	ApproxEqualsVisitor

class	Array
	Immutable data array with some logical type and some length. More...

class	ArrayBuilder
	Base class for all data array builders. More...

class	ArrayComponentSource
	Implement this to create new types of Arrow data loaders. More...

class	ArrayEqualsVisitor

class	ArrayLoader

struct	ArrayLoaderContext
	Bookkeeping struct for loading array objects from their constituent pieces of raw data. More...

class	ArrayPrinter

class	ArrayVisitor

struct	as_void

class	BinaryArray

class	BinaryBuilder

class	BinaryType

class	BooleanArray

class	BooleanBuilder

class	BooleanType

class	BrotliCodec

class	Buffer
	Immutable API for a chunk of bytes which may or may not be owned by the class instance. More...

class	BufferBuilder

class	BufferDescr

struct	BufferMetadata

class	ChunkedArray

class	Codec

class	Column

struct	Compression

class	CTypeImpl

class	DataType

class	Date32Type
	Date as int32_t days since UNIX epoch. More...

class	Date64Type
	Date as int64_t milliseconds since UNIX epoch. More...

class	DateType

struct	Decimal

class	DecimalArray

class	DecimalBuilder

class	DecimalType

class	DefaultMemoryPool

class	DictionaryArray

class	DictionaryType

class	DoubleType

class	Field

struct	FieldMetadata

class	FixedSizeBinaryArray

class	FixedSizeBinaryBuilder

class	FixedSizeBinaryType

class	FixedWidthType

class	FloatingPoint

class	FloatType

class	GZipCodec

class	HalfFloatType

class	InMemorySource

class	Int16Type

class	Int32Type

class	Int64Type

class	Int8Type

class	Integer

class	IntegerTypeImpl

class	IntervalType

struct	IsFloatingPoint

struct	IsInteger

struct	IsNumeric

struct	IsSignedInt

struct	IsUnsignedInt

class	KeyValueMetadata

class	ListArray

class	ListBuilder
	Builder class for variable-length list array value types. More...

class	ListType

class	LoggingMemoryPool

class	MemoryPool
	Base class for memory allocation. More...

class	MutableBuffer
	A Buffer whose contents can be mutated. May or may not own its data. More...

class	NestedType

class	NoExtraMeta

class	NullArray
	Degenerate null type Array. More...

class	NullType

class	NumericArray

class	NumericBuilder
	Base class for all Builders that emit an Array of a scalar numerical type. More...

class	NumericTensor

class	PoolBuffer
	A Buffer whose lifetime is tied to a particular MemoryPool. More...

struct	PrettyPrintOptions

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

class	PrimitiveBuilder

class	PrimitiveCType

class	Random

class	RangeEqualsVisitor

class	RecordBatch

class	ResizableBuffer

class	Schema

class	SnappyCodec

class	Status

class	stl_allocator

class	StringArray

class	StringBuilder

class	StringType

class	StructArray

class	StructBuilder
	Append, Resize and Reserve methods are acting on StructBuilder. More...

class	StructType

class	Table

class	Tensor

class	TestBase

class	TestBuilder

class	Time32Type

class	Time64Type

class	TimestampType

class	TimeType

struct	TimeUnit

struct	Type

class	TypeEqualsVisitor

struct	TypeTraits

struct	TypeTraits< BinaryType >

struct	TypeTraits< BooleanType >

struct	TypeTraits< Date32Type >

struct	TypeTraits< Date64Type >

struct	TypeTraits< DecimalType >

struct	TypeTraits< DictionaryType >

struct	TypeTraits< DoubleType >

struct	TypeTraits< FixedSizeBinaryType >

struct	TypeTraits< FloatType >

struct	TypeTraits< HalfFloatType >

struct	TypeTraits< Int16Type >

struct	TypeTraits< Int32Type >

struct	TypeTraits< Int64Type >

struct	TypeTraits< Int8Type >

struct	TypeTraits< ListType >

struct	TypeTraits< NullType >

struct	TypeTraits< StringType >

struct	TypeTraits< StructType >

struct	TypeTraits< Time32Type >

struct	TypeTraits< Time64Type >

struct	TypeTraits< TimestampType >

struct	TypeTraits< UInt16Type >

struct	TypeTraits< UInt32Type >

struct	TypeTraits< UInt64Type >

struct	TypeTraits< UInt8Type >

struct	TypeTraits< UnionType >

class	TypeVisitor

class	UInt16Type

class	UInt32Type

class	UInt64Type

class	UInt8Type

class	UnionArray

class	UnionType

struct	ValidateVisitor

Typedefs
using	UInt8Builder = NumericBuilder< UInt8Type >

using	UInt16Builder = NumericBuilder< UInt16Type >

using	UInt32Builder = NumericBuilder< UInt32Type >

using	UInt64Builder = NumericBuilder< UInt64Type >

using	Int8Builder = NumericBuilder< Int8Type >

using	Int16Builder = NumericBuilder< Int16Type >

using	Int32Builder = NumericBuilder< Int32Type >

using	Int64Builder = NumericBuilder< Int64Type >

using	TimestampBuilder = NumericBuilder< TimestampType >

using	Time32Builder = NumericBuilder< Time32Type >

using	Time64Builder = NumericBuilder< Time64Type >

using	Date32Builder = NumericBuilder< Date32Type >

using	Date64Builder = NumericBuilder< Date64Type >

using	HalfFloatBuilder = NumericBuilder< HalfFloatType >

using	FloatBuilder = NumericBuilder< FloatType >

using	DoubleBuilder = NumericBuilder< DoubleType >

using	ArrayVector = std::vector< std::shared_ptr< Array >>

typedef std::shared_ptr< DataType >	TypePtr

typedef std::shared_ptr< Field >	FieldPtr

using	Date64Array = NumericArray< Date64Type >

using	Date32Array = NumericArray< Date32Type >

using	Time32Array = NumericArray< Time32Type >

using	Time64Array = NumericArray< Time64Type >

using	TimestampArray = NumericArray< TimestampType >

using	IntervalArray = NumericArray< IntervalType >

Enumerations
enum	StatusCode : char { StatusCode::OK = 0, StatusCode::OutOfMemory = 1, StatusCode::KeyError = 2, StatusCode::TypeError = 3, StatusCode::Invalid = 4, StatusCode::IOError = 5, StatusCode::UnknownError = 9, StatusCode::NotImplemented = 10, StatusCode::PlasmaObjectExists = 20, StatusCode::PlasmaObjectNonexistent = 21, StatusCode::PlasmaStoreFull = 22 }

enum	BufferType : char { BufferType::DATA, BufferType::OFFSET, BufferType::TYPE, BufferType::VALIDITY }

enum	UnionMode : char { UnionMode::SPARSE, UnionMode::DENSE }

enum	DateUnit : char { DateUnit::DAY = 0, DateUnit::MILLI = 1 }

Functions
template<class T1 , class T2 >
bool	operator== (const stl_allocator< T1 > &lhs, const stl_allocator< T2 > &rhs) noexcept

template<class T1 , class T2 >
bool	operator!= (const stl_allocator< T1 > &lhs, const stl_allocator< T2 > &rhs) noexcept

Status	ValidateArray (const Array &array)
	Perform any validation checks to determine obvious inconsistencies with the array's internal data. More...

std::shared_ptr< Buffer >	SliceMutableBuffer (const std::shared_ptr< Buffer > &buffer, int64_t offset, int64_t length)
	Construct a mutable buffer slice. More...

Status	AllocateBuffer (MemoryPool pool, int64_t size, std::shared_ptr< MutableBuffer > out)
	Allocate a new mutable buffer from a memory pool. More...

Status	AllocateResizableBuffer (MemoryPool pool, int64_t size, std::shared_ptr< ResizableBuffer > out)

Status	MakeBuilder (MemoryPool pool, const std::shared_ptr< DataType > &type, std::shared_ptr< ArrayBuilder > out)

uint8_t	expanded_uint_size (uint64_t val, uint8_t current_int_size)

uint8_t	expanded_int_size (int64_t val, uint8_t current_int_size)

template<typename TYPE >
bool	FloatingApproxEquals (const NumericArray< TYPE > &left, const NumericArray< TYPE > &right)

template<typename VISITOR >
Status	ArrayEqualsImpl (const Array &left, const Array &right, bool *are_equal)

Status	ArrayEquals (const Array &left, const Array &right, bool *are_equal)
	Returns true if the arrays are exactly equal. More...

Status	ArrayApproxEquals (const Array &left, const Array &right, bool *are_equal)
	Returns true if the arrays are approximately equal. More...

Status	ArrayRangeEquals (const Array &left, const Array &right, int64_t start_idx, int64_t end_idx, int64_t other_start_idx, bool *are_equal)
	Returns true if indicated equal-length segment of arrays is exactly equal. More...

Status	TensorEquals (const Tensor &left, const Tensor &right, bool *are_equal)

Status	TypeEquals (const DataType &left, const DataType &right, bool *are_equal)
	Returns true if the type metadata are exactly equal. More...

Status	LoadArray (const std::shared_ptr< DataType > &type, ArrayComponentSource source, std::shared_ptr< Array > out)
	Construct an Array container from type metadata and a collection of memory buffers. More...

Status	LoadArray (const std::shared_ptr< DataType > &type, ArrayLoaderContext context, std::shared_ptr< Array > out)

Status	LoadArray (const std::shared_ptr< DataType > &type, const std::vector< FieldMetadata > &fields, const std::vector< std::shared_ptr< Buffer >> &buffers, std::shared_ptr< Array > *out)

Status	MakePrimitiveArray (const std::shared_ptr< DataType > &type, int64_t length, const std::shared_ptr< Buffer > &data, const std::shared_ptr< Buffer > &null_bitmap, int64_t null_count, int64_t offset, std::shared_ptr< Array > *out)
	Create new arrays for logical types that are backed by primitive arrays. More...

Status	MakePrimitiveArray (const std::shared_ptr< DataType > &type, const std::vector< std::shared_ptr< Buffer >> &buffers, int64_t length, int64_t null_count, int64_t offset, std::shared_ptr< Array > *out)

MemoryPool *	default_memory_pool ()

Status	PrettyPrint (const Array &arr, int indent, std::ostream *sink)

Status	PrettyPrint (const RecordBatch &batch, int indent, std::ostream *sink)

void	AssertBatchValid (const RecordBatch &batch)

Status	ConcatenateTables (const std::vector< std::shared_ptr< Table >> &tables, std::shared_ptr< Table > *table)

Status ARROW_EXPORT	MakeTable (const std::shared_ptr< Schema > &schema, const std::vector< std::shared_ptr< Array >> &arrays, std::shared_ptr< Table > *table)

template<typename TYPE , typename C_TYPE >
void	ArrayFromVector (const std::shared_ptr< DataType > &type, const std::vector< bool > &is_valid, const std::vector< C_TYPE > &values, std::shared_ptr< Array > *out)

template<typename TYPE , typename C_TYPE >
void	ArrayFromVector (const std::vector< bool > &is_valid, const std::vector< C_TYPE > &values, std::shared_ptr< Array > *out)

template<typename TYPE , typename C_TYPE >
void	ArrayFromVector (const std::vector< C_TYPE > &values, std::shared_ptr< Array > *out)

template<class T , class Builder >
Status	MakeArray (const std::vector< uint8_t > &valid_bytes, const std::vector< T > &values, int64_t size, Builder builder, std::shared_ptr< Array > out)

	ACCEPT_VISITOR (NullType)

	ACCEPT_VISITOR (BooleanType)

	ACCEPT_VISITOR (BinaryType)

	ACCEPT_VISITOR (FixedSizeBinaryType)

	ACCEPT_VISITOR (StringType)

	ACCEPT_VISITOR (ListType)

	ACCEPT_VISITOR (StructType)

	ACCEPT_VISITOR (DecimalType)

	ACCEPT_VISITOR (UnionType)

	ACCEPT_VISITOR (Date32Type)

	ACCEPT_VISITOR (Date64Type)

	ACCEPT_VISITOR (Time32Type)

	ACCEPT_VISITOR (Time64Type)

	ACCEPT_VISITOR (TimestampType)

	ACCEPT_VISITOR (IntervalType)

	ACCEPT_VISITOR (DictionaryType)

	TYPE_FACTORY (null, NullType)

	TYPE_FACTORY (boolean, BooleanType)

	TYPE_FACTORY (int8, Int8Type)

	TYPE_FACTORY (uint8, UInt8Type)

	TYPE_FACTORY (int16, Int16Type)

	TYPE_FACTORY (uint16, UInt16Type)

	TYPE_FACTORY (int32, Int32Type)

	TYPE_FACTORY (uint32, UInt32Type)

	TYPE_FACTORY (int64, Int64Type)

	TYPE_FACTORY (uint64, UInt64Type)

	TYPE_FACTORY (float16, HalfFloatType)

	TYPE_FACTORY (float32, FloatType)

	TYPE_FACTORY (float64, DoubleType)

	TYPE_FACTORY (utf8, StringType)

	TYPE_FACTORY (binary, BinaryType)

	TYPE_FACTORY (date64, Date64Type)

	TYPE_FACTORY (date32, Date32Type)

std::shared_ptr< DataType >	fixed_size_binary (int32_t byte_width)

std::shared_ptr< DataType >	timestamp (TimeUnit::type unit)

std::shared_ptr< DataType >	timestamp (TimeUnit::type unit, const std::string &timezone)

std::shared_ptr< DataType >	time32 (TimeUnit::type unit)
	Unit can be either SECOND or MILLI. More...

std::shared_ptr< DataType >	time64 (TimeUnit::type unit)
	Unit can be either MICRO or NANO. More...

std::shared_ptr< DataType >	list (const std::shared_ptr< DataType > &value_type)

std::shared_ptr< DataType >	list (const std::shared_ptr< Field > &value_field)

std::shared_ptr< DataType >	struct_ (const std::vector< std::shared_ptr< Field >> &fields)

std::shared_ptr< DataType >	union_ (const std::vector< std::shared_ptr< Field >> &child_fields, const std::vector< uint8_t > &type_codes, UnionMode mode)

std::shared_ptr< DataType >	dictionary (const std::shared_ptr< DataType > &index_type, const std::shared_ptr< Array > &dict_values)

std::shared_ptr< Field >	field (const std::string &name, const std::shared_ptr< DataType > &type, bool nullable, const std::shared_ptr< const KeyValueMetadata > &metadata)

std::shared_ptr< DataType >	decimal (int precision, int scale)

	_NUMERIC_TYPE_DECL (Int8)

	_NUMERIC_TYPE_DECL (Int16)

	_NUMERIC_TYPE_DECL (Int32)

	_NUMERIC_TYPE_DECL (Int64)

	_NUMERIC_TYPE_DECL (UInt8)

	_NUMERIC_TYPE_DECL (UInt16)

	_NUMERIC_TYPE_DECL (UInt32)

	_NUMERIC_TYPE_DECL (UInt64)

	_NUMERIC_TYPE_DECL (HalfFloat)

	_NUMERIC_TYPE_DECL (Float)

	_NUMERIC_TYPE_DECL (Double)

std::shared_ptr< DataType > ARROW_EXPORT	null ()

std::shared_ptr< DataType > ARROW_EXPORT	boolean ()

std::shared_ptr< DataType > ARROW_EXPORT	int8 ()

std::shared_ptr< DataType > ARROW_EXPORT	int16 ()

std::shared_ptr< DataType > ARROW_EXPORT	int32 ()

std::shared_ptr< DataType > ARROW_EXPORT	int64 ()

std::shared_ptr< DataType > ARROW_EXPORT	uint8 ()

std::shared_ptr< DataType > ARROW_EXPORT	uint16 ()

std::shared_ptr< DataType > ARROW_EXPORT	uint32 ()

std::shared_ptr< DataType > ARROW_EXPORT	uint64 ()

std::shared_ptr< DataType > ARROW_EXPORT	float16 ()

std::shared_ptr< DataType > ARROW_EXPORT	float32 ()

std::shared_ptr< DataType > ARROW_EXPORT	float64 ()

std::shared_ptr< DataType > ARROW_EXPORT	utf8 ()

std::shared_ptr< DataType > ARROW_EXPORT	binary ()

std::shared_ptr< DataType > ARROW_EXPORT	date32 ()

std::shared_ptr< DataType > ARROW_EXPORT	date64 ()

std::shared_ptr< DataType > ARROW_EXPORT	decimal_type (int precision, int scale)

	GET_ATTR (c_type, void)

	GET_ATTR (TypeClass, void)

int64_t	CountSetBits (const uint8_t *data, int64_t bit_offset, int64_t length)
	Compute the number of 1's in the given data array. More...

Status	GetEmptyBitmap (MemoryPool pool, int64_t length, std::shared_ptr< MutableBuffer > result)

Status	CopyBitmap (MemoryPool pool, const uint8_t bitmap, int64_t offset, int64_t length, std::shared_ptr< Buffer > *out)
	Copy a bit range of an existing bitmap. More...

bool	BitmapEquals (const uint8_t left, int64_t left_offset, const uint8_t right, int64_t right_offset, int64_t bit_length)

uint8_t *	pointer_logical_and (const uint8_t *address, uintptr_t bits)

void	parallel_memcopy (uint8_t dst, const uint8_t src, int64_t nbytes, uintptr_t block_size, int num_threads)

uint32_t	random_seed ()

template<typename T >
std::vector< T >	DeleteVectorElement (const std::vector< T > &values, size_t index)

template<typename T >
std::vector< T >	AddVectorElement (const std::vector< T > &values, size_t index, const T &new_element)

	ARRAY_VISITOR_DEFAULT (NullArray)

	ARRAY_VISITOR_DEFAULT (BooleanArray)

	ARRAY_VISITOR_DEFAULT (Int8Array)

	ARRAY_VISITOR_DEFAULT (Int16Array)

	ARRAY_VISITOR_DEFAULT (Int32Array)

	ARRAY_VISITOR_DEFAULT (Int64Array)

	ARRAY_VISITOR_DEFAULT (UInt8Array)

	ARRAY_VISITOR_DEFAULT (UInt16Array)

	ARRAY_VISITOR_DEFAULT (UInt32Array)

	ARRAY_VISITOR_DEFAULT (UInt64Array)

	ARRAY_VISITOR_DEFAULT (HalfFloatArray)

	ARRAY_VISITOR_DEFAULT (FloatArray)

	ARRAY_VISITOR_DEFAULT (DoubleArray)

	ARRAY_VISITOR_DEFAULT (BinaryArray)

	ARRAY_VISITOR_DEFAULT (StringArray)

	ARRAY_VISITOR_DEFAULT (FixedSizeBinaryArray)

	ARRAY_VISITOR_DEFAULT (Date32Array)

	ARRAY_VISITOR_DEFAULT (Date64Array)

	ARRAY_VISITOR_DEFAULT (Time32Array)

	ARRAY_VISITOR_DEFAULT (Time64Array)

	ARRAY_VISITOR_DEFAULT (TimestampArray)

	ARRAY_VISITOR_DEFAULT (IntervalArray)

	ARRAY_VISITOR_DEFAULT (ListArray)

	ARRAY_VISITOR_DEFAULT (StructArray)

	ARRAY_VISITOR_DEFAULT (UnionArray)

	ARRAY_VISITOR_DEFAULT (DictionaryArray)

	TYPE_VISITOR_DEFAULT (NullType)

	TYPE_VISITOR_DEFAULT (BooleanType)

	TYPE_VISITOR_DEFAULT (Int8Type)

	TYPE_VISITOR_DEFAULT (Int16Type)

	TYPE_VISITOR_DEFAULT (Int32Type)

	TYPE_VISITOR_DEFAULT (Int64Type)

	TYPE_VISITOR_DEFAULT (UInt8Type)

	TYPE_VISITOR_DEFAULT (UInt16Type)

	TYPE_VISITOR_DEFAULT (UInt32Type)

	TYPE_VISITOR_DEFAULT (UInt64Type)

	TYPE_VISITOR_DEFAULT (HalfFloatType)

	TYPE_VISITOR_DEFAULT (FloatType)

	TYPE_VISITOR_DEFAULT (DoubleType)

	TYPE_VISITOR_DEFAULT (StringType)

	TYPE_VISITOR_DEFAULT (BinaryType)

	TYPE_VISITOR_DEFAULT (FixedSizeBinaryType)

	TYPE_VISITOR_DEFAULT (Date64Type)

	TYPE_VISITOR_DEFAULT (Date32Type)

	TYPE_VISITOR_DEFAULT (Time32Type)

	TYPE_VISITOR_DEFAULT (Time64Type)

	TYPE_VISITOR_DEFAULT (TimestampType)

	TYPE_VISITOR_DEFAULT (IntervalType)

	TYPE_VISITOR_DEFAULT (DecimalType)

	TYPE_VISITOR_DEFAULT (ListType)

	TYPE_VISITOR_DEFAULT (StructType)

	TYPE_VISITOR_DEFAULT (UnionType)

	TYPE_VISITOR_DEFAULT (DictionaryType)

template<typename VISITOR >
Status	VisitTypeInline (const DataType &type, VISITOR *visitor)

template<typename VISITOR >
Status	VisitArrayInline (const Array &array, VISITOR *visitor)

Variables
constexpr int64_t	kUnknownNullCount = -1

template class ARROW_TEMPLATE_EXPORT	NumericArray< UInt8Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< UInt16Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< UInt32Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< UInt64Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< Int8Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< Int16Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< Int32Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< Int64Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< TimestampType >

template class ARROW_TEMPLATE_EXPORT	NumericArray< Date32Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< Date64Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< Time32Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< Time64Type >

template class ARROW_TEMPLATE_EXPORT	NumericArray< HalfFloatType >

template class ARROW_TEMPLATE_EXPORT	NumericArray< FloatType >

template class ARROW_TEMPLATE_EXPORT	NumericArray< DoubleType >

constexpr int	kMaxNestingDepth = 64

constexpr size_t	kAlignment = 64

Detailed Description

Public API for the "Feather" file format, originally created at http://github.com/wesm/feather.

Typedef Documentation

using arrow::ArrayVector = typedef std::vector<std::shared_ptr<Array>>

using arrow::Date32Array = typedef NumericArray<Date32Type>

typedef NumericBuilder< Date32Type > arrow::Date32Builder

using arrow::Date64Array = typedef NumericArray<Date64Type>

typedef NumericBuilder< Date64Type > arrow::Date64Builder

using arrow::DoubleBuilder = typedef NumericBuilder<DoubleType>

typedef std::shared_ptr<Field> arrow::FieldPtr

using arrow::FloatBuilder = typedef NumericBuilder<FloatType>

using arrow::HalfFloatBuilder = typedef NumericBuilder<HalfFloatType>

using arrow::Int16Builder = typedef NumericBuilder<Int16Type>

using arrow::Int32Builder = typedef NumericBuilder<Int32Type>

using arrow::Int64Builder = typedef NumericBuilder<Int64Type>

using arrow::Int8Builder = typedef NumericBuilder<Int8Type>

using arrow::IntervalArray = typedef NumericArray<IntervalType>

using arrow::Time32Array = typedef NumericArray<Time32Type>

typedef NumericBuilder< Time32Type > arrow::Time32Builder

using arrow::Time64Array = typedef NumericArray<Time64Type>

typedef NumericBuilder< Time64Type > arrow::Time64Builder

using arrow::TimestampArray = typedef NumericArray<TimestampType>

typedef NumericBuilder< TimestampType > arrow::TimestampBuilder

typedef std::shared_ptr<DataType> arrow::TypePtr

using arrow::UInt16Builder = typedef NumericBuilder<UInt16Type>

using arrow::UInt32Builder = typedef NumericBuilder<UInt32Type>

using arrow::UInt64Builder = typedef NumericBuilder<UInt64Type>

using arrow::UInt8Builder = typedef NumericBuilder<UInt8Type>

Enumeration Type Documentation

enum arrow::BufferType : char

strong

Enumerator
DATA
OFFSET
TYPE
VALIDITY

enum arrow::DateUnit : char

strong

Enumerator
DAY
MILLI

enum arrow::StatusCode : char

strong

Enumerator
OK
OutOfMemory
KeyError
TypeError
Invalid
IOError
UnknownError
NotImplemented
PlasmaObjectExists
PlasmaObjectNonexistent
PlasmaStoreFull

enum arrow::UnionMode : char

strong

Enumerator
SPARSE
DENSE

Function Documentation

arrow::_NUMERIC_TYPE_DECL ( Int8 )

arrow::_NUMERIC_TYPE_DECL ( Int16 )

arrow::_NUMERIC_TYPE_DECL ( Int32 )

arrow::_NUMERIC_TYPE_DECL ( Int64 )

arrow::_NUMERIC_TYPE_DECL ( UInt8 )

arrow::_NUMERIC_TYPE_DECL ( UInt16 )

arrow::_NUMERIC_TYPE_DECL ( UInt32 )

arrow::_NUMERIC_TYPE_DECL ( UInt64 )

arrow::_NUMERIC_TYPE_DECL ( HalfFloat )

arrow::_NUMERIC_TYPE_DECL ( Float )

arrow::_NUMERIC_TYPE_DECL ( Double )

arrow::ACCEPT_VISITOR ( NullType )

arrow::ACCEPT_VISITOR ( BooleanType )

arrow::ACCEPT_VISITOR ( BinaryType )

arrow::ACCEPT_VISITOR ( FixedSizeBinaryType )

arrow::ACCEPT_VISITOR ( StringType )

arrow::ACCEPT_VISITOR ( ListType )

arrow::ACCEPT_VISITOR ( StructType )

arrow::ACCEPT_VISITOR ( DecimalType )

arrow::ACCEPT_VISITOR ( UnionType )

arrow::ACCEPT_VISITOR ( Date32Type )

arrow::ACCEPT_VISITOR ( Date64Type )

arrow::ACCEPT_VISITOR ( Time32Type )

arrow::ACCEPT_VISITOR ( Time64Type )

arrow::ACCEPT_VISITOR ( TimestampType )

arrow::ACCEPT_VISITOR ( IntervalType )

arrow::ACCEPT_VISITOR ( DictionaryType )

template<typename T >

std::vector<T> arrow::AddVectorElement	(	const std::vector< T > &	values,
		size_t	index,
		const T &	new_element
	)

inline

Status ARROW_EXPORT arrow::AllocateBuffer	(	MemoryPool *	pool,
		int64_t	size,
		std::shared_ptr< MutableBuffer > *	out
	)

Allocate a new mutable buffer from a memory pool.

Parameters

[in]	pool	a memory pool
[in]	size	size of buffer to allocate
[out]	out	the allocated buffer with padding

Returns: Status message

Status ARROW_EXPORT arrow::AllocateResizableBuffer	(	MemoryPool *	pool,
		int64_t	size,
		std::shared_ptr< ResizableBuffer > *	out
	)

arrow::ARRAY_VISITOR_DEFAULT ( NullArray )

arrow::ARRAY_VISITOR_DEFAULT ( BooleanArray )

arrow::ARRAY_VISITOR_DEFAULT ( Int8Array )

arrow::ARRAY_VISITOR_DEFAULT ( Int16Array )

arrow::ARRAY_VISITOR_DEFAULT ( Int32Array )

arrow::ARRAY_VISITOR_DEFAULT ( Int64Array )

arrow::ARRAY_VISITOR_DEFAULT ( UInt8Array )

arrow::ARRAY_VISITOR_DEFAULT ( UInt16Array )

arrow::ARRAY_VISITOR_DEFAULT ( UInt32Array )

arrow::ARRAY_VISITOR_DEFAULT ( UInt64Array )

arrow::ARRAY_VISITOR_DEFAULT ( HalfFloatArray )

arrow::ARRAY_VISITOR_DEFAULT ( FloatArray )

arrow::ARRAY_VISITOR_DEFAULT ( DoubleArray )

arrow::ARRAY_VISITOR_DEFAULT ( BinaryArray )

arrow::ARRAY_VISITOR_DEFAULT ( StringArray )

arrow::ARRAY_VISITOR_DEFAULT ( FixedSizeBinaryArray )

arrow::ARRAY_VISITOR_DEFAULT ( Date32Array )

arrow::ARRAY_VISITOR_DEFAULT ( Date64Array )

arrow::ARRAY_VISITOR_DEFAULT ( Time32Array )

arrow::ARRAY_VISITOR_DEFAULT ( Time64Array )

arrow::ARRAY_VISITOR_DEFAULT ( TimestampArray )

arrow::ARRAY_VISITOR_DEFAULT ( IntervalArray )

arrow::ARRAY_VISITOR_DEFAULT ( ListArray )

arrow::ARRAY_VISITOR_DEFAULT ( StructArray )

arrow::ARRAY_VISITOR_DEFAULT ( UnionArray )

arrow::ARRAY_VISITOR_DEFAULT ( DictionaryArray )

Status ARROW_EXPORT arrow::ArrayApproxEquals	(	const Array &	left,
		const Array &	right,
		bool *	are_equal
	)

Returns true if the arrays are approximately equal.

For non-floating point types, this is equivalent to ArrayEquals(left, right)

Status ARROW_EXPORT arrow::ArrayEquals	(	const Array &	left,
		const Array &	right,
		bool *	are_equal
	)

Returns true if the arrays are exactly equal.

template<typename VISITOR >

Status arrow::ArrayEqualsImpl	(	const Array &	left,
		const Array &	right,
		bool *	are_equal
	)

inline

template<typename TYPE , typename C_TYPE >

void arrow::ArrayFromVector	(	const std::shared_ptr< DataType > &	type,
		const std::vector< bool > &	is_valid,
		const std::vector< C_TYPE > &	values,
		std::shared_ptr< Array > *	out
	)

template<typename TYPE , typename C_TYPE >

void arrow::ArrayFromVector	(	const std::vector< bool > &	is_valid,
		const std::vector< C_TYPE > &	values,
		std::shared_ptr< Array > *	out
	)

template<typename TYPE , typename C_TYPE >

void arrow::ArrayFromVector	(	const std::vector< C_TYPE > &	values,
		std::shared_ptr< Array > *	out
	)

Status ARROW_EXPORT arrow::ArrayRangeEquals	(	const Array &	left,
		const Array &	right,
		int64_t	left_start_idx,
		int64_t	left_end_idx,
		int64_t	right_start_idx,
		bool *	are_equal
	)

Returns true if indicated equal-length segment of arrays is exactly equal.

void arrow::AssertBatchValid ( const RecordBatch & batch )

std::shared_ptr<DataType> ARROW_EXPORT arrow::binary ( )

bool ARROW_EXPORT arrow::BitmapEquals	(	const uint8_t *	left,
		int64_t	left_offset,
		const uint8_t *	right,
		int64_t	right_offset,
		int64_t	bit_length
	)

std::shared_ptr<DataType> ARROW_EXPORT arrow::boolean ( )

Status ARROW_EXPORT arrow::ConcatenateTables	(	const std::vector< std::shared_ptr< Table >> &	tables,
		std::shared_ptr< Table > *	table
	)

Status ARROW_EXPORT arrow::CopyBitmap	(	MemoryPool *	pool,
		const uint8_t *	bitmap,
		int64_t	offset,
		int64_t	length,
		std::shared_ptr< Buffer > *	out
	)

Copy a bit range of an existing bitmap.

Parameters

[in]	pool	memory pool to allocate memory from
[in]	bitmap	source data
[in]	offset	bit offset into the source data
[in]	length	number of bits to copy
[out]	out	the resulting copy

Returns: Status message

int64_t ARROW_EXPORT arrow::CountSetBits	(	const uint8_t *	data,
		int64_t	bit_offset,
		int64_t	length
	)

Compute the number of 1's in the given data array.

Parameters

[in]	data	a packed LSB-ordered bitmap as a byte array
[in]	bit_offset	a bitwise offset into the bitmap
[in]	length	the number of bits to inspect in the bitmap relative to the offset

Returns: The number of set (1) bits in the range

std::shared_ptr<DataType> ARROW_EXPORT arrow::date32 ( )

std::shared_ptr<DataType> ARROW_EXPORT arrow::date64 ( )

std::shared_ptr<DataType> arrow::decimal	(	int	precision,
		int	scale
	)

std::shared_ptr<DataType> ARROW_EXPORT arrow::decimal_type	(	int	precision,
		int	scale
	)

ARROW_EXPORT MemoryPool * arrow::default_memory_pool ( )

template<typename T >

std::vector<T> arrow::DeleteVectorElement	(	const std::vector< T > &	values,
		size_t	index
	)

inline

std::shared_ptr< DataType > ARROW_EXPORT arrow::dictionary	(	const std::shared_ptr< DataType > &	index_type,
		const std::shared_ptr< Array > &	dict_values
	)

uint8_t arrow::expanded_int_size	(	int64_t	val,
		uint8_t	current_int_size
	)

inline

uint8_t arrow::expanded_uint_size	(	uint64_t	val,
		uint8_t	current_int_size
	)

inline

std::shared_ptr< Field > ARROW_EXPORT arrow::field	(	const std::string &	name,
		const std::shared_ptr< DataType > &	type,
		bool	nullable,
		const std::shared_ptr< const KeyValueMetadata > &	metadata
	)

std::shared_ptr< DataType > ARROW_EXPORT arrow::fixed_size_binary ( int32_t byte_width )

std::shared_ptr<DataType> ARROW_EXPORT arrow::float16 ( )

std::shared_ptr<DataType> ARROW_EXPORT arrow::float32 ( )

std::shared_ptr<DataType> ARROW_EXPORT arrow::float64 ( )

template<typename TYPE >

bool arrow::FloatingApproxEquals	(	const NumericArray< TYPE > &	left,
		const NumericArray< TYPE > &	right
	)

inline

arrow::GET_ATTR	(	c_type	,
		void
	)

arrow::GET_ATTR	(	TypeClass	,
		void
	)

Status ARROW_EXPORT arrow::GetEmptyBitmap	(	MemoryPool *	pool,
		int64_t	length,
		std::shared_ptr< MutableBuffer > *	result
	)

std::shared_ptr<DataType> ARROW_EXPORT arrow::int16 ( )

std::shared_ptr<DataType> ARROW_EXPORT arrow::int32 ( )

std::shared_ptr<DataType> ARROW_EXPORT arrow::int64 ( )

std::shared_ptr<DataType> ARROW_EXPORT arrow::int8 ( )

std::shared_ptr< DataType > ARROW_EXPORT arrow::list ( const std::shared_ptr< DataType > & value_type )

std::shared_ptr< DataType > ARROW_EXPORT arrow::list ( const std::shared_ptr< Field > & value_field )

Status ARROW_EXPORT arrow::LoadArray	(	const std::shared_ptr< DataType > &	type,
		ArrayComponentSource *	source,
		std::shared_ptr< Array > *	out
	)

Construct an Array container from type metadata and a collection of memory buffers.

Parameters

[in]	field	the data type of the array being loaded
[in]	source	an implementation of ArrayComponentSource
[out]	out	the constructed array

Returns: Status indicating success or failure

Status ARROW_EXPORT arrow::LoadArray	(	const std::shared_ptr< DataType > &	type,
		ArrayLoaderContext *	context,
		std::shared_ptr< Array > *	out
	)

Status ARROW_EXPORT arrow::LoadArray	(	const std::shared_ptr< DataType > &	type,
		const std::vector< FieldMetadata > &	fields,
		const std::vector< std::shared_ptr< Buffer >> &	buffers,
		std::shared_ptr< Array > *	out
	)

template<class T , class Builder >

Status arrow::MakeArray	(	const std::vector< uint8_t > &	valid_bytes,
		const std::vector< T > &	values,
		int64_t	size,
		Builder *	builder,
		std::shared_ptr< Array > *	out
	)

Status ARROW_EXPORT arrow::MakeBuilder	(	MemoryPool *	pool,
		const std::shared_ptr< DataType > &	type,
		std::shared_ptr< ArrayBuilder > *	out
	)

Status ARROW_EXPORT arrow::MakePrimitiveArray	(	const std::shared_ptr< DataType > &	type,
		int64_t	length,
		const std::shared_ptr< Buffer > &	data,
		const std::shared_ptr< Buffer > &	null_bitmap,
		int64_t	null_count,
		int64_t	offset,
		std::shared_ptr< Array > *	out
	)

Create new arrays for logical types that are backed by primitive arrays.

Status ARROW_EXPORT arrow::MakePrimitiveArray	(	const std::shared_ptr< DataType > &	type,
		const std::vector< std::shared_ptr< Buffer >> &	buffers,
		int64_t	length,
		int64_t	null_count,
		int64_t	offset,
		std::shared_ptr< Array > *	out
	)

Status ARROW_EXPORT arrow::MakeTable	(	const std::shared_ptr< Schema > &	schema,
		const std::vector< std::shared_ptr< Array >> &	arrays,
		std::shared_ptr< Table > *	table
	)

std::shared_ptr<DataType> ARROW_EXPORT arrow::null ( )

template<class T1 , class T2 >

bool arrow::operator!=	(	const stl_allocator< T1 > &	lhs,
		const stl_allocator< T2 > &	rhs
	)

noexcept

template<class T1 , class T2 >

bool arrow::operator==	(	const stl_allocator< T1 > &	lhs,
		const stl_allocator< T2 > &	rhs
	)

noexcept

void arrow::parallel_memcopy	(	uint8_t *	dst,
		const uint8_t *	src,
		int64_t	nbytes,
		uintptr_t	block_size,
		int	num_threads
	)

uint8_t* arrow::pointer_logical_and	(	const uint8_t *	address,
		uintptr_t	bits
	)

Status ARROW_EXPORT arrow::PrettyPrint	(	const Array &	arr,
		int	indent,
		std::ostream *	sink
	)

Status ARROW_EXPORT arrow::PrettyPrint	(	const RecordBatch &	batch,
		int	indent,
		std::ostream *	sink
	)

uint32_t arrow::random_seed ( )

std::shared_ptr< Buffer > ARROW_EXPORT arrow::SliceMutableBuffer	(	const std::shared_ptr< Buffer > &	buffer,
		int64_t	offset,
		int64_t	length
	)

Construct a mutable buffer slice.

If the parent buffer is not mutable, this will abort in debug builds

std::shared_ptr< DataType > ARROW_EXPORT arrow::struct_ ( const std::vector< std::shared_ptr< Field >> & fields )

Status ARROW_EXPORT arrow::TensorEquals	(	const Tensor &	left,
		const Tensor &	right,
		bool *	are_equal
	)

std::shared_ptr< DataType > ARROW_EXPORT arrow::time32 ( TimeUnit::type unit )

Unit can be either SECOND or MILLI.

std::shared_ptr< DataType > ARROW_EXPORT arrow::time64 ( TimeUnit::type unit )

Unit can be either MICRO or NANO.

std::shared_ptr< DataType > ARROW_EXPORT arrow::timestamp ( TimeUnit::type unit )

std::shared_ptr< DataType > ARROW_EXPORT arrow::timestamp	(	TimeUnit::type	unit,
		const std::string &	timezone
	)

arrow::TYPE_FACTORY	(	null	,
		NullType
	)

arrow::TYPE_FACTORY	(	boolean	,
		BooleanType
	)

arrow::TYPE_FACTORY	(	int8	,
		Int8Type
	)

arrow::TYPE_FACTORY	(	uint8	,
		UInt8Type
	)

arrow::TYPE_FACTORY	(	int16	,
		Int16Type
	)

arrow::TYPE_FACTORY	(	uint16	,
		UInt16Type
	)

arrow::TYPE_FACTORY	(	int32	,
		Int32Type
	)

arrow::TYPE_FACTORY	(	uint32	,
		UInt32Type
	)

arrow::TYPE_FACTORY	(	int64	,
		Int64Type
	)

arrow::TYPE_FACTORY	(	uint64	,
		UInt64Type
	)

arrow::TYPE_FACTORY	(	float16	,
		HalfFloatType
	)

arrow::TYPE_FACTORY	(	float32	,
		FloatType
	)

arrow::TYPE_FACTORY	(	float64	,
		DoubleType
	)

arrow::TYPE_FACTORY	(	utf8	,
		StringType
	)

arrow::TYPE_FACTORY	(	binary	,
		BinaryType
	)

arrow::TYPE_FACTORY	(	date64	,
		Date64Type
	)

arrow::TYPE_FACTORY	(	date32	,
		Date32Type
	)

arrow::TYPE_VISITOR_DEFAULT ( NullType )

arrow::TYPE_VISITOR_DEFAULT ( BooleanType )

arrow::TYPE_VISITOR_DEFAULT ( Int8Type )

arrow::TYPE_VISITOR_DEFAULT ( Int16Type )

arrow::TYPE_VISITOR_DEFAULT ( Int32Type )

arrow::TYPE_VISITOR_DEFAULT ( Int64Type )

arrow::TYPE_VISITOR_DEFAULT ( UInt8Type )

arrow::TYPE_VISITOR_DEFAULT ( UInt16Type )

arrow::TYPE_VISITOR_DEFAULT ( UInt32Type )

arrow::TYPE_VISITOR_DEFAULT ( UInt64Type )

arrow::TYPE_VISITOR_DEFAULT ( HalfFloatType )

arrow::TYPE_VISITOR_DEFAULT ( FloatType )

arrow::TYPE_VISITOR_DEFAULT ( DoubleType )

arrow::TYPE_VISITOR_DEFAULT ( StringType )

arrow::TYPE_VISITOR_DEFAULT ( BinaryType )

arrow::TYPE_VISITOR_DEFAULT ( FixedSizeBinaryType )

arrow::TYPE_VISITOR_DEFAULT ( Date64Type )

arrow::TYPE_VISITOR_DEFAULT ( Date32Type )

arrow::TYPE_VISITOR_DEFAULT ( Time32Type )

arrow::TYPE_VISITOR_DEFAULT ( Time64Type )

arrow::TYPE_VISITOR_DEFAULT ( TimestampType )

arrow::TYPE_VISITOR_DEFAULT ( IntervalType )

arrow::TYPE_VISITOR_DEFAULT ( DecimalType )

arrow::TYPE_VISITOR_DEFAULT ( ListType )

arrow::TYPE_VISITOR_DEFAULT ( StructType )

arrow::TYPE_VISITOR_DEFAULT ( UnionType )

arrow::TYPE_VISITOR_DEFAULT ( DictionaryType )

Status ARROW_EXPORT arrow::TypeEquals	(	const DataType &	left,
		const DataType &	right,
		bool *	are_equal
	)

Returns true if the type metadata are exactly equal.

std::shared_ptr<DataType> ARROW_EXPORT arrow::uint16 ( )

std::shared_ptr<DataType> ARROW_EXPORT arrow::uint32 ( )

std::shared_ptr<DataType> ARROW_EXPORT arrow::uint64 ( )

std::shared_ptr<DataType> ARROW_EXPORT arrow::uint8 ( )

std::shared_ptr< DataType > ARROW_EXPORT arrow::union_	(	const std::vector< std::shared_ptr< Field >> &	child_fields,
		const std::vector< uint8_t > &	type_codes,
		UnionMode	mode
	)