Struct Sparse 

pub struct Sparse;

Implementations

impl Sparse

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

Construct a new SparseArray from indices, values, length, and fill value.

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

pub fn encode( array: &ArrayRef, fill_value: Option<Scalar>, ctx: &mut ExecutionCtx, ) -> VortexResult<ArrayRef>

Encode the given array as a SparseArray.

Trait Implementations

impl BetweenKernel for Sparse

Sparse-specific between kernel.

lower <= x <= upper (with per-bound strictness) over a Sparse column with constant bounds is itself sparse: every unpatched position resolves to between(F, lo, hi) and every patched position to between(patch, lo, hi). We push the range check into the patches and rebuild a Sparse<Bool> with the new fill, preserving downstream sparsity.

Declines (falls back to canonical) unless both bounds are constants.

fn between( array: ArrayView<'_, Self>, lower: &ArrayRef, upper: &ArrayRef, options: &BetweenOptions, ctx: &mut ExecutionCtx, ) -> VortexResult<Option<ArrayRef>>

impl CastReduce for Sparse

fn cast( array: ArrayView<'_, Self>, dtype: &DType, ) -> VortexResult<Option<ArrayRef>>

impl Clone for Sparse

fn clone(&self) -> Sparse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CompareKernel for Sparse

Sparse-specific compare kernel.

When the RHS is a constant scalar, the result of any comparison is itself sparse: every unpatched position resolves to compare(fill, rhs), and every patched position to compare(patch, rhs). We push the comparison into the patches and rebuild a Sparse<Bool> with the new fill, preserving downstream sparsity (filter masks, etc.).

For non-constant RHS we decline and let the canonical fallback handle it.

fn compare( lhs: ArrayView<'_, Self>, rhs: &ArrayRef, operator: CompareOperator, _ctx: &mut ExecutionCtx, ) -> VortexResult<Option<ArrayRef>>

impl Debug for Sparse

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

Formats the value using the given formatter.

impl FillNullKernel for Sparse

Sparse-specific fill_null kernel.

fill_null(Sparse{ F, patches }, v) replaces nulls in the fill and in each patch value with the (non-null) v, staying sparse: the new fill is v if F was null, else F cast to the non-nullable result dtype. The work is O(P).

fn fill_null( array: ArrayView<'_, Self>, fill_value: &Scalar, _ctx: &mut ExecutionCtx, ) -> VortexResult<Option<ArrayRef>>

impl FilterKernel for Sparse

fn filter( array: ArrayView<'_, Self>, mask: &Mask, ctx: &mut ExecutionCtx, ) -> VortexResult<Option<ArrayRef>>

Filter an array with the provided mask, potentially reading buffers.

impl NotReduce for Sparse

fn invert(array: ArrayView<'_, Self>) -> VortexResult<Option<ArrayRef>>

impl OperationsVTable<Sparse> for Sparse

fn scalar_at( array: ArrayView<'_, Sparse>, index: usize, _ctx: &mut ExecutionCtx, ) -> VortexResult<Scalar>

Fetch the scalar at the given index.

impl SliceKernel for Sparse

fn slice( array: ArrayView<'_, Self>, range: Range<usize>, _ctx: &mut ExecutionCtx, ) -> VortexResult<Option<ArrayRef>>

Slice an array with the provided range, potentially reading buffers.

impl TakeExecute for Sparse

fn take( array: ArrayView<'_, Self>, indices: &ArrayRef, ctx: &mut ExecutionCtx, ) -> VortexResult<Option<ArrayRef>>

Take elements from an array at the given indices, potentially reading buffers.

impl VTable for Sparse

type TypedArrayData = SparseData

type OperationsVTable = Sparse

type ValidityVTable = Sparse

fn id(&self) -> ArrayId

Returns the ID of the array.

fn validate( &self, data: &Self::TypedArrayData, dtype: &DType, len: usize, slots: &[Option<ArrayRef>], ) -> VortexResult<()>

Validates that externally supplied logical metadata matches the array data.

fn nbuffers(_array: ArrayView<'_, Self>) -> usize

Returns the number of buffers in the array.

fn buffer(array: ArrayView<'_, Self>, idx: usize) -> BufferHandle

Returns the buffer at the given index.

fn buffer_name(_array: ArrayView<'_, Self>, idx: usize) -> Option<String>

Returns the name of the buffer at the given index, or None if unnamed.

fn serialize( array: ArrayView<'_, Self>, _session: &VortexSession, ) -> VortexResult<Option<Vec<u8>>>

Serialize metadata into a byte buffer for IPC or file storage. Return None if the array cannot be serialized.

fn deserialize( &self, dtype: &DType, len: usize, metadata: &[u8], buffers: &[BufferHandle], children: &dyn ArrayChildren, session: &VortexSession, ) -> VortexResult<ArrayParts<Self>>

Deserialize an array from serialized components.

fn slot_name(_array: ArrayView<'_, Self>, idx: usize) -> String

Returns the name of the slot at the given index.

fn reduce_parent( array: ArrayView<'_, Self>, parent: &ArrayRef, child_idx: usize, ) -> VortexResult<Option<ArrayRef>>

Attempt to perform a reduction of the parent of this array.

fn execute_parent( array: ArrayView<'_, Self>, parent: &ArrayRef, child_idx: usize, ctx: &mut ExecutionCtx, ) -> VortexResult<Option<ArrayRef>>

Attempt to execute the parent of this array.

fn execute( array: Array<Self>, ctx: &mut ExecutionCtx, ) -> VortexResult<ExecutionResult>

Execute this array by returning an ExecutionResult.

fn nchildren(array: ArrayView<'_, Self>) -> usize

Returns the number of children in the array.

fn child(array: ArrayView<'_, Self>, idx: usize) -> ArrayRef

Returns the child at the given index.

fn child_name(array: ArrayView<'_, Self>, idx: usize) -> String

Returns the name of the child at the given index.

fn append_to_builder( array: ArrayView<'_, Self>, builder: &mut dyn ArrayBuilder, ctx: &mut ExecutionCtx, ) -> Result<(), VortexError>

Writes the array into a canonical builder.

fn reduce(array: ArrayView<'_, Self>) -> Result<Option<ArrayRef>, VortexError>

Attempt to reduce the array to a simpler representation.

impl ValidityVTable<Sparse> for Sparse

fn validity(array: ArrayView<'_, Sparse>) -> VortexResult<Validity>

Returns the Validity of the array.