argmin-math 0.5.1

argmin math abstractions
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

// Copyright 2018-2024 argmin developers
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

// Note: This is not really the preferred way I think. Maybe this should also be implemented for
// ArrayViews, which would probably make it more efficient.

use crate::{Allocator, ArgminTranspose};

use nalgebra::{
    base::{dimension::Dim, storage::Storage, Scalar},
    DefaultAllocator, Matrix, OMatrix,
};

impl<N, R, C, S> ArgminTranspose<OMatrix<N, C, R>> for Matrix<N, R, C, S>
where
    N: Scalar,
    R: Dim,
    C: Dim,
    S: Storage<N, R, C>,
    DefaultAllocator: Allocator<N, C, R>,
{
    #[inline]
    fn t(self) -> OMatrix<N, C, R> {
        self.transpose()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use approx::assert_relative_eq;
    use nalgebra::{Matrix2, Matrix2x3, Matrix3x2, RowVector2, Vector2};
    use paste::item;

    macro_rules! make_test {
        ($t:ty) => {
            item! {
                #[test]
                fn [<test_transpose_ $t>]() {
                    let a = Vector2::new(1 as $t, 4 as $t);
                    let target = RowVector2::new(1 as $t, 4 as $t);
                    let res = <Vector2<$t> as ArgminTranspose<RowVector2<$t>>>::t(a);
                    for i in 0..2 {
                        assert_relative_eq!(target[i] as f64, res[i] as f64, epsilon = f64::EPSILON);
                    }
                }
            }

            item! {
                #[test]
                fn [<test_transpose_2d_1_ $t>]() {
                    let a = Matrix2::new(
                        1 as $t, 4 as $t,
                        8 as $t, 7 as $t
                    );
                    let target = Matrix2::new(
                        1 as $t, 8 as $t,
                        4 as $t, 7 as $t
                    );
                    let res = <Matrix2<$t> as ArgminTranspose<Matrix2<$t>>>::t(a);
                    for i in 0..2 {
                        for j in 0..2 {
                            assert_relative_eq!(target[(i, j)] as f64, res[(i, j)] as f64, epsilon = f64::EPSILON);
                        }
                    }
                }
            }

            item! {
                #[test]
                fn [<test_transpose_2d_2_ $t>]() {
                    let a = Matrix3x2::new(
                        1 as $t, 4 as $t,
                        8 as $t, 7 as $t,
                        3 as $t, 6 as $t
                    );
                    let target = Matrix2x3::new(
                        1 as $t, 8 as $t, 3 as $t,
                        4 as $t, 7 as $t, 6 as $t
                    );
                    let res = <Matrix3x2<$t> as ArgminTranspose<Matrix2x3<$t>>>::t(a);
                    for i in 0..2 {
                        for j in 0..3 {
                            assert_relative_eq!(target[(i, j)] as f64, res[(i, j)] as f64, epsilon = f64::EPSILON);
                        }
                    }
                }
            }
        };
    }

    make_test!(i8);
    make_test!(u8);
    make_test!(i16);
    make_test!(u16);
    make_test!(i32);
    make_test!(u32);
    make_test!(i64);
    make_test!(u64);
    make_test!(f32);
    make_test!(f64);
}