Struct CsrArray

pub struct CsrArray<T>
where
    T: Float + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Debug + Copy + 'static,
{ /* private fields */ }

CSR Array format

The CSR (Compressed Sparse Row) format stores a sparse array in three arrays:

• data: array of non-zero values
• indices: column indices of the non-zero values
• indptr: index pointers; for each row, points to the first non-zero element

Notes

• Efficient for row-oriented operations
• Fast matrix-vector multiplications
• Fast row slicing
• Slow column slicing
• Slow constructing by setting individual elements

Implementations

impl<T> CsrArray<T>

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

pub fn new( data: Array1<T>, indices: Array1<usize>, indptr: Array1<usize>, shape: (usize, usize), ) -> SparseResult<Self>

Creates a new CSR array from raw components

Arguments

• data - Array of non-zero values
• indices - Column indices of non-zero values
• indptr - Index pointers for the start of each row
• shape - Shape of the sparse array

Returns

A new CsrArray

Errors

Returns an error if the data is not consistent

pub fn from_triplets( rows: &[usize], cols: &[usize], data: &[T], shape: (usize, usize), sorted: bool, ) -> SparseResult<Self>

Create a CSR array from triplet format (COO-like)

Arguments

• rows - Row indices
• cols - Column indices
• data - Values
• shape - Shape of the sparse array
• sorted - Whether the triplets are sorted by row

Returns

A new CsrArray

Errors

Returns an error if the data is not consistent

pub fn get_data(&self) -> &Array1<T>

Get the raw data array

pub fn get_indices(&self) -> &Array1<usize>

Get the raw indices array

pub fn get_indptr(&self) -> &Array1<usize>

Get the raw indptr array

pub fn nrows(&self) -> usize

Get the number of rows

pub fn ncols(&self) -> usize

Get the number of columns

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

Get the shape (rows, cols)

Trait Implementations

impl<T> Clone for CsrArray<T>

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

fn clone(&self) -> CsrArray<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for CsrArray<T>

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

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

Formats the value using the given formatter.

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,

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.

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.