Struct SparseArray

pub struct SparseArray { /* private fields */ }

Implementations

impl SparseArray

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

impl SparseArray

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

pub fn indices_offset(&self) -> usize

pub fn values(&self) -> Array

pub fn indices(&self) -> Array

pub fn fill_value(&self) -> &ScalarValue

pub fn fill_scalar(&self) -> Scalar

pub fn resolved_indices(&self) -> Vec<usize>

Return indices as a vector of usize with the indices_offset applied.

pub fn min_index(&self) -> Option<usize>

Return the minimum index if indices are present.

If this sparse array has no indices (i.e. all elements are equal to fill_value) then it returns None.

pub fn max_index(&self) -> Option<usize>

Return the maximum index if indices are present.

If this sparse array has no indices (i.e. all elements are equal to fill_value) then it returns None.

Trait Implementations

impl AcceptArrayVisitor for SparseArray

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

impl ArrayCompute for SparseArray

fn scalar_at(&self) -> Option<&dyn ScalarAtFn>

Single item indexing on Vortex arrays.

fn search_sorted(&self) -> Option<&dyn SearchSortedFn>

Perform a search over an ordered array.

fn slice(&self) -> Option<&dyn SliceFn>

Perform zero-copy slicing of an array.

fn take(&self) -> Option<&dyn TakeFn>

Take a set of indices from an array. This often forces allocations and decoding of the receiver.

fn filter(&self) -> Option<&dyn FilterFn>

Filtering function on arrays of predicates.

fn cast(&self) -> Option<&dyn CastFn>

Implemented for arrays that can be casted to different types.

fn compare( &self, _other: &Array, _operator: Operator, ) -> Option<VortexResult<Array>>

Binary operator implementation for arrays against other arrays.

fn fill_forward(&self) -> Option<&dyn FillForwardFn>

Array function that returns new arrays a non-null value is repeated across runs of nulls.

fn subtract_scalar(&self) -> Option<&dyn SubtractScalarFn>

Broadcast subtraction of scalar from Vortex array.

fn and(&self) -> Option<&dyn AndFn>

Perform an Arrow-style boolean AND operation over two arrays

fn and_kleene(&self) -> Option<&dyn AndFn>

Perform a Kleene-style boolean AND operation over two arrays

fn or(&self) -> Option<&dyn OrFn>

Perform an Arrow-style boolean OR operation over two arrays

fn or_kleene(&self) -> Option<&dyn OrFn>

Perform a Kleene-style boolean OR operation over two arrays

impl ArrayStatisticsCompute for SparseArray

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

Compute the requested statistic. Can return additional stats.

impl ArrayTrait for SparseArray

fn nbytes(&self) -> usize

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

impl ArrayValidity for SparseArray

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

fn logical_validity(&self) -> LogicalValidity

impl ArrayVariants for SparseArray

Sparse arrays support all DTypes

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

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

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

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

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

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

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

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

fn as_null_array_unchecked(&self) -> &dyn NullArrayTrait

fn as_bool_array_unchecked(&self) -> &dyn BoolArrayTrait

fn as_primitive_array_unchecked(&self) -> &dyn PrimitiveArrayTrait

fn as_utf8_array_unchecked(&self) -> &dyn Utf8ArrayTrait

fn as_binary_array_unchecked(&self) -> &dyn BinaryArrayTrait

fn as_struct_array_unchecked(&self) -> &dyn StructArrayTrait

fn as_list_array_unchecked(&self) -> &dyn ListArrayTrait

fn as_extension_array_unchecked(&self) -> &dyn ExtensionArrayTrait

impl AsRef<Array> for SparseArray

fn as_ref(&self) -> &Array

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

impl BoolArrayTrait for SparseArray

fn invert(&self) -> VortexResult<Array>

Return a new inverted version of this array.

fn maybe_null_indices_iter(&self) -> Box<dyn Iterator<Item = usize>>

An iterator over the sorted indices of set values in the underlying boolean array good to array with low number of set values.

