Skip to main content

SparseMatrix

Struct SparseMatrix 

Source
pub struct SparseMatrix<S: Scalar + Entity> { /* private fields */ }
Expand description

CSC sparse matrix wrapping faer’s SparseColMat.

Trait relationship: SparseMatrix<S> does not currently implement the crate::Matrix trait. Sparse-aware solvers in this crate (crate::iterative, crate::preconditioner) consume &SparseMatrix<S> concretely. Whether sparse should join the crate::Matrix trait is an open foundation question deferred per Foundation Spec §7 #5 — see F-MATRIX-SHAPE in docs/internal-followups.md.

Implementations§

Source§

impl<S: Scalar + SimpleEntity + Conjugate<Canonical = S> + ComplexField> SparseMatrix<S>

Source

pub fn from_triplets( nrows: usize, ncols: usize, triplets: &[(usize, usize, S)], ) -> Result<Self, LinalgError>

Build from COO (triplet) format.

Duplicate entries at the same (row, col) are summed.

Source

pub fn nrows(&self) -> usize

Number of rows.

Source

pub fn ncols(&self) -> usize

Number of columns.

Source

pub fn nnz(&self) -> usize

Number of structural non-zeros.

Source

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

Element access (returns zero for missing entries).

Source

pub fn to_dense(&self) -> DenseMatrix<S>

Convert to dense matrix.

Source

pub fn col_ptrs(&self) -> Vec<usize>

CSC column pointers.

Source

pub fn row_indices(&self) -> Vec<usize>

CSC row indices.

Source

pub fn values(&self) -> Vec<S>

CSC values.

Source

pub fn mul_vec(&self, x: &[S]) -> Result<Vec<S>, LinalgError>

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

Source

pub fn transpose(&self) -> Result<SparseMatrix<S>, LinalgError>

Transpose of the sparse matrix.

Auto Trait Implementations§

§

impl<S> Freeze for SparseMatrix<S>
where <<S as Entity>::Group as ForType>::FaerOf<Vec<<S as Entity>::Unit>>: Freeze,

§

impl<S> RefUnwindSafe for SparseMatrix<S>
where <<S as Entity>::Group as ForType>::FaerOf<Vec<<S as Entity>::Unit>>: RefUnwindSafe,

§

impl<S> Send for SparseMatrix<S>

§

impl<S> Sync for SparseMatrix<S>

§

impl<S> Unpin for SparseMatrix<S>
where <<S as Entity>::Group as ForType>::FaerOf<Vec<<S as Entity>::Unit>>: Unpin,

§

impl<S> UnsafeUnpin for SparseMatrix<S>
where <<S as Entity>::Group as ForType>::FaerOf<Vec<<S as Entity>::Unit>>: UnsafeUnpin,

§

impl<S> UnwindSafe for SparseMatrix<S>
where <<S as Entity>::Group as ForType>::FaerOf<Vec<<S as Entity>::Unit>>: 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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V