Enum MatrixType 

#[non_exhaustive]
#[repr(u32)]
pub enum MatrixType {
    General = 0,
    Symmetric = 1,
    Hermitian = 2,
    Triangular = 3,
}

Describes the matrix kind stored in sparse storage. For symmetric, Hermitian, and triangular matrices, only their lower or upper part is assumed to be stored.

Matrix type and fill mode minimize storage for symmetric or Hermitian matrices and let SpMV operations use symmetry when useful. To compute y=A*x when A is symmetric and only lower triangular part is stored, two steps are needed. First step is to compute y=(L+D)*x and second step is to compute y=L^T*x + y. Because the transpose operation y=L^T*x is much slower than the non-transpose version y=L*x, the symmetric property does not always improve performance. It is usually more efficient to expand the symmetric matrix to a general matrix and apply y=A*x with matrix type MatrixType::General.

In general, SpMV, preconditioners (incomplete Cholesky or incomplete LU) and triangular solver are combined together in iterative solvers, for example PCG and GMRES. If applications use general matrices instead of symmetric matrices, preconditioners only need to support general matrices. Therefore the newer \[bsr|csr\]sv2 (triangular solver), \[bsr|csr\]ilu02 (incomplete LU), and \[bsr|csr\]ic02 (incomplete Cholesky) operations only support matrix type MatrixType::General.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

General = 0

The matrix is general.

Symmetric = 1

The matrix is symmetric.

Hermitian = 2

The matrix is Hermitian.

Triangular = 3

The matrix is triangular.

Trait Implementations

impl Clone for MatrixType

fn clone(&self) -> MatrixType

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for MatrixType

impl Debug for MatrixType

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

Formats the value using the given formatter.

impl Display for MatrixType

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

Formats the value using the given formatter.

impl Eq for MatrixType

impl From<MatrixType> for u32

fn from(enum_value: MatrixType) -> Self

Converts to this type from the input type.

impl From<MatrixType> for cusparseMatrixType_t

fn from(value: MatrixType) -> Self

Converts to this type from the input type.

impl From<cusparseMatrixType_t> for MatrixType

fn from(value: cusparseMatrixType_t) -> Self

Converts to this type from the input type.

impl Hash for MatrixType

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MatrixType

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for MatrixType

impl TryFrom<u32> for MatrixType

type Error = TryFromPrimitiveError<MatrixType>

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for MatrixType

const NAME: &'static str = "MatrixType"

type Primitive = u32

type Error = TryFromPrimitiveError<MatrixType>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>