Struct ChunkedArray

pub struct ChunkedArray(/* private fields */);

Implementations

impl ChunkedArray

pub fn maybe_from(data: impl AsRef<Array>) -> Option<Self>

Optionally downcast an Array instance to a specific encoding.

Preferred in cases where a backtrace isn’t needed, like when trying multiple encoding to go down different code paths.

impl ChunkedArray

pub fn try_new(chunks: Vec<Array>, dtype: DType) -> VortexResult<Self>

pub fn chunk(&self, idx: usize) -> VortexResult<Array>

pub fn nchunks(&self) -> usize

pub fn chunk_offsets(&self) -> Array

pub fn chunks(&self) -> impl Iterator<Item = Array> + '_

pub fn array_iterator(&self) -> impl ArrayIterator + '_

pub fn array_stream(&self) -> impl ArrayStream + '_

pub fn rechunk( &self, target_bytesize: usize, target_rowsize: usize, ) -> VortexResult<Self>

Methods from Deref<Target = Array>

pub fn vtable(&self) -> &VTableRef

Return the array’s encoding VTable.

pub fn encoding(&self) -> EncodingId

Return the array’s encoding ID.

pub fn len(&self) -> usize

Returns the number of logical elements in the array.

pub fn is_empty(&self) -> bool

Check whether the array has any data

pub fn dtype(&self) -> &DType

Return the array’s dtype

pub fn is_canonical(&self) -> bool

Whether the array is of a canonical encoding.

pub fn is_arrow(&self) -> bool

Whether the array is fully zero-copy to Arrow (including children). This means any nested types, like Structs, Lists, and Extensions are not present.

pub fn is_constant(&self) -> bool

Return whether the array is constant.

pub fn as_constant(&self) -> Option<Scalar>

Return scalar value of this array if the array is constant

pub fn child<'a>( &'a self, idx: usize, dtype: &'a DType, len: usize, ) -> VortexResult<Self>

pub fn children(&self) -> Vec<Array>

Returns a Vec of Arrays with all the array’s child arrays.

pub fn named_children(&self) -> Vec<(String, Array)>

Returns a Vec of Arrays with all the array’s child arrays.

pub fn nchildren(&self) -> usize

Returns the number of child arrays

pub fn depth_first_traversal(&self) -> ArrayChildrenIterator

pub fn cumulative_nbuffers(&self) -> usize

Count the number of cumulative buffers encoded by self.

pub fn all_buffer_offsets(&self, alignment: usize) -> Vec<u64>

Return the buffer offsets and the total length of all buffers, assuming the given alignment. This includes all child buffers.

pub fn metadata_bytes(&self) -> Option<&[u8]>

pub fn nbuffers(&self) -> usize

pub fn byte_buffer(&self, index: usize) -> Option<&ByteBuffer>

pub fn byte_buffers(&self) -> impl Iterator<Item = ByteBuffer> + '_

pub fn is_encoding(&self, id: EncodingId) -> bool

Checks whether array is of a given encoding.

pub fn try_downcast_ref<E: Encoding>(&self) -> VortexResult<(&E::Array, &E)>

where for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

pub fn nbytes(&self) -> usize

Total size of the array in bytes, including all children and buffers.

