pyarrow.DictionaryType¶
-
class
pyarrow.DictionaryType¶ Bases:
pyarrow.lib.DataTypeConcrete class for dictionary data types.
-
__init__(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__(*args, **kwargs)Initialize self.
equals(self, other)Return true if type is equivalent to passed value.
to_pandas_dtype(self)Return the equivalent NumPy / Pandas dtype.
Attributes
The data type of dictionary indices (a signed integer type).
Number of data buffers required to construct Array type excluding children.
The number of child fields.
The number of child fields.
Whether the dictionary is ordered, i.e. whether the ordering of values in the dictionary is important.
The dictionary value type.
-
bit_width¶
-
equals(self, other)¶ Return true if type is equivalent to passed value.
- Parameters
other (DataType or string convertible to DataType) –
- Returns
is_equal (bool)
-
id¶
-
index_type¶ The data type of dictionary indices (a signed integer type).
-
num_buffers¶ Number of data buffers required to construct Array type excluding children.
-
num_children¶ The number of child fields.
-
num_fields¶ The number of child fields.
-
ordered¶ Whether the dictionary is ordered, i.e. whether the ordering of values in the dictionary is important.
-
to_pandas_dtype(self)¶ Return the equivalent NumPy / Pandas dtype.
-
value_type¶ The dictionary value type.
The dictionary values are found in an instance of DictionaryArray.
-