rexafs 0.2.14

Rust-powered X-ray absorption spectroscopy analysis and EXAFS fitting
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

//! Owned-array conversions for the optional `ndarray-compat` backend.
//! These conversions copy values into newly allocated buffers even though their
//! names begin with `into_`; they are not zero-copy views.

use nalgebra::{DMatrix, DVector};

#[cfg(feature = "ndarray-compat")]
use ndarray::{Array1, ArrayBase, Ix1, Ix2, OwnedRepr};

// ============================================================================
// Custom Traits (ToNalgebra, ToNdarray1) - Backward Compatibility
// ============================================================================

/// Trait for converting from ndarray to nalgebra
///
/// It is specific to f64 and 1D or 2D arrays.
/// For more general conversions, you should consider using nshare crate.
#[cfg(feature = "ndarray-compat")]
pub trait ToNalgebra {
    /// Owned destination vector or matrix type.
    type Out;
    /// Consume the source and copy values into an owned nalgebra vector/matrix.
    fn into_nalgebra(self) -> Self::Out;
}

#[cfg(feature = "ndarray-compat")]
impl ToNalgebra for ArrayBase<OwnedRepr<f64>, Ix1> {
    type Out = DVector<f64>;
    fn into_nalgebra(self) -> DVector<f64> {
        DVector::from_vec(self.to_vec())
    }
}

#[cfg(feature = "ndarray-compat")]
impl ToNalgebra for ArrayBase<OwnedRepr<f64>, Ix2> {
    type Out = DMatrix<f64>;
    fn into_nalgebra(self) -> Self::Out {
        DMatrix::from_row_iterator(self.nrows(), self.ncols(), self.iter().copied())
    }
}

/// Trait for converting from nalgebra to ndarray
///
/// It is specific to f64 and 1D arrays.
/// For more general conversions, you should consider using nshare crate.
#[cfg(feature = "ndarray-compat")]
pub trait ToNdarray1 {
    /// Owned destination vector or matrix type.
    type Out;
    /// Consume the source and copy values into an owned one-dimensional ndarray.
    fn into_ndarray1(self) -> Self::Out;
}

#[cfg(feature = "ndarray-compat")]
impl ToNdarray1 for DVector<f64> {
    type Out = ArrayBase<OwnedRepr<f64>, Ix1>;
    fn into_ndarray1(self) -> Self::Out {
        Array1::from_vec(self.data.as_vec().clone())
    }
}

#[cfg(all(test, feature = "ndarray-compat"))]
mod tests {
    use super::*;
    use nalgebra::{Matrix3x2, Vector3};
    use ndarray::{Array1, Array2};

    #[test]
    fn test_to_nalgebra() {
        let a = Array1::from_vec(vec![1.0, 2.0, 3.0]);
        let b = Array2::from(vec![[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]]);

        let a_ref = DVector::from_vec(vec![1.0, 2.0, 3.0]);
        let b_ref = Matrix3x2::new(1.0, 2.0, 3.0, 4.0, 5.0, 6.0);
        let c = a.clone().into_nalgebra();
        let d = b.clone().into_nalgebra();

        assert_eq!(c, a_ref);
        assert_eq!(d, b_ref);

        let a_rev = c.into_ndarray1();

        assert_eq!(a, a_rev);
    }
}