Skip to main content

DiaMatrix

Struct DiaMatrix 

Source
pub struct DiaMatrix<T> {
    pub nrows: usize,
    pub ncols: usize,
    pub offsets: Vec<i64>,
    pub diags: Vec<Vec<T>>,
}
Expand description

Diagonal storage format for banded / multi-diagonal sparse matrices.

Stores explicitly named diagonals. Diagonal offset = 0 is the main diagonal, offset > 0 is superdiagonal, offset < 0 is subdiagonal.

§Layout

Each diagonal d with offset k has length min(nrows, ncols, nrows - max(0,-k), ncols - max(0,k)). They are stored as flat Vec<T> with the first valid element at position 0.

Fields§

§nrows: usize

Number of rows.

§ncols: usize

Number of columns.

§offsets: Vec<i64>

Diagonal offsets (may be negative).

§diags: Vec<Vec<T>>

Diagonal data; diags[i] has length equal to the diagonal with offsets[i].

Implementations§

Source§

impl<T> DiaMatrix<T>
where T: Clone + Copy + Zero + SparseElement + Debug,

Source

pub fn new( nrows: usize, ncols: usize, offsets: Vec<i64>, diags: Vec<Vec<T>>, ) -> SparseResult<Self>

Create a DiaMatrix from explicit diagonals.

§Arguments
  • nrows - Number of rows.
  • ncols - Number of columns.
  • offsets - Diagonal offsets.
  • diags - One Vec<T> per offset.
Source

pub fn from_csr(csr: &CsrMatrix<T>) -> SparseResult<Self>

Construct from a CSR matrix by extracting its diagonals.

Source

pub fn spmv(&self, x: &[T]) -> SparseResult<Vec<T>>
where T: Add<Output = T> + Mul<Output = T>,

SpMV: y = self * x.

Source

pub fn to_csr(&self) -> SparseResult<CsrMatrix<T>>

Convert to CSR format.

Source

pub fn nnz(&self) -> usize

Number of non-zeros (sum of diagonal lengths).

Trait Implementations§

Source§

impl<T: Clone> Clone for DiaMatrix<T>

Source§

fn clone(&self) -> DiaMatrix<T>

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<T: Debug> Debug for DiaMatrix<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for DiaMatrix<T>

§

impl<T> RefUnwindSafe for DiaMatrix<T>
where T: RefUnwindSafe,

§

impl<T> Send for DiaMatrix<T>
where T: Send,

§

impl<T> Sync for DiaMatrix<T>
where T: Sync,

§

impl<T> Unpin for DiaMatrix<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for DiaMatrix<T>

§

impl<T> UnwindSafe for DiaMatrix<T>
where 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> 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> 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.
Source§

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

Source§

fn vzip(self) -> V