Struct TriangularView 

pub struct TriangularView<'a, T: Scalar> { /* private fields */ }

A triangular matrix view over dense storage.

This is a logical view that treats the non-stored triangle as zeros. The underlying storage is a full dense matrix, but operations only access the stored triangle.

Example

use oxiblas_matrix::{Mat, triangular::{TriangularView, DiagonalKind}};
use oxiblas_matrix::packed::TriangularKind;

let mut m: Mat<f64> = Mat::eye(3);
m[(0, 1)] = 2.0;
m[(0, 2)] = 3.0;
m[(1, 2)] = 4.0;

// Create upper triangular view
let tri = TriangularView::new(m.as_ref(), TriangularKind::Upper, DiagonalKind::NonUnit);

// Access upper triangle
assert_eq!(tri.get(0, 1), Some(&2.0));
// Lower triangle returns zero
assert_eq!(tri.get(1, 0), None);

Implementations

impl<'a, T: Scalar> TriangularView<'a, T>

pub fn new(mat: MatRef<'a, T>, uplo: TriangularKind, diag: DiagonalKind) -> Self

Creates a new triangular view over a matrix.

Panics

Panics if the matrix is not square.

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 (upper/lower).

pub fn diag(&self) -> DiagonalKind

Returns the diagonal kind (unit/non-unit).

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

Returns true if element (row, col) is in the stored triangle.

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

Returns a reference to the element at (row, col).

Returns None if the element is in the non-stored triangle. For unit triangular matrices, diagonal elements return None (they are implicitly one).

pub fn as_inner(&self) -> MatRef<'a, T>

Returns the underlying matrix reference.

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

Returns a pointer to the matrix data.

pub fn row_stride(&self) -> usize

Returns the row stride.

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

where T: Zeroable,

Converts to a full dense matrix.

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

where T: Zeroable,

Converts to packed storage.

Trait Implementations

impl<'a, T: Clone + Scalar> Clone for TriangularView<'a, T>

fn clone(&self) -> TriangularView<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Copy + Scalar> Copy for TriangularView<'a, T>