Struct SpMat 

pub struct SpMat<'buf, T> { /* private fields */ }

A sparse-matrix descriptor (CSR / CSC / COO / BSR). The descriptor keeps pointers to externally-owned device buffers; the lifetime parameter ties those buffers to the descriptor.

Implementations

impl<'buf, T: SparseScalar + DeviceRepr> SpMat<'buf, T>

pub fn csr( rows: i64, cols: i64, nnz: i64, row_offsets: &'buf mut DeviceBuffer<i32>, col_indices: &'buf mut DeviceBuffer<i32>, values: &'buf mut DeviceBuffer<T>, ) -> Result<Self>

Build a CSR (compressed sparse row) descriptor.

row_offsets.len() must equal rows + 1; col_indices.len() and values.len() must equal nnz.

pub fn csc( rows: i64, cols: i64, nnz: i64, col_offsets: &'buf mut DeviceBuffer<i32>, row_indices: &'buf mut DeviceBuffer<i32>, values: &'buf mut DeviceBuffer<T>, ) -> Result<Self>

Build a CSC (compressed sparse column) descriptor.

pub fn bsr( brows: i64, bcols: i64, bnnz: i64, row_block_dim: i64, col_block_dim: i64, order: Order, row_offsets: &'buf mut DeviceBuffer<i32>, col_indices: &'buf mut DeviceBuffer<i32>, values: &'buf mut DeviceBuffer<T>, ) -> Result<Self>

Build a BSR (block-sparse-row) descriptor.

pub fn coo( rows: i64, cols: i64, nnz: i64, row_indices: &'buf mut DeviceBuffer<i32>, col_indices: &'buf mut DeviceBuffer<i32>, values: &'buf mut DeviceBuffer<T>, ) -> Result<Self>

Build a COO (coordinate) descriptor.

impl<T> SpMat<'_, T>

pub fn shape(&self) -> Result<(i64, i64, i64)>

Sparse matrix dimensions: (rows, cols, nnz).

pub unsafe fn set_csr_pointers( &self, row_offsets: *mut c_void, col_indices: *mut c_void, values: *mut c_void, ) -> Result<()>

Rebind a CSR descriptor’s underlying device pointers without rebuilding it. Saves descriptor recreation when the same shape is reused with new data.

Safety

All three pointers must be live device allocations matching the original (rows + 1, nnz, nnz) element counts and the original element types. They must stay valid until the next operation on this descriptor completes.

pub unsafe fn set_csc_pointers( &self, col_offsets: *mut c_void, row_indices: *mut c_void, values: *mut c_void, ) -> Result<()>

Rebind a CSC descriptor’s underlying device pointers.

Safety

See Self::set_csr_pointers.

pub unsafe fn set_coo_pointers( &self, row_indices: *mut c_void, col_indices: *mut c_void, values: *mut c_void, ) -> Result<()>

Rebind a COO descriptor’s underlying device pointers.

Safety

See Self::set_csr_pointers.

pub fn set_fill(&self, fill: Fill) -> Result<()>

Set the fill-triangle attribute (for triangular solves).

pub fn set_diag(&self, diag: Diag) -> Result<()>

Set the diagonal-type attribute (unit vs non-unit, for triangular solves).

pub fn as_raw(&self) -> cusparseSpMatDescr_t

Trait Implementations

impl<T> Debug for SpMat<'_, T>

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

Formats the value using the given formatter.

impl<T> Drop for SpMat<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> Send for SpMat<'_, T>