Trait SparseArray

pub trait SparseArray<T>: Any
where
    T: Float + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Debug + Copy + 'static,
{
    // Required methods
    fn shape(&self) -> (usize, usize);
    fn nnz(&self) -> usize;
    fn dtype(&self) -> &str;
    fn to_array(&self) -> Array2<T>;
    fn toarray(&self) -> Array2<T>;
    fn to_coo(&self) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn to_csr(&self) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn to_csc(&self) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn to_dok(&self) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn to_lil(&self) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn to_dia(&self) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn to_bsr(&self) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn add(
        &self,
        other: &dyn SparseArray<T>,
    ) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn sub(
        &self,
        other: &dyn SparseArray<T>,
    ) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn mul(
        &self,
        other: &dyn SparseArray<T>,
    ) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn div(
        &self,
        other: &dyn SparseArray<T>,
    ) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn dot(
        &self,
        other: &dyn SparseArray<T>,
    ) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn dot_vector(&self, other: &ArrayView1<'_, T>) -> SparseResult<Array1<T>>;
    fn transpose(&self) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn copy(&self) -> Box<dyn SparseArray<T>>;
    fn get(&self, i: usize, j: usize) -> T;
    fn set(&mut self, i: usize, j: usize, value: T) -> SparseResult<()>;
    fn eliminate_zeros(&mut self);
    fn sort_indices(&mut self);
    fn sorted_indices(&self) -> Box<dyn SparseArray<T>>;
    fn has_sorted_indices(&self) -> bool;
    fn sum(&self, axis: Option<usize>) -> SparseResult<SparseSum<T>>;
    fn max(&self) -> T;
    fn min(&self) -> T;
    fn find(&self) -> (Array1<usize>, Array1<usize>, Array1<T>);
    fn slice(
        &self,
        row_range: (usize, usize),
        col_range: (usize, usize),
    ) -> SparseResult<Box<dyn SparseArray<T>>>;
    fn as_any(&self) -> &dyn Any;
}

Trait for sparse array types.

This trait defines the common interface for all sparse array implementations. It is designed to align with SciPy’s sparse array API, providing array-like semantics rather than matrix-like semantics.

Notes

The sparse array API differs from the sparse matrix API in the following ways:

• * operator performs element-wise multiplication, not matrix multiplication
• Matrix multiplication is done with the dot method or @ operator in Python
• Operations like sum produce arrays, not matrices
• Sparse arrays use array-style slicing operations

Required Methods

fn shape(&self) -> (usize, usize)

Returns the shape of the sparse array.

fn nnz(&self) -> usize

Returns the number of stored (non-zero) elements.

fn dtype(&self) -> &str

Returns the data type of the sparse array.

fn to_array(&self) -> Array2<T>

Returns a view of the sparse array as a dense ndarray.

fn toarray(&self) -> Array2<T>

Returns a dense copy of the sparse array.

fn to_coo(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in COO format.

fn to_csr(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in CSR format.

fn to_csc(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in CSC format.

fn to_dok(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in DOK format.

fn to_lil(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in LIL format.

fn to_dia(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in DIA format.

fn to_bsr(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in BSR format.

fn add( &self, other: &dyn SparseArray<T>, ) -> SparseResult<Box<dyn SparseArray<T>>>

Element-wise addition.

fn sub( &self, other: &dyn SparseArray<T>, ) -> SparseResult<Box<dyn SparseArray<T>>>

Element-wise subtraction.

fn mul( &self, other: &dyn SparseArray<T>, ) -> SparseResult<Box<dyn SparseArray<T>>>

Element-wise multiplication.

fn div( &self, other: &dyn SparseArray<T>, ) -> SparseResult<Box<dyn SparseArray<T>>>

Element-wise division.

fn dot( &self, other: &dyn SparseArray<T>, ) -> SparseResult<Box<dyn SparseArray<T>>>

Matrix multiplication.

fn dot_vector(&self, other: &ArrayView1<'_, T>) -> SparseResult<Array1<T>>

Matrix-vector multiplication.

fn transpose(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Transpose the sparse array.

fn copy(&self) -> Box<dyn SparseArray<T>>

Return a copy of the sparse array with the specified elements.

fn get(&self, i: usize, j: usize) -> T

Get a value at the specified position.

fn set(&mut self, i: usize, j: usize, value: T) -> SparseResult<()>

Set a value at the specified position.

fn eliminate_zeros(&mut self)

Eliminate zeros from the sparse array.

fn sort_indices(&mut self)

Sort indices of the sparse array.

fn sorted_indices(&self) -> Box<dyn SparseArray<T>>

Return a sorted copy of this sparse array.

fn has_sorted_indices(&self) -> bool

Check if indices are sorted.

fn sum(&self, axis: Option<usize>) -> SparseResult<SparseSum<T>>

Sum the sparse array elements.

Parameters:

• axis: The axis along which to sum. If None, sum over both axes.

Returns a sparse array if summing over a single axis, or a scalar if summing over both axes.

fn max(&self) -> T

Compute the maximum value of the sparse array elements.

fn min(&self) -> T

Compute the minimum value of the sparse array elements.

fn find(&self) -> (Array1<usize>, Array1<usize>, Array1<T>)

Return the indices and values of the nonzero elements.

fn slice( &self, row_range: (usize, usize), col_range: (usize, usize), ) -> SparseResult<Box<dyn SparseArray<T>>>

Return a slice of the sparse array.

fn as_any(&self) -> &dyn Any

Returns the concrete type of the array for downcasting.

Implementors

impl<T> SparseArray<T> for BsrArray<T>

where T: Float + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Debug + Copy + 'static + AddAssign,

impl<T> SparseArray<T> for CooArray<T>

where T: Float + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Debug + Copy + 'static,

impl<T> SparseArray<T> for CscArray<T>

where T: Float + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Debug + Copy + 'static,

impl<T> SparseArray<T> for CsrArray<T>

where T: Float + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Debug + Copy + 'static,

impl<T> SparseArray<T> for DiaArray<T>

where T: Float + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Debug + Copy + 'static + AddAssign,

impl<T> SparseArray<T> for DokArray<T>

where T: Float + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Debug + Copy + 'static,

impl<T> SparseArray<T> for LilArray<T>

where T: Float + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Debug + Copy + 'static,

impl<T> SparseArray<T> for SymCooArray<T>

where T: Float + Debug + Copy + 'static + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T>,

Implementation of SparseArray for SymCooArray

impl<T> SparseArray<T> for SymCsrArray<T>

where T: Float + Debug + Copy + 'static + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T>,

Implementation of SparseArray for SymCsrArray

impl<T> SparseArray<T> for SparseArrayBase<T>

where T: Float + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Debug + Copy + 'static,