Struct Array 

pub struct Array<V: VTable> { /* private fields */ }

A typed array, parameterized by a concrete VTable.

This struct holds the vtable instance, common fields (dtype, len, stats), and the encoding-specific data (V::Array). It implements Deref to V::Array, so encoding-specific methods are callable directly on &Array<V>.

Construct via encoding-specific constructors and type-erase with into_array().

Implementations

impl<V: VTable> Array<V>

pub unsafe fn new_unchecked( vtable: V, dtype: DType, len: usize, array: V::Array, stats: ArrayStats, ) -> Self

Create a new typed array without validating that the inner array’s dtype/len match.

Safety

The caller must ensure that V::dtype(&array) == &dtype and V::len(&array) == len.

pub fn typed_vtable(&self) -> &V

Returns a reference to the vtable.

pub fn dtype(&self) -> &DType

Returns the dtype of this array.

pub fn len(&self) -> usize

Returns the length of this array.

pub fn is_empty(&self) -> bool

Returns whether this array is empty.

pub fn encoding_id(&self) -> ArrayId

Returns the encoding ID of this array.

pub fn statistics(&self) -> StatsSetRef<'_>

Returns the statistics for this array.

pub fn array_stats(&self) -> &ArrayStats

Returns a reference to the underlying ArrayStats.

pub fn inner(&self) -> &V::Array

Returns a reference to the inner encoding-specific array data.

pub fn into_inner(self) -> V::Array

Consumes this array and returns the inner encoding-specific data.

pub fn to_array_ref(&self) -> ArrayRef

Returns a cloned ArrayRef for this array.

Trait Implementations

impl<V: VTable> ArrayEq for Array<V>

fn array_eq(&self, other: &Self, precision: Precision) -> bool

impl<V: VTable> ArrayHash for Array<V>

fn array_hash<H: Hasher>(&self, state: &mut H, precision: Precision)

impl<V: VTable> ArrayVisitor for Array<V>

fn children(&self) -> Vec<ArrayRef>

Returns the children of the array.

fn nchildren(&self) -> usize

Returns the number of children of the array.

fn nth_child(&self, idx: usize) -> Option<ArrayRef>

Returns the nth child of the array without allocating a Vec.

fn children_names(&self) -> Vec<String>

Returns the names of the children of the array.

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

Returns the array’s children with their names.

fn buffers(&self) -> Vec<ByteBuffer>

Returns the buffers of the array.

fn buffer_handles(&self) -> Vec<BufferHandle>

Returns the buffer handles of the array.

fn buffer_names(&self) -> Vec<String>

Returns the names of the buffers of the array.

fn named_buffers(&self) -> Vec<(String, BufferHandle)>

Returns the array’s buffers with their names.

fn nbuffers(&self) -> usize

Returns the number of buffers of the array.

fn metadata(&self) -> VortexResult<Option<Vec<u8>>>

Returns the serialized metadata of the array, or None if the array does not support serialization.

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

Formats a human-readable metadata description.

fn is_host(&self) -> bool

Checks if all buffers in the array tree are host-resident.

impl<V: VTable> Clone for Array<V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: VTable> Debug for Array<V>

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

Formats the value using the given formatter.

impl<V: VTable> Deref for Array<V>

type Target = <V as VTable>::Array

The resulting type after dereferencing.

fn deref(&self) -> &V::Array

Dereferences the value.

impl<V: VTable> DynArray for Array<V>

DynArray implementation for Array<V>.

This is self-contained: identity methods use Array<V>’s own fields (dtype, len, stats), while data-access methods delegate to VTable methods on the inner V::Array.

fn as_any(&self) -> &dyn Any

Returns the array as a reference to a generic Any trait object.

fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any + Send + Sync>

Returns the array as an Arc<dyn Any + Send + Sync>.

fn to_array(&self) -> ArrayRef

Returns the array as an ArrayRef.

fn len(&self) -> usize

Returns the length of the array.

fn dtype(&self) -> &DType

Returns the logical Vortex DType of the array.

fn vtable(&self) -> &dyn DynVTable

Returns the vtable of the array.

fn encoding_id(&self) -> ArrayId

Returns the encoding ID of the array.

fn slice(&self, range: Range<usize>) -> VortexResult<ArrayRef>

Performs a constant-time slice of the array.

fn filter(&self, mask: Mask) -> VortexResult<ArrayRef>

Wraps the array in a FilterArray such that it is logically filtered by the given mask.

fn take(&self, indices: ArrayRef) -> VortexResult<ArrayRef>

Wraps the array in a DictArray such that it is logically taken by the given indices.

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

Fetch the scalar at the given index.

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

Returns whether the item at index is valid.

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

Returns whether the item at index is invalid.

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

Returns whether all items in the array are valid.

fn all_invalid(&self) -> VortexResult<bool>

Returns whether the array is all invalid.

fn valid_count(&self) -> VortexResult<usize>

Returns the number of valid elements in the array.

fn invalid_count(&self) -> VortexResult<usize>

Returns the number of invalid elements in the array.

fn validity(&self) -> VortexResult<Validity>

Returns the Validity of the array.

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

Returns the canonical validity mask for the array.

fn to_canonical(&self) -> VortexResult<Canonical>

Returns the canonical representation of the array.

fn append_to_builder( &self, builder: &mut dyn ArrayBuilder, ctx: &mut ExecutionCtx, ) -> VortexResult<()>

Writes the array into the canonical builder.

fn statistics(&self) -> StatsSetRef<'_>

Returns the statistics of the array.

fn with_children(&self, children: Vec<ArrayRef>) -> VortexResult<ArrayRef>

Replaces the children of the array with the given array references.

fn is_empty(&self) -> bool

Returns whether the array is empty (has zero rows).

impl<V: VTable> From<Array<V>> for ArrayRef

fn from(value: Array<V>) -> ArrayRef

Converts to this type from the input type.

impl<V: VTable> IntoArray for Array<V>

fn into_array(self) -> ArrayRef

impl<V: VTable> ReduceNode for Array<V>

fn as_any(&self) -> &dyn Any

Downcast to Any.

fn node_dtype(&self) -> VortexResult<DType>

Return the data type of this node.

fn scalar_fn(&self) -> Option<&ScalarFnRef>

Return this node’s scalar function if it is indeed a scalar fn.

fn child(&self, idx: usize) -> ReduceNodeRef

Descend to the child of this handle.

fn child_count(&self) -> usize

Returns the number of children of this node.