SparseFormat

Enum SparseFormat 

Source
pub enum SparseFormat {
    Coo,
    Csr,
    Csc,
    Bsr,
    Dia,
    Dsr,
    Ell,
    Rle,
    Symmetric,
}
Expand description

Layout format for sparse tensors

Different sparse formats are optimized for different use cases and access patterns. Choose the appropriate format based on your matrix characteristics and operations.

Variants§

§

Coo

Coordinate format (COO) - stores (row, col, value) triplets

Best for: Matrix construction, format conversion, random insertion Memory: 3 * nnz storage (row indices, col indices, values) Operations: Efficient addition, inefficient matrix-vector multiplication

§

Csr

Compressed Sparse Row (CSR) - row-oriented compressed format

Best for: Matrix-vector multiplication, row slicing, iterating by rows Memory: (nnz + n + 1) storage (values, col_indices, row_ptr) Operations: Fast row access, efficient SpMV, slow column access

§

Csc

Compressed Sparse Column (CSC) - column-oriented compressed format

Best for: Matrix-vector multiplication (A^T * x), column slicing Memory: (nnz + m + 1) storage (values, row_indices, col_ptr) Operations: Fast column access, efficient transpose operations

§

Bsr

Block Sparse Row (BSR) - stores dense blocks in sparse locations

Best for: Matrices with dense block structure, finite element methods Memory: Efficient for matrices with natural block structure Operations: BLAS-optimized operations on dense blocks

§

Dia

Diagonal format (DIA) - stores diagonals efficiently

Best for: Matrices with few non-zero diagonals, finite difference schemes Memory: Very compact for diagonal-dominant matrices Operations: Fast diagonal operations, limited to diagonal patterns

§

Dsr

Dynamic Sparse Row (DSR) - dynamic insertion/deletion support

Best for: Matrices that change structure frequently during computation Memory: Tree-based storage allows dynamic modifications Operations: Efficient insertion/deletion, slower than static formats

§

Ell

ELLPACK format (ELL) - fixed-width row storage

Best for: GPU operations, SIMD vectorization, matrices with uniform row density Memory: Can have significant overhead for irregular matrices Operations: SIMD-friendly, efficient on parallel architectures

§

Rle

Run-Length Encoded format (RLE) - compresses consecutive zeros

Best for: Matrices with long runs of consecutive non-zeros Memory: Excellent compression for specific patterns Operations: Specialized for pattern-specific matrices

§

Symmetric

Symmetric sparse format (SYM) - stores only lower/upper triangle

Best for: Symmetric matrices from finite element analysis, optimization Memory: Roughly half the storage of equivalent full format Operations: Specialized symmetric operations, automatic symmetry enforcement

Trait Implementations§

Source§

impl Clone for SparseFormat

Source§

fn clone(&self) -> SparseFormat

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 Debug for SparseFormat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<ScipyFormat> for SparseFormat

Source§

fn from(format: ScipyFormat) -> Self

Converts to this type from the input type.
Source§

impl From<SparseFormat> for ScipyFormat

Source§

fn from(format: SparseFormat) -> Self

Converts to this type from the input type.
Source§

impl Hash for SparseFormat

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SparseFormat

Source§

fn eq(&self, other: &SparseFormat) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for SparseFormat

Source§

impl Eq for SparseFormat

Source§

impl StructuralPartialEq for SparseFormat

Auto Trait Implementations§

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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