diffsol-c 0.2.1

A diffsol wrapper featuring runtime scalar/matrix/solver types and a C API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

// Matrix type Python enum

use diffsol::{FaerScalar, Matrix, NalgebraScalar};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Enumerates the possible matrix types for diffsol
///
/// :attr nalgebra_dense: dense matrix using nalgebra crate (https://nalgebra.rs/)
/// :attr faer_dense: dense matrix using faer crate (https://faer.veganb.tw/)
/// :attr faer_sparse: sparse matrix using faer crate (https://faer.veganb.tw/)
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum MatrixType {
    NalgebraDense,
    FaerDense,
    FaerSparse,
}

// Internal trait to determine runtime MatrixType from a compile-time diffsol matrix type
pub(crate) trait MatrixKind {
    const MATRIX_TYPE: MatrixType;
}

impl<T: NalgebraScalar> MatrixKind for diffsol::NalgebraMat<T> {
    const MATRIX_TYPE: MatrixType = MatrixType::NalgebraDense;
}

impl<T: FaerScalar> MatrixKind for diffsol::FaerMat<T> {
    const MATRIX_TYPE: MatrixType = MatrixType::FaerDense;
}

impl<T: FaerScalar> MatrixKind for diffsol::FaerSparseMat<T> {
    const MATRIX_TYPE: MatrixType = MatrixType::FaerSparse;
}

impl MatrixType {
    pub(crate) fn get_name(&self) -> &str {
        match self {
            MatrixType::NalgebraDense => "nalgebra_dense",
            MatrixType::FaerDense => "faer_dense",
            MatrixType::FaerSparse => "faer_sparse",
        }
    }

    // Determine runtime matrix type compiled diffsol matrix type
    pub(crate) fn from_diffsol<M: Matrix + MatrixKind>() -> Self {
        M::MATRIX_TYPE
    }
}