Struct BsrMatrix

Source
pub struct BsrMatrix<T> { /* private fields */ }
Expand description

Block Sparse Row (BSR) matrix

A sparse matrix format that stores blocks in compressed sparse row format, making it efficient for block-structured matrices.

Implementations§

Source§

impl<T> BsrMatrix<T>
where T: Clone + Copy + Zero + PartialEq,

Source

pub fn new( shape: (usize, usize), block_size: (usize, usize), ) -> SparseResult<Self>

Create a new BSR matrix

§Arguments
  • shape - Tuple containing the matrix dimensions (rows, cols)
  • block_size - Tuple containing the block dimensions (r, c)
§Returns
  • A new empty BSR matrix
§Examples
use scirs2_sparse::bsr::BsrMatrix;

// Create a 6x6 sparse matrix with 2x2 blocks
let matrix = BsrMatrix::<f64>::new((6, 6), (2, 2)).unwrap();
Source

pub fn from_blocks( data: Vec<Vec<Vec<T>>>, indices: Vec<Vec<usize>>, indptr: Vec<usize>, shape: (usize, usize), block_size: (usize, usize), ) -> SparseResult<Self>

Create a BSR matrix from block data

§Arguments
  • data - Block data (blocks stored row by row)
  • indices - Column indices for each block
  • indptr - Row pointers
  • shape - Tuple containing the matrix dimensions (rows, cols)
  • block_size - Tuple containing the block dimensions (r, c)
§Returns
  • A new BSR matrix
Source

pub fn rows(&self) -> usize

Get the number of rows in the matrix

Source

pub fn cols(&self) -> usize

Get the number of columns in the matrix

Source

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

Get the shape (dimensions) of the matrix

Source

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

Get the block size

Source

pub fn nnz_blocks(&self) -> usize

Get the number of non-zero blocks in the matrix

Source

pub fn nnz(&self) -> usize

Get the number of non-zero elements in the matrix

Source

pub fn to_dense(&self) -> Vec<Vec<T>>
where T: Zero + Copy,

Convert to dense matrix (as Vec<Vec>)

Auto Trait Implementations§

§

impl<T> Freeze for BsrMatrix<T>

§

impl<T> RefUnwindSafe for BsrMatrix<T>
where T: RefUnwindSafe,

§

impl<T> Send for BsrMatrix<T>
where T: Send,

§

impl<T> Sync for BsrMatrix<T>
where T: Sync,

§

impl<T> Unpin for BsrMatrix<T>
where T: Unpin,

§

impl<T> UnwindSafe for BsrMatrix<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V