Struct SparseMatrix 

pub struct SparseMatrix<T: Scalar> { /* private fields */ }

RAII wrapper around an aoclsparse_matrix handle holding a CSR matrix.

Construct from raw CSR vectors with SparseMatrix::from_csr (the values are copied into the wrapper) or as the result of an operation like csr2m.

Implementations

impl<T: Scalar> SparseMatrix<T>

pub fn from_csr( base: IndexBase, m: usize, n: usize, row_ptr: &[aoclsparse_int], col_ind: &[aoclsparse_int], val: &[T], ) -> Result<Self>

Build a new matrix handle from CSR arrays. The arrays are copied into the wrapper; the caller’s slices are not retained.

pub unsafe fn from_library_owned(raw: aoclsparse_matrix) -> Result<Self>

Adopt a handle returned by an AOCL routine that allocates its own CSR storage (e.g. aoclsparse_dcsr2m). The library will free the arrays when the handle is destroyed.

Safety

raw must be a valid aoclsparse_matrix whose internal storage is owned by the AOCL library and whose precision matches T.

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

(m, n) dimensions of the matrix.

pub fn nnz(&self) -> usize

Number of explicitly stored non-zeros.

pub fn base(&self) -> IndexBase

Index base used by this matrix’s row-pointer and column-index arrays.

pub fn as_raw(&self) -> aoclsparse_matrix

Borrow the raw underlying handle for raw FFI calls.

Safety

The returned pointer is valid only for the lifetime of self. Do not call aoclsparse_destroy on it.

pub fn export_csr( &self, ) -> Result<(IndexBase, Vec<aoclsparse_int>, Vec<aoclsparse_int>, Vec<T>)>

Read out the CSR contents as freshly allocated Vecs.

pub fn set_mv_hint( &mut self, op: Trans, descr: &MatDescr, expected_calls: usize, ) -> Result<()>

Hint that mat-vec (mv) will be called expected_calls times in the given orientation op.

pub fn set_sv_hint( &mut self, op: Trans, descr: &MatDescr, expected_calls: usize, ) -> Result<()>

Hint for triangular solve (trsv).

pub fn set_mm_hint( &mut self, op: Trans, descr: &MatDescr, expected_calls: usize, ) -> Result<()>

Hint for sparse-dense matrix multiply (csrmm).

pub fn set_2m_hint( &mut self, op: Trans, descr: &MatDescr, expected_calls: usize, ) -> Result<()>

Hint for sparse-sparse matrix multiply (csr2m).

pub fn set_sm_hint( &mut self, op: Trans, descr: &MatDescr, order: Order, expected_calls: usize, ) -> Result<()>

Hint for sparse triangular solve with multiple right-hand sides (trsm). order is the layout of the dense B/X matrices.

pub fn set_lu_smoother_hint( &mut self, op: Trans, descr: &MatDescr, expected_calls: usize, ) -> Result<()>

Hint for ILU smoothing.

pub fn set_symgs_hint( &mut self, op: Trans, descr: &MatDescr, expected_calls: usize, ) -> Result<()>

Hint for symmetric Gauss-Seidel.

pub fn set_dotmv_hint( &mut self, op: Trans, descr: &MatDescr, expected_calls: usize, ) -> Result<()>

Hint for the fused dot-mat-vec routine.

pub fn set_sorv_hint( &mut self, sor_type: SorType, descr: &MatDescr, expected_calls: usize, ) -> Result<()>

Hint for SOR / Gauss-Seidel sweeps.

Trait Implementations

impl<T: Scalar> Debug for SparseMatrix<T>

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

Formats the value using the given formatter.

impl<T: Scalar> Drop for SparseMatrix<T>

fn drop(&mut self)

Executes the destructor for this type.