Struct MatrixDescriptor 

pub struct MatrixDescriptor { /* private fields */ }

Implementations

impl MatrixDescriptor

pub fn create() -> Result<Self>

Initializes a matrix descriptor. It sets MatrixType and IndexBase to MatrixType::General and IndexBase::Zero, respectively, while leaving other fields uninitialized.

Errors

Returns an error if cuSPARSE cannot create the descriptor or if it returns a null handle.

pub fn matrix_type(&self) -> MatrixType

Returns the MatrixType field of this matrix descriptor.

pub fn set_matrix_type(&mut self, matrix_type: MatrixType) -> Result<()>

Sets the MatrixType field of this matrix descriptor.

Errors

Returns an error if cuSPARSE rejects matrix_type.

pub fn fill_mode(&self) -> FillMode

Returns the FillMode field of this matrix descriptor.

pub fn set_fill_mode(&mut self, fill_mode: FillMode) -> Result<()>

Sets the FillMode field of this matrix descriptor.

Errors

Returns an error if cuSPARSE rejects fill_mode.

pub fn diagonal_type(&self) -> DiagonalType

Returns the DiagonalType field of this matrix descriptor.

pub fn set_diagonal_type(&mut self, diagonal_type: DiagonalType) -> Result<()>

Sets the DiagonalType field of this matrix descriptor.

Errors

Returns an error if cuSPARSE rejects diagonal_type.

pub fn index_base(&self) -> IndexBase

Returns the IndexBase field of this matrix descriptor.

pub fn set_index_base(&mut self, index_base: IndexBase) -> Result<()>

Sets the IndexBase field of this matrix descriptor.

Errors

Returns an error if cuSPARSE rejects index_base.

pub fn as_raw(&self) -> cusparseMatDescr_t

pub unsafe fn from_raw(handle: cusparseMatDescr_t) -> Result<Self>

Wraps an existing cuSPARSE legacy matrix descriptor and takes ownership of it.

Safety

handle must be a valid cusparseMatDescr_t. Ownership of handle is transferred to the returned descriptor, and the handle must not be destroyed elsewhere after calling this function.

pub fn into_raw(self) -> cusparseMatDescr_t

Consumes the descriptor and returns the raw cuSPARSE handle without destroying it.

The caller becomes responsible for eventually destroying the returned handle with cusparseDestroyMatDescr.

Trait Implementations

impl Debug for MatrixDescriptor

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

Formats the value using the given formatter.

impl Drop for MatrixDescriptor

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 Send for MatrixDescriptor

impl Sync for MatrixDescriptor