Struct SparseMatrix 

pub struct SparseMatrix<F: PrimeField> {
    pub data: Vec<F>,
    pub indices: Vec<usize>,
    pub indptr: Vec<usize>,
    pub cols: usize,
}

CSR format sparse matrix, We follow the names used by scipy. Detailed explanation here: https://stackoverflow.com/questions/52299420/scipy-csr-matrix-understand-indptr

Fields

data: Vec<F>

all non-zero values in the matrix

indices: Vec<usize>

column indices

indptr: Vec<usize>

row information

cols: usize

number of columns

Implementations

impl<F: PrimeField> SparseMatrix<F>

pub fn empty() -> Self

0x0 empty matrix

pub fn new(matrix: &[(usize, usize, F)], rows: usize, cols: usize) -> Self

Construct from the COO representation; Vec<usize(row), usize(col), F>. We assume that the rows are sorted during construction.

pub fn get_row_unchecked( &self, ptrs: &[usize; 2], ) -> impl Iterator<Item = (&F, &usize)>

Retrieves the data for row slice [i..j] from ptrs. We assume that ptrs is indexed from indptrs and do not check if the returned slice is actually a valid row.

pub fn multiply_vec(&self, vector: &[F]) -> Vec<F>

Multiply by a dense vector; uses rayon/gpu.

pub fn multiply_vec_unchecked(&self, vector: &[F]) -> Vec<F>

Multiply by a dense vector; uses rayon/gpu. This does not check that the shape of the matrix/vector are compatible.

pub fn len(&self) -> usize

number of non-zero entries

pub fn is_empty(&self) -> bool

empty matrix

pub fn iter(&self) -> Iter<'_, F>

returns a custom iterator

Trait Implementations

impl<F: Clone + PrimeField> Clone for SparseMatrix<F>

fn clone(&self) -> SparseMatrix<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + PrimeField> Debug for SparseMatrix<F>

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

Formats the value using the given formatter.

impl<'de, F> Deserialize<'de> for SparseMatrix<F>

where F: Deserialize<'de> + PrimeField,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: PartialEq + PrimeField> PartialEq for SparseMatrix<F>

fn eq(&self, other: &SparseMatrix<F>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F> Serialize for SparseMatrix<F>

where F: Serialize + PrimeField,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: Eq + PrimeField> Eq for SparseMatrix<F>

impl<F: PrimeField> StructuralPartialEq for SparseMatrix<F>