org.bytedeco.arrow

Class Array

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Array

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BaseLargeListArray, BaseListArray, DictionaryArray, ExtensionArray, FixedSizeListArray, FlatArray, StructArray, UnionArray

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

\brief Array base type Immutable data array with some logical type and some length. Any memory is owned by the respective Buffer instance (or its parents). The base class is only required to have a null bitmap buffer if the null count is greater than 0 If known, the null count can be provided in the base Array constructor. If the null count is not known, pass -1 to indicate that the null count is to be computed on the first call to null_count()

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

Method Summary

Modifier and Type	Method and Description
Status	Accept(ArrayVisitor visitor)
boolean	ApproxEquals(Array arr)
boolean	ApproxEquals(Array arr, EqualOptions arg1) Approximate equality comparison with another array epsilon is only used if this is FloatArray or DoubleArray
ArrayData	data()
String	Diff(Array other) \brief Return the formatted unified diff of arrow::Diff between this Array and another Array
boolean	Equals(Array arr)
boolean	Equals(Array arr, EqualOptions arg1) Equality comparison with another array
ScalarResult	GetScalar(long i) \brief Return a Scalar containing the value of this array at i
boolean	IsNull(long i) \brief Return true if value at index is null.
boolean	IsValid(long i) \brief Return true if value at index is valid (not null).
long	length() Size in the number of elements this array contains.
BytePointer	null_bitmap_data() Raw pointer to the null bitmap.
ArrowBuffer	null_bitmap() Buffer for the validity (null) bitmap, if any.
long	null_count() The number of null entries in the array.
int	num_fields()
long	offset() A relative position into another array's data, to enable zero-copy slicing.
boolean	RangeEquals(Array other, long start_idx, long end_idx, long other_start_idx)
boolean	RangeEquals(Array other, long start_idx, long end_idx, long other_start_idx, EqualOptions arg4)
boolean	RangeEquals(long start_idx, long end_idx, long other_start_idx, Array other)
boolean	RangeEquals(long start_idx, long end_idx, long other_start_idx, Array other, EqualOptions arg4) Compare if the range of slots specified are equal for the given array and this array.
Array	Slice(long offset) Slice from offset until end of the array
Array	Slice(long offset, long length) Construct a zero-copy slice of the array with the indicated offset and length
ArrayResult	SliceSafe(long offset) Input-checking variant of Array::Slice
ArrayResult	SliceSafe(long offset, long length) Input-checking variant of Array::Slice
String	ToString()
int	type_id()
DataType	type()
Status	Validate() \brief Perform cheap validation checks to determine obvious inconsistencies within the array's internal data.
Status	ValidateFull() \brief Perform extensive validation checks to determine inconsistencies within the array's internal data.
ArrayResult	View(DataType type) Construct a zero-copy view of this array with the given type.

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

Array

public Array(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

IsNull

@Cast(value="bool")
public boolean IsNull(@Cast(value="int64_t")
                                          long i)

\brief Return true if value at index is null. Does not boundscheck

IsValid

@Cast(value="bool")
public boolean IsValid(@Cast(value="int64_t")
                                           long i)

\brief Return true if value at index is valid (not null). Does not boundscheck

GetScalar

@ByVal
public ScalarResult GetScalar(@Cast(value="int64_t")
                                     long i)

\brief Return a Scalar containing the value of this array at i

length

@Cast(value="int64_t")
public long length()

Size in the number of elements this array contains.

offset

@Cast(value="int64_t")
public long offset()

A relative position into another array's data, to enable zero-copy slicing. This value defaults to zero

null_count

@Cast(value="int64_t")
public long null_count()

The number of null entries in the array. If the null count was not known at time of construction (and set to a negative value), then the null count will be computed and cached on the first invocation of this function

type

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

type_id

@Cast(value="arrow::Type::type")
public int type_id()

null_bitmap

@SharedPtr
public ArrowBuffer null_bitmap()

Buffer for the validity (null) bitmap, if any. Note that Union types never have a null bitmap. Note that for null_count == 0 or for null type, this will be null. This buffer does not account for any slice offset

null_bitmap_data

@Cast(value="const uint8_t*")
public BytePointer null_bitmap_data()

Raw pointer to the null bitmap. Note that for null_count == 0 or for null type, this will be null. This buffer does not account for any slice offset

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                          Array arr,
                                          @Const @ByRef(nullValue="arrow::EqualOptions::Defaults()")
                                          EqualOptions arg1)

