Struct CsrMatrixSet 

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

A collection of CSR matrices stored efficiently in a single data structure.

This structure is designed to store multiple CSR matrices with different dimensions in a compact format. It’s particularly useful for applications that need to manage many sparse matrices with similar sparsity patterns or for systems that generate multiple matrices during computation.

Format

The set stores all matrices in contiguous arrays:

• col_indices: Column indices for all matrices concatenated
• values: Non-zero values for all matrices concatenated
• row_offsets: Row offsets for all matrices concatenated
• ncols: Number of columns for each individual matrix
• partition: Metadata to locate each matrix within the concatenated data

Examples

use algebra_sparse::CsrMatrixSet;
use algebra_sparse::traits::IntoView;
use algebra_sparse::CsrMatrixSetMethods;

let mut set: CsrMatrixSet<f64> = CsrMatrixSet::default();

// Add first matrix to the set
{
    let mut builder1 = set.new_matrix(3, 1e-10);
    builder1.new_row().push(0, 1.0);
} // builder1 is dropped here and matrix is added to set

// Add second matrix to the set
{
    let mut builder2 = set.new_matrix(2, 1e-10);
    builder2.new_row().push(1, 3.0);
} // builder2 is dropped here and matrix is added to set

println!("Set contains {} matrices", (&set).len());

Implementations

impl<T: Real> CsrMatrixSet<T>

pub fn clear(&mut self)

Clears all matrices from the set.

This removes all data and allows reuse of the set.

pub fn new_matrix( &mut self, ncol: usize, zero_threshold: T, ) -> CsrMatrixBuilder<'_, T>

Creates a new matrix builder for this set.

The matrix will be automatically added to the set when the builder is dropped.

Arguments

• ncol - Number of columns for the new matrix
• zero_threshold - Values below this threshold are filtered out

Returns

A CsrMatrixBuilder for constructing the new matrix

impl<T> CsrMatrixSet<T>

pub fn get(&self, index: usize) -> CsrMatrixView<'_, T>

Returns the view of the matrix at the given index.

Arguments

• index - Index of the matrix to retrieve

Returns

A CsrMatrixView representing the requested matrix

Panics

Panics if the index is out of bounds

pub fn as_view(&self) -> CsrMatrixSetView<'_, T>

Returns a view of the entire matrix set.

Trait Implementations

impl<T: Clone> Clone for CsrMatrixSet<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Default for CsrMatrixSet<T>

fn default() -> Self

Creates a new empty CSR matrix set.

impl<'a, T> IntoView for &'a CsrMatrixSet<T>

type View = CsrMatrixSetView<'a, T>

The view type produced by this trait.

fn into_view(self) -> Self::View

Converts the type into an immutable view.