Struct SparseArray

pub struct SparseArray { /* private fields */ }

Implementations

impl SparseArray

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

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

pub fn patches(&self) -> &Patches

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

pub fn fill_scalar(&self) -> &Scalar

pub fn encode( array: &dyn Array, fill_value: Option<Scalar>, ) -> VortexResult<ArrayRef>

Encode given array as a SparseArray.

Optionally provided fill value will be respected if the array is less than 90% null.

Trait Implementations

impl ArrayCanonicalImpl for SparseArray

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

Returns the canonical representation of the array.

fn _append_to_builder( &self, builder: &mut dyn ArrayBuilder, ) -> Result<(), VortexError>

Writes the array into the canonical builder.

impl ArrayComputeImpl for SparseArray

const FILTER: Option<KernelRef>

fn _find_kernel( &self, _compute_fn: &dyn ComputeFn, ) -> Option<ArcRef<dyn Kernel>>

Fallback implementation to lookup compute kernels at runtime.

impl ArrayImpl for SparseArray

type Encoding = SparseEncoding

fn _len(&self) -> usize

fn _dtype(&self) -> &DType

fn _vtable(&self) -> VTableRef

fn _with_children(&self, children: &[ArrayRef]) -> VortexResult<Self>

Replace the children of this array with the given arrays.

impl ArrayStatisticsImpl for SparseArray

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

impl ArrayValidityImpl for SparseArray

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

Returns whether the index item is valid.

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

Returns whether the array is all valid.

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

Returns whether the array is all invalid.

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

Returns the canonical validity mask for the array.

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

Returns the number of valid elements in the array.

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

Returns the number of invalid elements in the array.

impl ArrayVariantsImpl for SparseArray

Sparse arrays support all DTypes

fn _as_null_typed(&self) -> Option<&dyn NullArrayTrait>

Downcasts the array for null-specific behavior.

fn _as_bool_typed(&self) -> Option<&dyn BoolArrayTrait>

Downcasts the array for bool-specific behavior.

fn _as_primitive_typed(&self) -> Option<&dyn PrimitiveArrayTrait>

Downcasts the array for primitive-specific behavior.

fn _as_utf8_typed(&self) -> Option<&dyn Utf8ArrayTrait>

Downcasts the array for utf8-specific behavior.

fn _as_binary_typed(&self) -> Option<&dyn BinaryArrayTrait>

Downcasts the array for binary-specific behavior.

fn _as_struct_typed(&self) -> Option<&dyn StructArrayTrait>

Downcasts the array for struct-specific behavior.

fn _as_list_typed(&self) -> Option<&dyn ListArrayTrait>

Downcasts the array for list-specific behavior.

fn _as_extension_typed(&self) -> Option<&dyn ExtensionArrayTrait>

Downcasts the array for extension-specific behavior.

impl ArrayVisitorImpl<RkyvMetadata<SparseMetadata>> for SparseArray

fn _visit_buffers(&self, visitor: &mut dyn ArrayBufferVisitor)

fn _visit_children(&self, visitor: &mut dyn ArrayChildVisitor)

fn _metadata(&self) -> RkyvMetadata<SparseMetadata>

fn _nbuffers(&self) -> usize

fn _nchildren(&self) -> usize

impl BinaryNumericFn<&SparseArray> for SparseEncoding

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

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

fn storage_data(&self) -> ArrayRef

Returns the underlying ArrayRef, without the ExtDType.

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

Returns the extension logical DType.

impl InvertFn<&SparseArray> for SparseEncoding

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

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<ArrayRef>

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

fn maybe_null_field_by_idx(&self, idx: usize) -> VortexResult<ArrayRef>

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

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

fn names(&self) -> &Arc<[Arc<str>]>

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

fn nfields(&self) -> usize

fn maybe_null_field_by_name( &self, name: &str, ) -> Result<Arc<dyn Array>, VortexError>

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

impl TakeFn<&SparseArray> for SparseEncoding

fn take( &self, array: &SparseArray, take_indices: &dyn Array, ) -> VortexResult<ArrayRef>

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

fn take_into( &self, array: A, indices: &dyn Array, builder: &mut dyn ArrayBuilder, ) -> Result<(), VortexError>

Has the same semantics as Self::take but materializes the result into the provided builder.

impl TryFrom<Arc<dyn Array>> for SparseArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ArrayRef) -> Result<Self, Self::Error>

Performs the conversion.

impl BinaryArrayTrait for SparseArray

impl BoolArrayTrait for SparseArray

impl ListArrayTrait for SparseArray

impl NullArrayTrait for SparseArray

impl Utf8ArrayTrait for SparseArray