Equality comparison with another array

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                          Array arr)

Diff

@StdString
public String Diff(@Const @ByRef
                              Array other)

\brief Return the formatted unified diff of arrow::Diff between this Array and another Array

ApproxEquals

@Cast(value="bool")
public boolean ApproxEquals(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                                Array arr,
                                                @Const @ByRef(nullValue="arrow::EqualOptions::Defaults()")
                                                EqualOptions arg1)

Approximate equality comparison with another array epsilon is only used if this is FloatArray or DoubleArray

ApproxEquals

@Cast(value="bool")
public boolean ApproxEquals(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                                Array arr)

RangeEquals

@Cast(value="bool")
public boolean RangeEquals(@Cast(value="int64_t")
                                               long start_idx,
                                               @Cast(value="int64_t")
                                               long end_idx,
                                               @Cast(value="int64_t")
                                               long other_start_idx,
                                               @Const @ByRef
                                               Array other,
                                               @Const @ByRef(nullValue="arrow::EqualOptions::Defaults()")
                                               EqualOptions arg4)

Compare if the range of slots specified are equal for the given array and this array. end_idx exclusive. This methods does not bounds check.

RangeEquals

@Cast(value="bool")
public boolean RangeEquals(@Cast(value="int64_t")
                                               long start_idx,
                                               @Cast(value="int64_t")
                                               long end_idx,
                                               @Cast(value="int64_t")
                                               long other_start_idx,
                                               @Const @ByRef
                                               Array other)

RangeEquals

@Cast(value="bool")
public boolean RangeEquals(@Const @ByRef
                                               Array other,
                                               @Cast(value="int64_t")
                                               long start_idx,
                                               @Cast(value="int64_t")
                                               long end_idx,
                                               @Cast(value="int64_t")
                                               long other_start_idx,
                                               @Const @ByRef(nullValue="arrow::EqualOptions::Defaults()")
                                               EqualOptions arg4)

RangeEquals

@Cast(value="bool")
public boolean RangeEquals(@Const @ByRef
                                               Array other,
                                               @Cast(value="int64_t")
                                               long start_idx,
                                               @Cast(value="int64_t")
                                               long end_idx,
                                               @Cast(value="int64_t")
                                               long other_start_idx)

Accept

@ByVal
public Status Accept(ArrayVisitor visitor)

View

@ByVal
public ArrayResult View(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                               DataType type)

Construct a zero-copy view of this array with the given type. This method checks if the types are layout-compatible. Nested types are traversed in depth-first order. Data buffers must have the same item sizes, even though the logical types may be different. An error is returned if the types are not layout-compatible.

Slice

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public Array Slice(@Cast(value="int64_t")
                                                                                 long offset,
                                                                                 @Cast(value="int64_t")
                                                                                 long length)

Construct a zero-copy slice of the array with the indicated offset and length

Parameters:

offset - [in] the position of the first element in the constructed slice

length - [in] the length of the slice. If there are not enough elements in the array, the length will be adjusted accordingly

Returns:

a new object wrapped in std::shared_ptr

Slice

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public Array Slice(@Cast(value="int64_t")
                                                                                 long offset)

Slice from offset until end of the array

SliceSafe

@ByVal
public ArrayResult SliceSafe(@Cast(value="int64_t")
                                    long offset,
                                    @Cast(value="int64_t")
                                    long length)

Input-checking variant of Array::Slice

SliceSafe

@ByVal
public ArrayResult SliceSafe(@Cast(value="int64_t")
                                    long offset)

Input-checking variant of Array::Slice

data

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

num_fields

public int num_fields()

ToString

@StdString
public String ToString()

Returns:

PrettyPrint representation of array suitable for debugging

Validate

@ByVal
public Status Validate()

\brief Perform cheap validation checks to determine obvious inconsistencies within the array's internal data. This is O(k) where k is the number of descendents.

Returns:

Status

ValidateFull

@ByVal
public Status ValidateFull()

\brief Perform extensive validation checks to determine inconsistencies within the array's internal data. This is potentially O(k*n) where k is the number of descendents and n is the array length.

Returns:

Status