Skip to main content

BandedMatrix

Struct BandedMatrix 

Source
pub struct BandedMatrix {
    pub rows: usize,
    pub cols: usize,
    pub kl: usize,
    pub ku: usize,
    pub band: Vec<Vec<f64>>,
}
Expand description

A banded matrix stored as an array of diagonals. Diagonals are indexed from -(rows-1) to +(cols-1); offset = k means superdiagonal k.

Fields§

§rows: usize

Number of rows.

§cols: usize

Number of columns.

§kl: usize

Lower bandwidth (number of sub-diagonals).

§ku: usize

Upper bandwidth (number of super-diagonals).

§band: Vec<Vec<f64>>

Storage: (kl + ku + 1) × cols, band[k][j] = A[j - ku + k][j].

Implementations§

Source§

impl BandedMatrix

Source

pub fn zero(rows: usize, cols: usize, kl: usize, ku: usize) -> Self

Create a zero banded matrix.

Source

pub fn get(&self, r: usize, c: usize) -> f64

Get A[r][c] (returns 0 if outside band).

Source

pub fn set(&mut self, r: usize, c: usize, v: f64)

Set A[r][c] (panics if outside band).

Source

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

Matrix-vector multiply: y = A * x.

Source

pub fn diagonal(&self) -> Vec<f64>

Diagonal entries (min(rows, cols) elements).

Trait Implementations§

Source§

impl Clone for BandedMatrix

Source§

fn clone(&self) -> BandedMatrix

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 Debug for BandedMatrix

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