Struct totsu::MatBuild

pub struct MatBuild<L: LinAlgEx> { /* private fields */ }

Matrix builder

Matrix struct which owns a Vec of data array and is able to be converted as totsu_core::MatOp. This struct relies on dynamic heap allocation.

Implementations

impl<L: LinAlgEx> MatBuild<L>

pub fn new(typ: MatType) -> Self

Creates an instance.

Returns the MatBuild instance with zero data.

• typ is Matrix type and size.

pub fn size(&self) -> (usize, usize)

Size of the matrix.

Returns a tuple of a number of rows and columns.

pub fn as_op(&self) -> MatOp<'_, L>

Converted as totsu_core::MatOp.

Returns the totsu_core::MatOp borrowing the internal data array.

pub fn is_sympack(&self) -> bool

Checks if symmetric packed.

Returns true if MatType::SymPack, false otherwise.

pub fn set_by_fn<M>(&mut self, func: M)where
    M: FnMut(usize, usize) -> L::F,

Data by a function.

• func takes a row and a column of the matrix and returns data of each element.

pub fn by_fn<M>(self, func: M) -> Selfwhere
    M: FnMut(usize, usize) -> L::F,

Builder pattern of MatBuild::set_by_fn.

pub fn set_iter_colmaj<T, I>(&mut self, iter: T)where
    T: IntoIterator<Item = I>,
    I: Deref<Target = L::F>,

Data by an iterator in column-major.

• iter iterates matrix data in column-major.

pub fn iter_colmaj<T, I>(self, iter: T) -> Selfwhere
    T: IntoIterator<Item = I>,
    I: Deref<Target = L::F>,

Builder pattern of MatBuild::set_iter_colmaj.

pub fn set_iter_rowmaj<T, I>(&mut self, iter: T)where
    T: IntoIterator<Item = I>,
    I: Deref<Target = L::F>,

Data by an iterator in row-major.

• iter iterates matrix data in row-major.

pub fn iter_rowmaj<T, I>(self, iter: T) -> Selfwhere
    T: IntoIterator<Item = I>,
    I: Deref<Target = L::F>,

Builder pattern of MatBuild::set_iter_rowmaj.

pub fn set_scale(&mut self, alpha: L::F)

Scales by \(\alpha\).

• alpha is a scalar \(\alpha\).

pub fn scale(self, alpha: L::F) -> Self

Builder pattern of MatBuild::set_scale.

pub fn set_scale_nondiag(&mut self, alpha: L::F)

Scales by \(\alpha\) except diagonal elements.

• alpha is a scalar \(\alpha\).

pub fn scale_nondiag(self, alpha: L::F) -> Self

Builder pattern of MatBuild::set_scale_nondiag.

pub fn set_reshape_colvec(&mut self)

Reshapes the internal data array as it is into a one-column matrix.

pub fn reshape_colvec(self) -> Self

Builder pattern of MatBuild::set_reshape_colvec.

pub fn set_sqrt(&mut self, eps_zero: L::F)

Calculates and converts the matrix \(A\) to \(A^{\frac12}\).

The matrix shall belong to MatType::SymPack.

• eps_zero should be the same value as totsu_core::solver::SolverParam::eps_zero.

pub fn sqrt(self, eps_zero: L::F) -> Self

Builder pattern of MatBuild::set_sqrt.

Trait Implementations

impl<L: LinAlgEx> AsMut<[<L as LinAlg>::F]> for MatBuild<L>

fn as_mut(&mut self) -> &mut [L::F]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<L: LinAlgEx> AsRef<[<L as LinAlg>::F]> for MatBuild<L>

fn as_ref(&self) -> &[L::F]

Converts this type into a shared reference of the (usually inferred) input type.

impl<L: Clone + LinAlgEx> Clone for MatBuild<L>where
    L::F: Clone,

fn clone(&self) -> MatBuild<L>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<L: LinAlgEx> Debug for MatBuild<L>where
    L::F: Float + LowerExp,

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

Formats the value using the given formatter.

impl<L: LinAlgEx> Display for MatBuild<L>where
    L::F: Float + LowerExp,

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

Formats the value using the given formatter.

impl<L: LinAlgEx> Index<(usize, usize)> for MatBuild<L>

type Output = <L as LinAlg>::F

The returned type after indexing.

fn index(&self, index: (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<L: LinAlgEx> IndexMut<(usize, usize)> for MatBuild<L>

fn index_mut(&mut self, index: (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.