Struct SparseArray

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

Implementations

impl SparseArray

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 SparseArray

pub fn try_new( indices: Array, values: Array, len: usize, fill_value: Scalar, ) -> VortexResult<Self>

pub fn try_new_from_patches( patches: Patches, len: usize, indices_offset: usize, fill_value: Scalar, ) -> VortexResult<Self>

pub fn indices_offset(&self) -> usize

pub fn patches(&self) -> Patches

pub fn resolved_patches(&self) -> VortexResult<Patches>

pub fn fill_scalar(&self) -> Scalar

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, ) -> Result<Array, VortexError>

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<&Buffer<u8>>

pub fn byte_buffers(&self) -> impl Iterator<Item = Buffer<u8>>

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

Checks whether array is of a given encoding.

pub fn try_downcast_ref<E>( &self, ) -> Result<(&<E as Encoding>::Array, &E), VortexError>

where E: Encoding, &'a <E as Encoding>::Array: for<'a> 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) -> Result<bool, VortexError>

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

pub fn null_count(&self) -> Result<usize, VortexError>

Return the number of null elements in the array.

pub fn logical_validity(&self) -> Result<Mask, VortexError>

Return the logical validity of the array if nullable, and None if non-nullable.

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<Target = Array>>

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<Target = Array>>

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

pub fn as_extension_array( &self, ) -> Option<&dyn ExtensionArrayTrait<Target = Array>>

Trait Implementations

impl AsRef<Array> for SparseArray

fn as_ref(&self) -> &Array

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

impl BinaryNumericFn<SparseArray> for SparseEncoding

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

impl CanonicalVTable<SparseArray> for SparseEncoding

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

impl Clone for SparseArray

fn clone(&self) -> SparseArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SparseArray

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

Formats the value using the given formatter.

impl Deref for SparseArray

type Target = Array

The resulting type after dereferencing.

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

Dereferences the value.

impl ExtensionArrayTrait for SparseArray

fn storage_data(&self) -> Array

Returns the underlying Array, without the ExtDType.

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

Returns the extension logical DType.

impl FilterFn<SparseArray> for SparseEncoding

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

Filter an array by the provided predicate.

impl IntoArray for SparseArray

fn into_array(self) -> Array

impl InvertFn<SparseArray> for SparseEncoding

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

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

impl PrimitiveArrayTrait for SparseArray

fn ptype(&self) -> PType

The logical primitive type of the array.

impl ScalarAtFn<SparseArray> for SparseEncoding

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

impl SearchSortedFn<SparseArray> for SparseEncoding

fn search_sorted( &self, array: &SparseArray, value: &Scalar, side: SearchSortedSide, ) -> VortexResult<SearchResult>

fn search_sorted_many( &self, array: &A, values: &[Scalar], side: SearchSortedSide, ) -> Result<Vec<SearchResult>, VortexError>

Bulk search for many values.

impl SearchSortedUsizeFn<SparseArray> for SparseEncoding

fn search_sorted_usize( &self, array: &SparseArray, value: usize, side: SearchSortedSide, ) -> VortexResult<SearchResult>

fn search_sorted_usize_many( &self, array: &A, values: &[usize], side: SearchSortedSide, ) -> Result<Vec<SearchResult>, VortexError>

impl SliceFn<SparseArray> for SparseEncoding

fn slice( &self, array: &SparseArray, 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<SparseArray> for SparseEncoding

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

Compute the requested statistic. Can return additional stats.

impl StructArrayTrait for SparseArray

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) -> &Arc<[Arc<str>]>

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

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<SparseArray> for SparseEncoding

fn take(&self, array: &SparseArray, take_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, ) -> Result<Array, VortexError>

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

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

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 SparseArray

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<SparseArray> for SparseEncoding

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

impl ValidityVTable<SparseArray> for SparseEncoding

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

Returns whether the index item is valid.

fn logical_validity(&self, array: &SparseArray) -> VortexResult<Mask>

fn null_count(&self, array: &Array) -> Result<usize, VortexError>

Returns the number of invalid elements in the array.

impl VariantsVTable<SparseArray> for SparseEncoding

Sparse arrays support all DTypes

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

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

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

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

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

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

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

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

impl VisitorVTable<SparseArray> for SparseEncoding

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

impl BinaryArrayTrait for SparseArray

impl BoolArrayTrait for SparseArray

impl ListArrayTrait for SparseArray

impl NullArrayTrait for SparseArray

impl Utf8ArrayTrait for SparseArray