Struct SymCsrArray

pub struct SymCsrArray<T>
where
    T: Float + Debug + Copy,
{ /* private fields */ }

Array-based SymCSR implementation compatible with SparseArray trait

Implementations

impl<T> SymCsrArray<T>

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

pub fn new(matrix: SymCsrMatrix<T>) -> Self

Create a new SymCSR array from a SymCSR matrix

Arguments

• matrix - Symmetric CSR matrix

Returns

SymCSR array

pub fn from_csr_array(array: &CsrArray<T>) -> SparseResult<Self>

Create a SymCSR array from a regular CSR array

Arguments

• array - CSR array to convert

Returns

A symmetric CSR array

pub fn inner(&self) -> &SymCsrMatrix<T>

Get the underlying matrix

Returns

Reference to the inner SymCSR matrix

pub fn data(&self) -> &[T]

Get access to the underlying data array

Returns

Reference to the data array

pub fn indices(&self) -> &[usize]

Get access to the underlying indices array

Returns

Reference to the indices array

pub fn indptr(&self) -> &[usize]

Get access to the underlying indptr array

Returns

Reference to the indptr array

pub fn to_csr_array(&self) -> SparseResult<CsrArray<T>>

Convert to a standard CSR array

Returns

CSR array containing the full symmetric matrix

Trait Implementations

impl<T> Clone for SymCsrArray<T>

where T: Float + Debug + Copy + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for SymCsrArray<T>

where T: Float + Debug + Copy + Debug,

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

Formats the value using the given formatter.

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

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 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 get(&self, row: usize, col: usize) -> T

Get a value at the specified position.

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 set(&mut self, _i: usize, _j: usize, _value: T) -> SparseResult<()>

Set a value at the specified position.

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

Matrix-vector multiplication.

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

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

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

Element-wise subtraction.

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

Element-wise division.

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 slice( &self, rows: (usize, usize), cols: (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.

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

Return the indices and values of the nonzero elements.

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

Element-wise addition.

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

Element-wise multiplication.

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

Matrix multiplication.

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

Transpose the sparse array.

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

Returns a sparse array in CSC format.

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

Returns a sparse array in DIA 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_bsr(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in BSR format.

impl<T> SymSparseArray<T> for SymCsrArray<T>

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

Implementation of SymSparseArray for SymCsrArray

fn nnz_stored(&self) -> usize

Get the number of stored non-zero elements

fn to_csr(&self) -> SparseResult<CsrArray<T>>

Convert to standard CSR array

fn to_coo(&self) -> SparseResult<CooArray<T>>

Convert to standard COO array

fn to_sym_csr(&self) -> SparseResult<SymCsrArray<T>>

Convert to symmetric CSR array

fn to_sym_coo(&self) -> SparseResult<SymCooArray<T>>

Convert to symmetric COO array

fn is_symmetric(&self) -> bool

Check if the matrix is guaranteed to be symmetric