Struct DiaMatrix

pub struct DiaMatrix<T> { /* private fields */ }

Diagonal (DIA) matrix

A sparse matrix format that stores diagonals, making it efficient for matrices with values concentrated on a small number of diagonals.

Implementations

impl<T> DiaMatrix<T>

where T: Clone + Copy + Zero + PartialEq,

pub fn new( data: Vec<Vec<T>>, offsets: Vec<isize>, shape: (usize, usize), ) -> SparseResult<Self>

Create a new DIA matrix from raw data

Arguments

• data - Diagonals data (n_diags x max(rows, cols))
• offsets - Diagonal offsets from the main diagonal
• shape - Tuple containing the matrix dimensions (rows, cols)

Returns

• A new DIA matrix

Examples

use scirs2_sparse::dia::DiaMatrix;

// Create a 3x3 sparse matrix with main diagonal and upper diagonal
let data = vec![
    vec![1.0, 2.0, 3.0], // Main diagonal
    vec![4.0, 5.0, 0.0], // Upper diagonal (k=1)
];
let offsets = vec![0, 1]; // Main diagonal and k=1
let shape = (3, 3);

let matrix = DiaMatrix::new(data, offsets, shape).unwrap();

pub fn empty(shape: (usize, usize)) -> Self

Create a new empty DIA matrix

Arguments

• shape - Tuple containing the matrix dimensions (rows, cols)

Returns

• A new empty DIA matrix

pub fn rows(&self) -> usize

Get the number of rows in the matrix

pub fn cols(&self) -> usize

Get the number of columns in the matrix

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

Get the shape (dimensions) of the matrix

pub fn nnz(&self) -> usize

Get the number of non-zero elements in the matrix

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

where T: Zero + Copy,

Convert to dense matrix (as Vec<Vec>)