Struct DiagonalBlockMatrixView 

pub struct DiagonalBlockMatrixView<'a, T> { /* private fields */ }

An immutable view of a block diagonal matrix.

This provides efficient read-only access to block diagonal matrix data without allocation. Views are commonly used for matrix operations and can be easily created from block diagonal matrices.

Examples

use algebra_sparse::DiagonalBlockMatrix;
use algebra_sparse::traits::IntoView;

let matrix = DiagonalBlockMatrix::from_block_values(vec![1.0, 2.0, 3.0, 4.0], &[2, 2]);
let view = matrix.into_view();

println!("Number of blocks: {}", view.num_blocks());
println!("Matrix shape: {}x{}", view.nrows(), view.ncols());

Implementations

impl<'a, T> DiagonalBlockMatrixView<'a, T>

where T: RealField,

pub fn from_parts_unchecked( values: &'a [T], block_row_offsets: &'a [usize], block_element_offsets: &'a [usize], ) -> Self

Creates a block diagonal matrix view from raw parts without checking validity.

Safety

This function does not validate that the provided parts form a valid block diagonal matrix. Invalid parts may cause undefined behavior when accessing the matrix.

Arguments

• values - All block elements stored contiguously
• block_row_offsets - Row offset array for each block
• block_element_offsets - Element offset array for each block

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

pub fn num_blocks(&self) -> usize

pub fn nrows(&self) -> usize

pub fn ncols(&self) -> usize

pub fn get_block_size(&self, block_index: usize) -> usize

Get the size of a block

Panics

Panics if the block_index is out of bounds.

pub fn get_block_row_start(&self, block_index: usize) -> usize

pub fn get_block_row_range(&self, block_index: usize) -> Range<usize>

Get the range of rows for the given block index.

pub fn view_block(&self, block_index: usize) -> DMatrixView<'_, T>

Get the block matrix at the given index as a view.

Panics

Panics if the block_index is out of bounds.

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

Trait Implementations

impl<'a, T: Clone> Clone for DiagonalBlockMatrixView<'a, T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Real> Mul<DiagonalBlockMatrixView<'a, T>> for CsrMatrixView<'a, T>

type Output = CsrMatrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: DiagonalBlockMatrixView<'a, T>) -> Self::Output

Performs the * operation.

impl<'a, T: Real> Mul<Matrix<T, Dyn, Const<1>, VecStorage<T, Dyn, Const<1>>>> for DiagonalBlockMatrixView<'a, T>

type Output = Matrix<T, Dyn, Const<1>, VecStorage<T, Dyn, Const<1>>>

The resulting type after applying the * operator.

fn mul(self, rhs: DVector<T>) -> DVector<T>

Performs the * operation.

impl<'a, T: Real> Mul<Matrix<T, Dyn, Const<1>, ViewStorage<'a, T, Dyn, Const<1>, Const<1>, Dyn>>> for DiagonalBlockMatrixView<'a, T>

type Output = Matrix<T, Dyn, Const<1>, VecStorage<T, Dyn, Const<1>>>

The resulting type after applying the * operator.

fn mul(self, rhs: DVectorView<'a, T>) -> DVector<T>

Performs the * operation.

impl<'a, T: Real> Mul<Matrix<T, Dyn, Dyn, ViewStorage<'a, T, Dyn, Dyn, Const<1>, Dyn>>> for DiagonalBlockMatrixView<'a, T>

type Output = Matrix<T, Dyn, Dyn, VecStorage<T, Dyn, Dyn>>

The resulting type after applying the * operator.

fn mul(self, rhs: DMatrixView<'a, T>) -> Self::Output

Performs the * operation.

impl<'a, T: Copy> Copy for DiagonalBlockMatrixView<'a, T>