Struct varpro::util::DiagMatrix

pub struct DiagMatrix<ScalarType, D>
where
    ScalarType: Scalar + ComplexField,
    D: Dim,
    DefaultAllocator: Allocator<ScalarType, D>,
{ /* private fields */ }

A square diagonal matrix with dynamic dimension. Off-diagonal entries are assumed zero. This internally stores only the diagonal elements

Types

ScalarType: the numeric type of the matrix

Implementations

impl<ScalarType, D> DiagMatrix<ScalarType, D>

where ScalarType: Scalar + ComplexField, D: Dim, DefaultAllocator: Allocator<ScalarType, D>,

pub fn ncols(&self) -> usize

get the number of columns of the matrix The matrix is square, so this is equal to the number of rows

pub fn nrows(&self) -> usize

get the number of rows of the matrix The matrix is square, so this is equal to the number of columns

pub fn size(&self) -> usize

the size (i.e. number of rows == number of cols) of this square matrix

pub fn from_real_field(diagonal: OVector<ScalarType::RealField, D>) -> Self

where DefaultAllocator: Allocator<<ScalarType as ComplexField>::RealField, D>,

Generate a square matrix containing the entries of the vector which contains only real field values of this (potentially) complex type

Trait Implementations

impl<ScalarType, D> Clone for DiagMatrix<ScalarType, D>

where ScalarType: Scalar + ComplexField + Clone, D: Dim + Clone, DefaultAllocator: Allocator<ScalarType, D>,

fn clone(&self) -> DiagMatrix<ScalarType, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ScalarType, D> Debug for DiagMatrix<ScalarType, D>

where ScalarType: Scalar + ComplexField + Debug, D: Dim + Debug, DefaultAllocator: Allocator<ScalarType, D>,

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

Formats the value using the given formatter.

impl<ScalarType, D> From<DiagMatrix<ScalarType, D>> for Weights<ScalarType, D>

where ScalarType: Scalar + ComplexField, D: Dim, DefaultAllocator: Allocator<ScalarType, D>,

create diagonal weights using the given diagonal matrix

fn from(diag: DiagMatrix<ScalarType, D>) -> Self

Converts to this type from the input type.

impl<ScalarType, D> From<Matrix<ScalarType, D, Const<1>, <DefaultAllocator as Allocator<ScalarType, D>>::Buffer>> for DiagMatrix<ScalarType, D>

where ScalarType: Scalar + ComplexField, D: Dim, DefaultAllocator: Allocator<ScalarType, D>,

Generate a square diagonal matrix from the given diagonal vector.

fn from(diagonal: OVector<ScalarType, D>) -> Self

Converts to this type from the input type.

impl<ScalarType, R, C, S> Mul<Matrix<ScalarType, R, C, S>> for &DiagMatrix<ScalarType, R>

where ScalarType: ClosedMul + Scalar + ComplexField, C: Dim, R: Dim, S: RawStorageMut<ScalarType, R, C>, DefaultAllocator: Allocator<ScalarType, R>,

Multiply this diagonal matrix from the left to a dynamically sized matrix.

Panics

Panics if the dimensions of the matrices do not fit for matrix multiplication

Result

The result of the matrix multiplication as a new dynamically sized matrix

type Output = Matrix<ScalarType, R, C, S>

The resulting type after applying the * operator.

fn mul(self, rhs: Matrix<ScalarType, R, C, S>) -> Self::Output

Performs the * operation.

impl<ScalarType, D> PartialEq for DiagMatrix<ScalarType, D>

where ScalarType: Scalar + ComplexField + PartialEq, D: Dim + PartialEq, DefaultAllocator: Allocator<ScalarType, D>,

fn eq(&self, other: &DiagMatrix<ScalarType, D>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<ScalarType, D> Eq for DiagMatrix<ScalarType, D>

where ScalarType: Scalar + ComplexField + Eq, D: Dim + Eq, DefaultAllocator: Allocator<ScalarType, D>,

impl<ScalarType, D> StructuralPartialEq for DiagMatrix<ScalarType, D>

where ScalarType: Scalar + ComplexField, D: Dim, DefaultAllocator: Allocator<ScalarType, D>,