Skip to main content

CsrMatrix

Struct CsrMatrix 

Source
pub struct CsrMatrix<T: Real = f64> {
    pub n_cols: usize,
    pub row_ptr: Vec<usize>,
    pub col_idx: Vec<u32>,
    pub val: Vec<T>,
}
Expand description

Sparse matrix in compressed sparse row (CSR) format.

Fields§

§n_cols: usize

Number of columns n.

§row_ptr: Vec<usize>

Row pointers, length m + 1; row i occupies row_ptr[i]..row_ptr[i + 1].

§col_idx: Vec<u32>

Column index of each stored entry, strictly increasing within a row.

§val: Vec<T>

Value of each stored entry; finite and nonzero.

Implementations§

Source§

impl<T: Real> CsrMatrix<T>

Source

pub fn from_raw_parts( n_cols: usize, row_ptr: Vec<usize>, col_idx: Vec<u32>, val: Vec<T>, ) -> Result<Self, SparseError>

Builds a matrix from raw compressed arrays, validating every invariant.

Source

pub fn n_rows(&self) -> usize

Number of rows m.

Source

pub fn n_cols(&self) -> usize

Number of columns n.

Source

pub fn nnz(&self) -> usize

Number of stored entries.

Source

pub fn row(&self, i: Row) -> (&[u32], &[T])

Column indices and values of row i.

Source

pub fn get(&self, i: Row, j: Col) -> T

Entry a_ij, or 0 if not stored; O(log nnz(row i)).

Source

pub fn to_csc(&self) -> CscMatrix<T>

The same matrix in column-wise (CSC) storage, by Algorithm T.

Source

pub fn check_invariants(&self) -> Result<(), SparseError>

Checks invariants (C1)–(C4).

Trait Implementations§

Source§

impl<T: Clone + Real> Clone for CsrMatrix<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Real> Debug for CsrMatrix<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: PartialEq + Real> PartialEq for CsrMatrix<T>

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<T: PartialEq + Real> StructuralPartialEq for CsrMatrix<T>

Auto Trait Implementations§

§

impl<T> Forget for CsrMatrix<T>

§

impl<T> Freeze for CsrMatrix<T>
where Vec<T>: Freeze,

§

impl<T> RefUnwindSafe for CsrMatrix<T>
where Vec<T>: RefUnwindSafe,

§

impl<T> Send for CsrMatrix<T>
where Vec<T>: Send,

§

impl<T> Sync for CsrMatrix<T>
where Vec<T>: Sync,

§

impl<T> Unpin for CsrMatrix<T>
where Vec<T>: Unpin,

§

impl<T> UnsafeUnpin for CsrMatrix<T>
where Vec<T>: UnsafeUnpin,

§

impl<T> UnwindSafe for CsrMatrix<T>
where Vec<T>: UnwindSafe,

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> Imply<T> for U
where T: ?Sized, U: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.