org.bytedeco.arrow

Class DictionaryUnifier

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.DictionaryUnifier

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @Properties(inherit=arrow.class)
public class DictionaryUnifier
extends Pointer

\brief Helper class for incremental dictionary unification

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
DictionaryUnifier(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	GetResult(DataType out_type, Array out_dict) \brief Return a result DictionaryType with the smallest possible index type to accommodate the unified dictionary.
Status	GetResultWithIndexType(DataType index_type, Array out_dict) \brief Return a unified dictionary with the given index type.
static DictionaryUnifierResult	Make(DataType value_type)
static DictionaryUnifierResult	Make(DataType value_type, MemoryPool pool) \brief Construct a DictionaryUnifier
Status	Unify(Array dictionary) \brief Append dictionary to the internal memo
Status	Unify(Array dictionary, ArrowBuffer out_transpose) \brief Append dictionary and compute transpose indices
static ChunkedArrayResult	UnifyChunkedArray(ChunkedArray array)
static ChunkedArrayResult	UnifyChunkedArray(ChunkedArray array, MemoryPool pool) \brief Unify dictionaries accross array chunks The dictionaries in the array chunks will be unified, their indices accordingly transposed.
static TableResult	UnifyTable(Table table)
static TableResult	UnifyTable(Table table, MemoryPool pool) \brief Unify dictionaries accross the chunks of each table column The dictionaries in each table column will be unified, their indices accordingly transposed.

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, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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

DictionaryUnifier

public DictionaryUnifier(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Make

@ByVal
public static DictionaryUnifierResult Make(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                   DataType value_type,
                                                   MemoryPool pool)

\brief Construct a DictionaryUnifier

Parameters:

value_type - [in] the data type of the dictionaries

pool - [in] MemoryPool to use for memory allocations

Make

@ByVal
public static DictionaryUnifierResult Make(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                   DataType value_type)

UnifyChunkedArray

@ByVal
public static ChunkedArrayResult UnifyChunkedArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::ChunkedArray>"})
                                                           ChunkedArray array,
                                                           MemoryPool pool)

\brief Unify dictionaries accross array chunks The dictionaries in the array chunks will be unified, their indices accordingly transposed. Only dictionaries with a primitive value type are currently supported. However, dictionaries nested inside a more complex type are correctly unified.

UnifyChunkedArray

@ByVal
public static ChunkedArrayResult UnifyChunkedArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::ChunkedArray>"})
                                                           ChunkedArray array)

UnifyTable

@ByVal
public static TableResult UnifyTable(@Const @ByRef
                                             Table table,
                                             MemoryPool pool)

\brief Unify dictionaries accross the chunks of each table column The dictionaries in each table column will be unified, their indices accordingly transposed. Only dictionaries with a primitive value type are currently supported. However, dictionaries nested inside a more complex type are correctly unified.

UnifyTable

@ByVal
public static TableResult UnifyTable(@Const @ByRef
                                             Table table)

Unify

@ByVal
public Status Unify(@Const @ByRef
                            Array dictionary)

\brief Append dictionary to the internal memo

Unify

@ByVal
public Status Unify(@Const @ByRef
                            Array dictionary,
                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Buffer>*"})
                            ArrowBuffer out_transpose)

\brief Append dictionary and compute transpose indices

Parameters:

dictionary - [in] the dictionary values to unify

out_transpose - [out] a Buffer containing computed transpose indices as int32_t values equal in length to the passed dictionary. The value in each slot corresponds to the new index value for each original index for a DictionaryArray with the old dictionary

GetResult

@ByVal
public Status GetResult(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>*"})
                                DataType out_type,
                                @SharedPtr
                                Array out_dict)

\brief Return a result DictionaryType with the smallest possible index type to accommodate the unified dictionary. The unifier cannot be used after this is called

GetResultWithIndexType

@ByVal
public Status GetResultWithIndexType(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                             DataType index_type,
                                             @SharedPtr
                                             Array out_dict)

\brief Return a unified dictionary with the given index type. If the index type is not large enough then an invalid status will be returned. The unifier cannot be used after this is called