Struct vortex_array::array::SparseArray

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

Implementations

impl SparseArray

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

Optionally downcast an ArrayData 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: ArrayData, values: ArrayData, 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

Trait Implementations

impl AsRef<ArrayData> for SparseArray

fn as_ref(&self) -> &ArrayData

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: &ArrayData, op: BinaryNumericOperator, ) -> VortexResult<Option<ArrayData>>

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) -> ArrayData

Returns the underlying ArrayData, 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: FilterMask, ) -> VortexResult<ArrayData>

Filter an array by the provided predicate.

impl IntoArrayData for SparseArray

fn into_array(self) -> ArrayData

impl IntoCanonical for SparseArray

fn into_canonical(self) -> VortexResult<Canonical>

fn into_arrow(self) -> VortexResult<ArrayRef>

where Self: Sized,

impl InvertFn<SparseArray> for SparseEncoding

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

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: &Array, values: &[Scalar], side: SearchSortedSide, ) -> VortexResult<Vec<SearchResult>>

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: &Array, values: &[usize], side: SearchSortedSide, ) -> VortexResult<Vec<SearchResult>>

impl SliceFn<SparseArray> for SparseEncoding

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

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 field(&self, idx: usize) -> Option<ArrayData>

Return a field’s array by index

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

fn names(&self) -> &FieldNames

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

fn nfields(&self) -> usize

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

Return a field’s array by name

impl TakeFn<SparseArray> for SparseEncoding

fn take( &self, array: &SparseArray, take_indices: &ArrayData, ) -> VortexResult<ArrayData>

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

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

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

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

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ArrayData> for SparseArray

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ValidityVTable<SparseArray> for SparseEncoding

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

fn logical_validity(&self, array: &SparseArray) -> LogicalValidity

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

impl BinaryArrayTrait for SparseArray

impl BoolArrayTrait for SparseArray

impl ListArrayTrait for SparseArray

impl NullArrayTrait for SparseArray

impl Utf8ArrayTrait for SparseArray