nd_matrix 0.3.0

A n-dimensional matrix type
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

use std::{
    array::IntoIter,
    ops::{Index, IndexMut},
    slice::{Iter, IterMut},
};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Point<const N: usize>([usize; N]);

impl<const D: usize> Point<D> {
    #[inline(always)]
    pub fn coordinates(&self) -> &[usize; D] {
        &self.0
    }

    #[inline(always)]
    pub fn coordinates_mut(&mut self) -> &mut [usize; D] {
        &mut self.0
    }
}

impl<const D: usize> From<[usize; D]> for Point<D> {
    fn from(point: [usize; D]) -> Self {
        Point(point)
    }
}

impl<const D: usize> IntoIterator for Point<D> {
    type Item = usize;
    type IntoIter = IntoIter<usize, D>;

    fn into_iter(self) -> Self::IntoIter {
        self.0.into_iter()
    }
}

impl<'a, const D: usize> IntoIterator for &'a Point<D> {
    type Item = &'a usize;
    type IntoIter = Iter<'a, usize>;

    fn into_iter(self) -> Self::IntoIter {
        (&self.0).into_iter()
    }
}

impl<'a, const D: usize> IntoIterator for &'a mut Point<D> {
    type Item = &'a mut usize;
    type IntoIter = IterMut<'a, usize>;

    fn into_iter(self) -> Self::IntoIter {
        (&mut self.0).into_iter()
    }
}

impl<I, const D: usize> Index<I> for Point<D>
where
    [usize]: Index<I>,
{
    type Output = <[usize] as Index<I>>::Output;

    #[inline(always)]
    fn index(&self, index: I) -> &<Self as Index<I>>::Output {
        self.0.index(index)
    }
}

impl<I, const D: usize> IndexMut<I> for Point<D>
where
    [usize]: IndexMut<I>,
{
    #[inline(always)]
    fn index_mut(&mut self, index: I) -> &mut <Self as Index<I>>::Output {
        self.0.index_mut(index)
    }
}

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

    #[test]
    fn coordinates() {
        let point = Point([1, 2]);

        assert_eq!(point.coordinates(), &[1, 2]);
    }

    #[test]
    fn coordinates_mut() {
        let mut point = Point([1, 2]);

        assert_eq!(point.coordinates_mut(), &mut [1, 2]);
    }

    #[test]
    fn from() {
        let point = Point::from([1, 2]);

        assert_eq!(point, Point([1, 2]));
    }

    #[test]
    fn into_iter() {
        let point = Point([1, 2]);
        let mut iter = point.into_iter();

        assert_eq!(iter.next(), Some(1));
        assert_eq!(iter.next(), Some(2));
        assert_eq!(iter.next(), None);
    }

    #[test]
    fn into_iter_ref() {
        let point = Point([1, 2]);
        let mut iter = (&point).into_iter();

        assert_eq!(iter.next(), Some(&1));
        assert_eq!(iter.next(), Some(&2));
        assert_eq!(iter.next(), None);
    }

    #[test]
    fn into_iter_mut_ref() {
        let mut point = Point([1, 2]);
        let mut iter = (&mut point).into_iter();

        assert_eq!(iter.next(), Some(&mut 1));
        assert_eq!(iter.next(), Some(&mut 2));
        assert_eq!(iter.next(), None);
    }

    #[test]
    fn index() {
        let point = Point([1, 2]);

        assert_eq!(point[0], 1);
        assert_eq!(point[1], 2);
    }

    #[test]
    fn index_mut() {
        let mut point = Point([1, 2]);

        assert_eq!(&mut point[0], &mut 1);
        assert_eq!(&mut point[1], &mut 2);
    }
}