Struct MatDescr 

pub struct MatDescr { /* private fields */ }

RAII wrapper for aoclsparse_mat_descr.

Implementations

impl MatDescr

pub fn new() -> Result<Self>

Create a fresh descriptor with library defaults.

pub fn as_raw(&self) -> aoclsparse_mat_descr

Borrow the underlying handle for raw FFI calls.

Safety

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

pub fn set_type(&mut self, ty: MatType) -> Result<()>

Set the matrix-type hint (general / symmetric / hermitian / triangular). Affects which fast paths the library can take.

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

Set the index base (zero- or one-based) for column / row arrays.

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

For triangular / symmetric matrices, declare which triangle is stored (upper or lower).

pub fn set_diag_type(&mut self, diag: DiagType) -> Result<()>

For triangular matrices, declare whether the diagonal is unit (implicit) or non-unit (explicitly stored).

pub fn ty(&self) -> MatType

Read back the matrix-type hint.

pub fn index_base(&self) -> IndexBase

Read back the index base.

pub fn fill_mode(&self) -> FillMode

Read back the fill mode.

pub fn diag_type(&self) -> DiagType

Read back the diagonal-type hint.

Trait Implementations

impl Debug for MatDescr

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

Formats the value using the given formatter.

impl Drop for MatDescr

fn drop(&mut self)

Executes the destructor for this type.