org.bytedeco.arrow

Class DictionaryArray

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Array

org.bytedeco.arrow.DictionaryArray

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class DictionaryArray
extends Array

\brief Array type for dictionary-encoded data with a data-dependent dictionary A dictionary array contains an array of non-negative integers (the "dictionary indices") along with a data type containing a "dictionary" corresponding to the distinct values represented in the data. For example, the array ["foo", "bar", "foo", "bar", "foo", "bar"] with dictionary ["bar", "foo"], would have dictionary array representation indices: [1, 0, 1, 0, 1, 0] dictionary: ["bar", "foo"] The indices in principle may be any integer type.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
DictionaryArray(ArrayData data)
DictionaryArray(DataType type, Array indices, Array dictionary)
DictionaryArray(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	CanCompareIndices(DictionaryArray other) \brief Determine whether dictionary arrays may be compared without unification
DictionaryType	dict_type()
Array	dictionary() \brief Return the dictionary for this array, which is stored as a member of the ArrayData internal structure
static ArrayResult	FromArrays(Array indices, Array dictionary)
static ArrayResult	FromArrays(DataType type, Array indices, Array dictionary) \brief Construct DictionaryArray from dictionary and indices array and validate This function does the validation of the indices and input type.
long	GetValueIndex(long i) \brief Return the ith value of indices, cast to int64_t.
Array	indices()
ArrayResult	Transpose(DataType type, Array dictionary, int[] transpose_map)
ArrayResult	Transpose(DataType type, Array dictionary, int[] transpose_map, MemoryPool pool)
ArrayResult	Transpose(DataType type, Array dictionary, IntBuffer transpose_map)
ArrayResult	Transpose(DataType type, Array dictionary, IntBuffer transpose_map, MemoryPool pool)
ArrayResult	Transpose(DataType type, Array dictionary, IntPointer transpose_map)
ArrayResult	Transpose(DataType type, Array dictionary, IntPointer transpose_map, MemoryPool pool) \brief Transpose this DictionaryArray This method constructs a new dictionary array with the given dictionary type, transposing indices using the transpose map.

Methods inherited from class org.bytedeco.arrow.Array

Accept, ApproxEquals, ApproxEquals, data, Diff, Equals, Equals, GetScalar, IsNull, IsValid, length, null_bitmap_data, null_bitmap, null_count, num_fields, offset, RangeEquals, RangeEquals, RangeEquals, RangeEquals, Slice, Slice, SliceSafe, SliceSafe, ToString, type_id, type, Validate, ValidateFull, View

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DictionaryArray

public DictionaryArray(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

DictionaryArray

public DictionaryArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
                       ArrayData data)

DictionaryArray

public DictionaryArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                       DataType type,
                       @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                       Array indices,
                       @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                       Array dictionary)

Method Detail

FromArrays

@ByVal
public static ArrayResult FromArrays(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                            DataType type,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array indices,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array dictionary)

\brief Construct DictionaryArray from dictionary and indices array and validate This function does the validation of the indices and input type. It checks if all indices are non-negative and smaller than the size of the dictionary.

Parameters:

type - [in] a dictionary type

dictionary - [in] the dictionary with same value type as the type object

indices - [in] an array of non-negative integers smaller than the size of the dictionary

FromArrays

@ByVal
public static ArrayResult FromArrays(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array indices,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array dictionary)

Transpose

@ByVal
public ArrayResult Transpose(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                    DataType type,
                                    @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                    Array dictionary,
                                    @Const
                                    IntPointer transpose_map,
                                    MemoryPool pool)

\brief Transpose this DictionaryArray This method constructs a new dictionary array with the given dictionary type, transposing indices using the transpose map. The type and the transpose map are typically computed using DictionaryUnifier.

Parameters:

type - [in] the new type object

dictionary - [in] the new dictionary

transpose_map - [in] transposition array of this array's indices into the target array's indices

pool - [in] a pool to allocate the array data from

Transpose

@ByVal
public ArrayResult Transpose(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                    DataType type,
                                    @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                    Array dictionary,
                                    @Const
                                    IntPointer transpose_map)

Transpose

@ByVal
public ArrayResult Transpose(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                    DataType type,
                                    @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                    Array dictionary,
                                    @Const
                                    IntBuffer transpose_map,
                                    MemoryPool pool)

Transpose

@ByVal
public ArrayResult Transpose(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                    DataType type,
                                    @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                    Array dictionary,
                                    @Const
                                    IntBuffer transpose_map)

Transpose

@ByVal
public ArrayResult Transpose(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                    DataType type,
                                    @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                    Array dictionary,
                                    @Const
                                    int[] transpose_map,
                                    MemoryPool pool)

Transpose

@ByVal
public ArrayResult Transpose(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                    DataType type,
                                    @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                    Array dictionary,
                                    @Const
                                    int[] transpose_map)

CanCompareIndices

@Cast(value="bool")
public boolean CanCompareIndices(@Const @ByRef
                                                     DictionaryArray other)

\brief Determine whether dictionary arrays may be compared without unification

dictionary

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public Array dictionary()

\brief Return the dictionary for this array, which is stored as a member of the ArrayData internal structure

indices

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public Array indices()

GetValueIndex

@Cast(value="int64_t")
public long GetValueIndex(@Cast(value="int64_t")
                                                 long i)

\brief Return the ith value of indices, cast to int64_t. Not recommended for use in performance-sensitive code. Does not validate whether the value is null or out-of-bounds.

dict_type

@Const
public DictionaryType dict_type()