Skip to main content

SparseMatrix

Struct SparseMatrix 

Source
pub struct SparseMatrix {
    pub rows: usize,
    pub cols: usize,
    pub row_ptr: Vec<usize>,
    pub col_indices: Vec<usize>,
    pub values: Vec<f64>,
}
Expand description

A sparse matrix stored in CSR (Compressed Sparse Row) format.

Fields§

§rows: usize

Number of rows.

§cols: usize

Number of columns.

§row_ptr: Vec<usize>

Row pointers: row i has non-zeros at col_indices[row_ptr[i]..row_ptr[i+1]].

§col_indices: Vec<usize>

Column indices of non-zero entries.

§values: Vec<f64>

Values of non-zero entries.

Implementations§

Source§

impl SparseMatrix

Source

pub fn new(rows: usize, cols: usize) -> Self

Create an empty sparse matrix.

Source

pub fn from_coo( rows: usize, cols: usize, entries: &[(usize, usize, f64)], ) -> Self

Build from coordinate list (row, col, val). Entries must be sorted by row.

Source

pub fn nnz(&self) -> usize

Number of non-zero entries.

Source

pub fn get(&self, r: usize, c: usize) -> f64

Get element (O(nnz per row) lookup).

Source

pub fn matvec(&self, x: &[f64]) -> Option<Vec<f64>>

Sparse matrix-vector multiply: y = A * x.

Source

pub fn transpose(&self) -> SparseMatrix

Transpose of the sparse matrix.

Source

pub fn norm_sq(&self) -> f64

Frobenius norm squared.

Trait Implementations§

Source§

impl Clone for SparseMatrix

Source§

fn clone(&self) -> SparseMatrix

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SparseMatrix

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.