Skip to main content

BlockCSR

Struct BlockCSR 

Source
pub struct BlockCSR<T> {
    pub nrows: usize,
    pub ncols: usize,
    pub block_rows: usize,
    pub block_cols: usize,
    pub num_block_rows: usize,
    pub num_block_cols: usize,
    pub indptr: Vec<usize>,
    pub block_col_indices: Vec<usize>,
    pub data: Vec<T>,
}
Expand description

Block Compressed Sparse Row (BCSR / BSR) format.

The matrix is divided into (r × c) blocks. Only blocks containing at least one non-zero are stored. Internally each stored block is a dense r * c array.

§When to use

Use BlockCSR when the sparse pattern has a natural block structure (e.g., FEM stiffness matrices, graph problems with vector unknowns per node). Dense block kernels (GEMV) run much faster than scalar scatter operations.

Fields§

§nrows: usize

Matrix rows.

§ncols: usize

Matrix cols.

§block_rows: usize

Block row size.

§block_cols: usize

Block col size.

§num_block_rows: usize

Number of block rows = ceil(nrows / block_rows).

§num_block_cols: usize

Number of block cols = ceil(ncols / block_cols).

§indptr: Vec<usize>

CSR-like indptr over block rows; length = num_block_rows + 1.

§block_col_indices: Vec<usize>

Block column indices; length = number of stored blocks.

§data: Vec<T>

Dense block data; length = #blocks * block_rows * block_cols. Block k occupies data[k * block_rows * block_cols .. (k+1) * block_rows * block_cols] in row-major order.

Implementations§

Source§

impl<T> BlockCSR<T>

Source

pub fn from_csr( csr: &CsrMatrix<T>, block_rows: usize, block_cols: usize, ) -> SparseResult<Self>

Build a BlockCSR from a CSR matrix with given block dimensions.

§Arguments
  • csr - Source CSR matrix.
  • block_rows - Block row size (must be ≥ 1).
  • block_cols - Block col size (must be ≥ 1).
Source

pub fn spmv(&self, x: &[T]) -> SparseResult<Vec<T>>
where T: Add<Output = T> + Mul<Output = T>,

SpMV: y = self * x.

Source

pub fn to_csr(&self) -> SparseResult<CsrMatrix<T>>

Convert back to CSR.

Source

pub fn num_blocks(&self) -> usize

Number of stored blocks.

Trait Implementations§

Source§

impl<T: Clone> Clone for BlockCSR<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for BlockCSR<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for BlockCSR<T>

§

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

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for BlockCSR<T>

§

impl<T> UnwindSafe for BlockCSR<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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