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

Concrete type class for dictionary data. More...

#include <arrow/type.h>

Inheritance diagram for arrow::DictionaryType:
arrow::FixedWidthType arrow::DataType

Public Member Functions

 DictionaryType (const std::shared_ptr< DataType > &index_type, const std::shared_ptr< Array > &dictionary, bool ordered=false)
int bit_width () const override
std::shared_ptr< DataTypeindex_type () const
std::shared_ptr< Arraydictionary () const
Status Accept (TypeVisitor *visitor) const override
std::string ToString () const override
 A string representation of the type, including any children. More...
std::string name () const override
 A string name of the type, omitting any child fields. More...
bool ordered () const
- Public Member Functions inherited from arrow::FixedWidthType
 DataType (Type::type id)
- Public Member Functions inherited from arrow::DataType
 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< Fieldchild (int i) const
const std::vector< std::shared_ptr< Field > > & children () const
int num_children () const
Type::type id () const

Static Public Attributes

static constexpr Type::type type_id = Type::DICTIONARY

Additional Inherited Members

- Protected Attributes inherited from arrow::DataType
Type::type id_
std::vector< std::shared_ptr< Field > > children_

Detailed Description

Concrete type class for dictionary data.

Constructor & Destructor Documentation

◆ DictionaryType()

arrow::DictionaryType::DictionaryType ( const std::shared_ptr< DataType > &  index_type,
const std::shared_ptr< Array > &  dictionary,
bool  ordered = false 

Member Function Documentation

◆ Accept()

Status arrow::DictionaryType::Accept ( TypeVisitor visitor) const

Implements arrow::DataType.

◆ bit_width()

int arrow::DictionaryType::bit_width ( ) const

Implements arrow::FixedWidthType.

◆ dictionary()

std::shared_ptr<Array> arrow::DictionaryType::dictionary ( ) const

◆ index_type()

std::shared_ptr<DataType> arrow::DictionaryType::index_type ( ) const

◆ name()

std::string arrow::DictionaryType::name ( ) const

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

Experimental API

Implements arrow::DataType.

◆ ordered()

bool arrow::DictionaryType::ordered ( ) const

◆ ToString()

std::string arrow::DictionaryType::ToString ( ) const

A string representation of the type, including any children.

Implements arrow::DataType.

Member Data Documentation

◆ type_id

constexpr Type::type arrow::DictionaryType::type_id = Type::DICTIONARY

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