Struct TriangularMat 

pub struct TriangularMat<T: Scalar> { /* private fields */ }

Triangular matrix using packed storage.

This is a wrapper around PackedMat that provides triangular matrix semantics with efficient packed storage.

Implementations

impl<T: Scalar> TriangularMat<T>

pub fn zeros(n: usize, uplo: TriangularKind, diag: DiagonalKind) -> Self

where T: Zeroable,

Creates a new triangular matrix filled with zeros.

pub fn unit_zeros(n: usize, uplo: TriangularKind) -> Self

where T: Zeroable,

Creates a unit triangular matrix (identity-like).

The diagonal is implicitly one and not stored.

pub fn from_packed(packed: PackedMat<T>, diag: DiagonalKind) -> Self

Creates from a packed matrix.

pub fn from_dense( mat: &MatRef<'_, T>, uplo: TriangularKind, diag: DiagonalKind, ) -> Self

where T: Zeroable,

Creates from a dense matrix view.

pub fn dim(&self) -> usize

Returns the matrix dimension.

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

Returns the shape (n, n).

pub fn uplo(&self) -> TriangularKind

Returns the triangular kind.

pub fn diag(&self) -> DiagonalKind

Returns the diagonal kind.

pub fn len(&self) -> usize

Returns the packed storage length.

pub fn is_empty(&self) -> bool

Returns true if empty.

pub fn in_triangle(&self, row: usize, col: usize) -> bool

Returns true if element is in the stored triangle.

pub fn get(&self, row: usize, col: usize) -> Option<&T>

Returns a reference to element.

For unit triangular matrices, returns None for diagonal elements.

pub fn get_mut(&mut self, row: usize, col: usize) -> Option<&mut T>

Returns a mutable reference to element.

pub fn set(&mut self, row: usize, col: usize, value: T)

Sets an element.

Panics

Panics if (row, col) is outside the stored triangle, or if setting the diagonal on a unit triangular matrix.

pub fn as_ptr(&self) -> *const T

Returns a pointer to the packed data.

pub fn as_mut_ptr(&mut self) -> *mut T

Returns a mutable pointer to the packed data.

pub fn as_slice(&self) -> &[T]

Returns the packed data as a slice.

pub fn as_slice_mut(&mut self) -> &mut [T]

Returns the packed data as a mutable slice.

pub fn as_packed(&self) -> &PackedMat<T>

Returns a reference to the underlying packed matrix.

pub fn as_packed_mut(&mut self) -> &mut PackedMat<T>

Returns a mutable reference to the underlying packed matrix.

pub fn to_dense(&self) -> Mat<T>

where T: Zeroable,

Converts to a full dense matrix.

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

Returns the diagonal elements.

For unit triangular matrices, returns a vector of ones.

pub fn set_diagonal(&mut self, diag: &[T])

Sets the diagonal elements.

Panics

Panics for unit triangular matrices.

pub fn fill(&mut self, value: T)

Fills the stored triangle with a value.

pub fn scale(&mut self, alpha: T)

Scales the stored triangle by a scalar.

pub fn transpose(&self) -> Self

where T: Zeroable,

Returns the transpose (flips upper/lower).

Trait Implementations

impl<T: Clone + Scalar> Clone for TriangularMat<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Scalar + Debug> Debug for TriangularMat<T>

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

Formats the value using the given formatter.