pub fn statistics(&self) -> &(dyn Statistics + '_)

pub fn inherit_statistics(&self, parent: &dyn Statistics)

pub fn tree_display(&self) -> TreeDisplayWrapper<'_>

pub fn is_valid(&self, index: usize) -> VortexResult<bool>

Return whether the element at the given index is valid (true) or null (false).

pub fn all_valid(&self) -> VortexResult<bool>

Return whether all elements in the array are valid.

pub fn null_count(&self) -> VortexResult<usize>

Return the number of null elements in the array.

pub fn validity_mask(&self) -> VortexResult<Mask>

Return the canonical validity of the array as a Mask.

pub fn as_null_array(&self) -> Option<&dyn NullArrayTrait>

pub fn as_bool_array(&self) -> Option<&dyn BoolArrayTrait>

pub fn as_primitive_array(&self) -> Option<&dyn PrimitiveArrayTrait>

pub fn as_utf8_array(&self) -> Option<&dyn Utf8ArrayTrait>

pub fn as_binary_array(&self) -> Option<&dyn BinaryArrayTrait>

pub fn as_struct_array(&self) -> Option<&dyn StructArrayTrait>

pub fn as_list_array(&self) -> Option<&dyn ListArrayTrait>

pub fn as_extension_array(&self) -> Option<&dyn ExtensionArrayTrait>

Trait Implementations

impl AsRef<Array> for ChunkedArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl BinaryBooleanFn<ChunkedArray> for ChunkedEncoding

fn binary_boolean( &self, lhs: &ChunkedArray, rhs: &Array, op: BinaryOperator, ) -> VortexResult<Option<Array>>

impl BinaryNumericFn<ChunkedArray> for ChunkedEncoding

fn binary_numeric( &self, array: &ChunkedArray, rhs: &Array, op: BinaryNumericOperator, ) -> VortexResult<Option<Array>>

impl CanonicalVTable<ChunkedArray> for ChunkedEncoding

fn into_canonical(&self, array: ChunkedArray) -> VortexResult<Canonical>

impl CastFn<ChunkedArray> for ChunkedEncoding

fn cast(&self, array: &ChunkedArray, dtype: &DType) -> VortexResult<Array>

impl Clone for ChunkedArray

fn clone(&self) -> ChunkedArray

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CompareFn<ChunkedArray> for ChunkedEncoding

fn compare( &self, lhs: &ChunkedArray, rhs: &Array, operator: Operator, ) -> VortexResult<Option<Array>>

Compares two arrays and returns a new boolean array with the result of the comparison. Or, returns None if comparison is not supported for these arrays.

impl Debug for ChunkedArray

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ChunkedArray

type Target = Array

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl ExtensionArrayTrait for ChunkedArray

fn storage_data(&self) -> Array

Returns the underlying Array, without the ExtDType.

fn ext_dtype(&self) -> &Arc<ExtDType>

Returns the extension logical DType.

impl FillNullFn<ChunkedArray> for ChunkedEncoding

fn fill_null( &self, array: &ChunkedArray, fill_value: Scalar, ) -> VortexResult<Array>

impl FilterFn<ChunkedArray> for ChunkedEncoding

fn filter(&self, array: &ChunkedArray, mask: &Mask) -> VortexResult<Array>

Filter an array by the provided predicate.

impl FromIterator<Array> for ChunkedArray

fn from_iter<T: IntoIterator<Item = Array>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoArray for ChunkedArray

fn into_array(self) -> Array

impl InvertFn<ChunkedArray> for ChunkedEncoding

fn invert(&self, array: &ChunkedArray) -> VortexResult<Array>

Logically invert a boolean array. Converts true -> false, false -> true, null -> null.

impl PrimitiveArrayTrait for ChunkedArray

fn ptype(&self) -> PType

The logical primitive type of the array.

impl ScalarAtFn<ChunkedArray> for ChunkedEncoding

fn scalar_at(&self, array: &ChunkedArray, index: usize) -> VortexResult<Scalar>

impl SliceFn<ChunkedArray> for ChunkedEncoding

fn slice( &self, array: &ChunkedArray, start: usize, stop: usize, ) -> VortexResult<Array>

Return a zero-copy slice of an array, between start (inclusive) and end (exclusive). If start >= stop, returns an empty array of the same type as self. Assumes that start or stop are out of bounds, may panic otherwise.

impl StatisticsVTable<ChunkedArray> for ChunkedEncoding

fn compute_statistics( &self, array: &ChunkedArray, stat: Stat, ) -> VortexResult<StatsSet>

Compute the requested statistic. Can return additional stats.

impl StructArrayTrait for ChunkedArray

fn maybe_null_field_by_idx(&self, idx: usize) -> Option<Array>

Return a field’s array by index, ignoring struct nullability

fn project(&self, projection: &[FieldName]) -> VortexResult<Array>

fn names(&self) -> &FieldNames

fn field_info(&self, field: &Field) -> VortexResult<FieldInfo>

fn dtypes(&self) -> Vec<DType>

fn nfields(&self) -> usize

fn maybe_null_field_by_name(&self, name: &str) -> Option<Array>

Return a field’s array by name, ignoring struct nullability

fn maybe_null_field(&self, field: &Field) -> Option<Array>

impl TakeFn<ChunkedArray> for ChunkedEncoding

fn take(&self, array: &ChunkedArray, indices: &Array) -> VortexResult<Array>

Create a new array by taking the values from the array at the given indices.

unsafe fn take_unchecked( &self, array: &A, indices: &Array, ) -> VortexResult<Array>

Create a new array by taking the values from the array at the given indices.

impl<'a> TryFrom<&'a Array> for &'a ChunkedArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a Array) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<Array> for ChunkedArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: Array) -> VortexResult<Self>

Performs the conversion.

impl ValidateVTable<ChunkedArray> for ChunkedEncoding

fn validate(&self, _array: &Array) -> VortexResult<()>

impl ValidityVTable<ChunkedArray> for ChunkedEncoding

fn is_valid(&self, array: &ChunkedArray, index: usize) -> VortexResult<bool>

Returns whether the index item is valid.

fn all_valid(&self, array: &ChunkedArray) -> VortexResult<bool>

Returns whether the array is all valid.

fn validity_mask(&self, array: &ChunkedArray) -> VortexResult<Mask>

fn invalid_count(&self, array: &Array) -> VortexResult<usize>

Returns the number of invalid elements in the array.

impl VariantsVTable<ChunkedArray> for ChunkedEncoding

Chunked arrays support all DTypes

fn as_null_array<'a>( &self, array: &'a ChunkedArray, ) -> Option<&'a dyn NullArrayTrait>

fn as_bool_array<'a>( &self, array: &'a ChunkedArray, ) -> Option<&'a dyn BoolArrayTrait>

fn as_primitive_array<'a>( &self, array: &'a ChunkedArray, ) -> Option<&'a dyn PrimitiveArrayTrait>

fn as_utf8_array<'a>( &self, array: &'a ChunkedArray, ) -> Option<&'a dyn Utf8ArrayTrait>

fn as_binary_array<'a>( &self, array: &'a ChunkedArray, ) -> Option<&'a dyn BinaryArrayTrait>

fn as_struct_array<'a>( &self, array: &'a ChunkedArray, ) -> Option<&'a dyn StructArrayTrait>

fn as_list_array<'a>( &self, array: &'a ChunkedArray, ) -> Option<&'a dyn ListArrayTrait>

fn as_extension_array<'a>( &self, array: &'a ChunkedArray, ) -> Option<&'a dyn ExtensionArrayTrait>

impl VisitorVTable<ChunkedArray> for ChunkedEncoding

fn accept( &self, array: &ChunkedArray, visitor: &mut dyn ArrayVisitor, ) -> VortexResult<()>

impl BinaryArrayTrait for ChunkedArray

impl BoolArrayTrait for ChunkedArray

impl ListArrayTrait for ChunkedArray

impl NullArrayTrait for ChunkedArray

impl Utf8ArrayTrait for ChunkedArray