SparseMatrix

Struct SparseMatrix 

Source
pub struct SparseMatrix<F> { /* private fields */ }
Expand description

A sparse matrix implementation using the Compressed Sparse Row (CSR) format.

Implementations§

Source§

impl<F: Field> SparseMatrix<F>

Source

pub fn new( row_offsets: Vec<usize>, col_indices: Vec<usize>, values: Vec<F>, num_cols: usize, ) -> Self

Creates a new sparse matrix from its CSR components.

Source

pub fn new_rows_cols(num_rows: usize, num_cols: usize) -> SparseMatrix<F>

Creates an empty sparse matrix with the specified dimensions.

Source

pub fn write(&mut self, row: usize, col: usize, val: F)

Writes a value to the specified position in the matrix.

§Panics
  • If row or column indices are out of bounds
  • If attempting to write a zero value

Trait Implementations§

Source§

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

Source§

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

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<F: Debug> Debug for SparseMatrix<F>

Source§

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

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

impl<F: Default> Default for SparseMatrix<F>

Source§

fn default() -> SparseMatrix<F>

Returns the “default value” for a type. Read more
Source§

impl<F: Field + Display> Display for SparseMatrix<F>

Source§

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

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

impl<F: Field> Mul<&SparseMatrix<F>> for &SparseMatrix<F>

Source§

fn mul(self, rhs: &SparseMatrix<F>) -> Self::Output

Performs element-wise (Hadamard) matrix multiplication.

§Panics

If matrix dimensions don’t match.

Source§

type Output = SparseMatrix<F>

The resulting type after applying the * operator.
Source§

impl<F: Field> Mul<&Vec<F>> for &SparseMatrix<F>

Source§

fn mul(self, rhs: &Vec<F>) -> Self::Output

Performs matrix-vector multiplication.

§Panics

If the vector length doesn’t match the matrix column count.

Source§

type Output = Vec<F>

The resulting type after applying the * operator.
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

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

Source§

impl<F> StructuralPartialEq for SparseMatrix<F>

Auto Trait Implementations§

§

impl<F> Freeze for SparseMatrix<F>

§

impl<F> RefUnwindSafe for SparseMatrix<F>
where F: RefUnwindSafe,

§

impl<F> Send for SparseMatrix<F>
where F: Send,

§

impl<F> Sync for SparseMatrix<F>
where F: Sync,

§

impl<F> Unpin for SparseMatrix<F>
where F: Unpin,

§

impl<F> UnwindSafe for SparseMatrix<F>
where F: 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> 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> 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> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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