Skip to main content

SparseMatrix

Struct SparseMatrix 

Source
pub struct SparseMatrix {
    pub n: usize,
    /* private fields */
}
Expand description

Sparse matrix in CSR (compressed sparse row) format.

Triplets added via add() are stored uncompressed. Call compress() once to convert to canonical CSR (summing duplicates, sorting by row/col). After compression, matvec/matvec_into use the CSR structure.

Fields§

§n: usize

Implementations§

Source§

impl SparseMatrix

Source

pub fn new(n: usize) -> Self

Source

pub fn add(&mut self, row: usize, col: usize, val: f64)

Add a triplet (duplicates allowed, summed on compress).

Source

pub fn compress(&mut self)

Convert COO triplets to canonical CSR (sum duplicates, sort). Idempotent: safe to call multiple times.

Source

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

Matrix-vector product y = A*x (requires compress() first).

Source

pub fn matvec_into(&self, x: &[f64], y: &mut [f64])

Matrix-vector product into a caller-provided buffer (requires compress() first).

Source

pub fn matvec_diag(&self, i: usize) -> f64

Diagonal entry of row i (requires compress() first).

Source

pub fn csr_data(&self) -> (&[usize], &[usize], &[f64])

Get CSR data for external solvers.

Source

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

Get CSR row pointers (for diagnostics).

Source

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

Get CSR column indices (for diagnostics).

Source

pub fn csr_vals(&self) -> &[f64]

Get CSR values (for diagnostics).

Source

pub fn frobenius_norm(&self) -> f64

Frobenius norm of the matrix.

Source

pub fn symmetry_max_error(&self) -> f64

Maximum symmetry error max_{i<j} |A_ij - A_ji|.

Source

pub fn is_symmetric(&self, tol: f64) -> bool

Check if matrix is symmetric within tolerance.

Source

pub fn get(&self, row: usize, col: usize) -> f64

Get value at (row, col) - requires compress().

Source

pub fn triplets(&self) -> (&[usize], &[usize], &[f64])

Get the raw COO triplets (for diagnostics/export).

Trait Implementations§

Source§

impl Clone for SparseMatrix

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

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.