numint 0.2.0

ODE solvers and numerical integration in Rust.
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use crate::ode_state::ode_state_trait::{OdeState, StateIndex};
use linalg_traits::{Mat, Matrix};

#[cfg(feature = "nalgebra")]
use nalgebra::DMatrix;

#[cfg(feature = "ndarray")]
use ndarray::Array2;

#[cfg(feature = "faer")]
use faer::Mat as FMat;

/// Macro to implement the [`OdeState`] trait for dynamically-sized matrix types.
///
/// A type must implement the
/// [`linalg_traits::Matrix`](https://docs.rs/linalg-traits/latest/linalg_traits/trait.Matrix.html)
/// trait to be used with this macro.
///
/// # Arguments
///
/// * `$type:ident` - Type to implement the [`OdeState`] trait for. Do not include any type
///   parameters (e.g. use `Mat` instead of `Mat<f64>`).
///
/// # Example
///
/// This example demonstrates how we use the `impl_ode_state_for_dmatrix` macro internally within
/// the `numint` crate to implement the [`OdeState`] trait for `Mat<f64>`.
///
/// ```ignore
/// use linalg_traits::{Mat, Matrix};
///
/// use numint::{impl_ode_state_for_dmatrix, OdeState};
///
/// impl_ode_state_for_dmatrix!(Mat);
/// ```
#[macro_export]
macro_rules! impl_ode_state_for_dmatrix {
    ($($type:ident),*) => {
        $(
            impl OdeState for $type<f64> {
                fn add(&self, other: &Self) -> Self {
                    <Self as Matrix<f64>>::add(self, other)
                }
                fn add_assign(&mut self, other: &Self) {
                    <Self as Matrix<f64>>::add_assign(self, other);
                }
                fn sub(&self, other: &Self) -> Self {
                    <Self as Matrix<f64>>::sub(self, other)
                }
                fn sub_assign(&mut self, other: &Self) {
                    <Self as Matrix<f64>>::sub_assign(self, other);
                }
                fn mul(&self, scalar: f64) -> Self {
                    <Self as Matrix<f64>>::mul(self, scalar)
                }
                fn mul_assign(&mut self, scalar: f64) {
                    <Self as Matrix<f64>>::mul_assign(self, scalar);
                }
                fn get_state_variable(&self, index: StateIndex) -> f64 {
                    match index {
                        StateIndex::Scalar() => panic!("Cannot index a matrix ODE state with a StateIndex::Scalar."),
                        StateIndex::Vector(_) => panic!("Cannot index a matrix ODE state with a StateIndex::Vector."),
                        StateIndex::Matrix(i, j) => self[(i, j)]
                    }
                }
            }
        )*
    };
}

// Implementation of OdeState for Mat<f64>.
impl_ode_state_for_dmatrix!(Mat);

// Implementation of OdeState for nalgebra::DMatrix<f64>.
#[cfg(feature = "nalgebra")]
impl_ode_state_for_dmatrix!(DMatrix);

// Implementation of OdeState for ndarray::Array2<f64>.
#[cfg(feature = "ndarray")]
impl_ode_state_for_dmatrix!(Array2);

// Implementation of OdeState for faer::Mat<f64>.
#[cfg(feature = "faer")]
impl_ode_state_for_dmatrix!(FMat);

#[cfg(test)]
mod tests {
    use super::*;

    /// Helper function for testing the implementation of `OdeState` for matrix types.
    ///
    /// # Type Parameters
    ///
    /// * `T` - The type to test.
    fn ode_state_matrix_test_helper<T: OdeState + Matrix<f64>>() {
        // Test values.
        let a = <T as Matrix<f64>>::from_row_slice(2, 2, &[1.0, 2.0, 3.0, 4.0]);
        let b = <T as Matrix<f64>>::from_row_slice(2, 2, &[10.0, 8.0, 4.0, 2.0]);
        let c = 5.0;
        let a_plus_b = <T as Matrix<f64>>::from_row_slice(2, 2, &[11.0, 10.0, 7.0, 6.0]);
        let a_minus_b = <T as Matrix<f64>>::from_row_slice(2, 2, &[-9.0, -6.0, -1.0, 2.0]);
        let a_times_c = <T as Matrix<f64>>::from_row_slice(2, 2, &[5.0, 10.0, 15.0, 20.0]);

        // Check addition.
        assert_eq!(OdeState::add(&a, &b), a_plus_b);

        // Check addition-assignment.
        let mut d = a.clone();
        OdeState::add_assign(&mut d, &b);
        assert_eq!(d, a_plus_b);

        // Check subtraction.
        assert_eq!(OdeState::sub(&a, &b), a_minus_b);

        // Check subtraction-assignment.
        d = a.clone();
        OdeState::sub_assign(&mut d, &b);
        assert_eq!(d, a_minus_b);

        // Check multiplication.
        assert_eq!(OdeState::mul(&a, c), a_times_c);

        // Check multiplication-assignment.
        d = a.clone();
        OdeState::mul_assign(&mut d, c);
        assert_eq!(d, a_times_c);

        // Check indexing.
        for i in 0..2 {
            for j in 0..2 {
                assert_eq!(a.get_state_variable(StateIndex::Matrix(i, j)), a[(i, j)]);
            }
        }
    }

    #[test]
    fn test_ode_state_linalg_traits_mat() {
        ode_state_matrix_test_helper::<Mat<f64>>();
    }

    #[test]
    #[cfg(feature = "nalgebra")]
    fn test_ode_state_nalgebra_dmatrix() {
        ode_state_matrix_test_helper::<DMatrix<f64>>();
    }

    #[test]
    #[cfg(feature = "ndarray")]
    fn test_ode_state_ndarray_array2() {
        ode_state_matrix_test_helper::<Array2<f64>>();
    }

    #[test]
    #[cfg(feature = "faer")]
    fn test_ode_state_faer_mat() {
        ode_state_matrix_test_helper::<Mat<f64>>();
    }
}