Struct BandedArray 

pub struct BandedArray<T>
where
    T: AddAssign + Display,
{ /* private fields */ }

Banded array format for sparse matrices

The BandedArray format stores only the non-zero bands of a matrix. The data is stored in a 2D array where each row represents a diagonal and each column represents the matrix row.

For a matrix with lower bandwidth kl and upper bandwidth ku, the data array has shape (kl + ku + 1, n) where n is the number of matrix rows.

Implementations

impl<T> BandedArray<T>

where T: Float + Debug + Display + Copy + Zero + One + Send + Sync + 'static + AddAssign,

pub fn new( data: Array2<T>, kl: usize, ku: usize, shape: (usize, usize), ) -> SparseResult<Self>

Create a new banded array

pub fn zeros(shape: (usize, usize), kl: usize, ku: usize) -> Self

Create a new zero banded array

pub fn eye(n: usize, kl: usize, ku: usize) -> Self

Create a new identity banded array

pub fn from_triplets( rows: &[usize], cols: &[usize], data: &[T], shape: (usize, usize), kl: usize, ku: usize, ) -> SparseResult<Self>

Create from triplet format (row, col, data)

pub fn tridiagonal(diag: &[T], lower: &[T], upper: &[T]) -> SparseResult<Self>

Create tridiagonal matrix

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

Check if an element is within the band structure

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

Set an element (unchecked for performance)

pub fn set_direct( &mut self, row: usize, col: usize, value: T, ) -> SparseResult<()>

Set an element with bounds and band checking

pub fn data(&self) -> &Array2<T>

Get the raw band data

pub fn data_mut(&mut self) -> &mut Array2<T>

Get mutable reference to the raw band data

pub fn kl(&self) -> usize

Get lower bandwidth

pub fn ku(&self) -> usize

Get upper bandwidth

pub fn solve(&self, b: &ArrayView1<'_, T>) -> SparseResult<Array1<T>>

Solve a banded linear system using LU decomposition

pub fn lu_decomposition( &self, ) -> SparseResult<(BandedArray<T>, BandedArray<T>, Vec<usize>)>

LU decomposition for banded matrices

pub fn forward_substitution( &self, b: &ArrayView1<'_, T>, ) -> SparseResult<Array1<T>>

Forward substitution for lower triangular banded matrix

pub fn back_substitution( &self, b: &ArrayView1<'_, T>, ) -> SparseResult<Array1<T>>

Back substitution for upper triangular banded matrix

pub fn matvec(&self, x: &ArrayView1<'_, T>) -> SparseResult<Array1<T>>

Matrix-vector multiplication optimized for banded structure

impl<T> BandedArray<T>

where T: Float + Debug + Display + Copy + Zero + One + Send + Sync + 'static + AddAssign,

pub fn matmul(&self, other: &BandedMatrix<T>) -> SparseResult<BandedMatrix<T>>

Matrix multiplication (for legacy API compatibility)

pub fn from_dense(dense: &Array2<T>, kl: usize, ku: usize) -> SparseResult<Self>

Create banded matrix from dense array

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

Get a mutable reference to an element (legacy API)

pub fn set(&mut self, row: usize, col: usize, value: T) -> SparseResult<()>

Set element (legacy API)

Trait Implementations

impl<T> Clone for BandedArray<T>

where T: AddAssign + Display + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for BandedArray<T>

where T: AddAssign + Display + Debug,

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

Formats the value using the given formatter.

impl<T> SparseArray<T> for BandedArray<T>

where T: Float + Debug + Display + Copy + Zero + One + Send + Sync + 'static + AddAssign,

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

Returns the shape of the sparse array.

fn nnz(&self) -> usize

Returns the number of stored (non-zero) elements.

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

Get a value at the specified position.

fn find(&self) -> (Array1<usize>, Array1<usize>, Array1<T>)

Return the indices and values of the nonzero elements.

fn to_array(&self) -> Array2<T>

Returns a view of the sparse array as a dense ndarray.

fn dot( &self, other: &dyn SparseArray<T>, ) -> SparseResult<Box<dyn SparseArray<T>>>

Matrix multiplication.

fn dtype(&self) -> &str

Returns the data type of the sparse array.

fn toarray(&self) -> Array2<T>

Returns a dense copy of the sparse array.

fn as_any(&self) -> &dyn Any

Returns the concrete type of the array for downcasting.

fn to_coo(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in COO format.

fn to_csr(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in CSR format.

fn to_csc(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in CSC format.

fn to_dok(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in DOK format.

fn to_lil(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in LIL format.

fn to_dia(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in DIA format.

fn to_bsr(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Returns a sparse array in BSR format.

fn add( &self, other: &dyn SparseArray<T>, ) -> SparseResult<Box<dyn SparseArray<T>>>

Element-wise addition.

fn sub( &self, other: &dyn SparseArray<T>, ) -> SparseResult<Box<dyn SparseArray<T>>>

Element-wise subtraction.

fn mul( &self, other: &dyn SparseArray<T>, ) -> SparseResult<Box<dyn SparseArray<T>>>

Element-wise multiplication.

fn div( &self, other: &dyn SparseArray<T>, ) -> SparseResult<Box<dyn SparseArray<T>>>

Element-wise division.

fn dot_vector(&self, other: &ArrayView1<'_, T>) -> SparseResult<Array1<T>>

Matrix-vector multiplication.

fn transpose(&self) -> SparseResult<Box<dyn SparseArray<T>>>

Transpose the sparse array.

fn copy(&self) -> Box<dyn SparseArray<T>>

Return a copy of the sparse array with the specified elements.

fn set(&mut self, i: usize, j: usize, value: T) -> SparseResult<()>

Set a value at the specified position.

fn eliminate_zeros(&mut self)

Eliminate zeros from the sparse array.

fn sort_indices(&mut self)

Sort indices of the sparse array.

fn sorted_indices(&self) -> Box<dyn SparseArray<T>>

Return a sorted copy of this sparse array.

fn has_sorted_indices(&self) -> bool

Check if indices are sorted.

fn sum(&self, axis: Option<usize>) -> SparseResult<SparseSum<T>>

Sum the sparse array elements.

fn max(&self) -> T

Compute the maximum value of the sparse array elements.

fn min(&self) -> T

Compute the minimum value of the sparse array elements.

fn slice( &self, row_range: (usize, usize), col_range: (usize, usize), ) -> SparseResult<Box<dyn SparseArray<T>>>

Return a slice of the sparse array.

fn get_indptr(&self) -> Option<&Array1<usize>>

Returns the indptr array for CSR/CSC formats. For formats that don’t have indptr, returns None.

fn indptr(&self) -> Option<&Array1<usize>>

Returns the indptr array for CSR/CSC formats. For formats that don’t have indptr, returns None.