fn maybe_null_slices_iter(&self) -> Box<dyn Iterator<Item = (usize, usize)>>

An iterator over the sorted disjoint contiguous range of set values in the underlying boolean array good for arrays with only long runs of set values.

fn true_count(&self) -> usize

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_array(&self) -> Array

Returns the underlying Array, without the ExtDType.

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

Returns the extension logical DType.

impl FilterFn for SparseArray

fn filter(&self, predicate: &Array) -> VortexResult<Array>

Filter an array by the provided predicate.

impl From<SparseArray> for Array

fn from(value: SparseArray) -> Array

Converts to this type from the input type.

impl From<TypedArray<Sparse>> for SparseArray

fn from(typed: TypedArray<Sparse>) -> Self

Converts to this type from the input type.

impl GetArrayMetadata for SparseArray

fn metadata(&self) -> Arc<dyn ArrayMetadata>

impl IntoArray for SparseArray

fn into_array(self) -> Array

impl IntoCanonical for SparseArray

fn into_canonical(self) -> VortexResult<Canonical>

impl PrimitiveArrayTrait for SparseArray

fn ptype(&self) -> PType

fn u8_accessor(&self) -> Option<AccessorRef<u8>>

fn u16_accessor(&self) -> Option<AccessorRef<u16>>

fn u32_accessor(&self) -> Option<AccessorRef<u32>>

fn u64_accessor(&self) -> Option<AccessorRef<u64>>

fn i8_accessor(&self) -> Option<AccessorRef<i8>>

fn i16_accessor(&self) -> Option<AccessorRef<i16>>

fn i32_accessor(&self) -> Option<AccessorRef<i32>>

fn i64_accessor(&self) -> Option<AccessorRef<i64>>

fn f16_accessor(&self) -> Option<AccessorRef<f16>>

fn f32_accessor(&self) -> Option<AccessorRef<f32>>

fn f64_accessor(&self) -> Option<AccessorRef<f64>>

fn u8_iter(&self) -> Option<VectorizedArrayIter<u8>>

fn u16_iter(&self) -> Option<VectorizedArrayIter<u16>>

fn u32_iter(&self) -> Option<VectorizedArrayIter<u32>>

fn u64_iter(&self) -> Option<VectorizedArrayIter<u64>>

fn i8_iter(&self) -> Option<VectorizedArrayIter<i8>>

fn i16_iter(&self) -> Option<VectorizedArrayIter<i16>>

fn i32_iter(&self) -> Option<VectorizedArrayIter<i32>>

fn i64_iter(&self) -> Option<VectorizedArrayIter<i64>>

fn f16_iter(&self) -> Option<VectorizedArrayIter<f16>>

fn f32_iter(&self) -> Option<VectorizedArrayIter<f32>>

fn f64_iter(&self) -> Option<VectorizedArrayIter<f64>>

impl ScalarAtFn for SparseArray

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

fn scalar_at_unchecked(&self, index: usize) -> Scalar

impl SearchSortedFn for SparseArray

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

fn search_sorted_u64( &self, value: u64, side: SearchSortedSide, ) -> VortexResult<SearchResult>

fn search_sorted_many( &self, values: &[Scalar], sides: &[SearchSortedSide], ) -> VortexResult<Vec<SearchResult>>

Bulk search for many values.

fn search_sorted_u64_many( &self, values: &[u64], sides: &[SearchSortedSide], ) -> VortexResult<Vec<SearchResult>>

impl SliceFn for SparseArray

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

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

Return a field’s array by index

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

fn names(&self) -> &FieldNames

fn dtypes(&self) -> &[DType]

fn nfields(&self) -> usize

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

Return a field’s array by name

impl TakeFn for SparseArray

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

impl ToArray for SparseArray

fn to_array(&self) -> Array

impl TryFrom<&Array> for SparseArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for SparseArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.

impl BinaryArrayTrait for SparseArray

impl ListArrayTrait for SparseArray

impl NullArrayTrait for SparseArray

impl Utf8ArrayTrait for SparseArray