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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
// Copyright 2022 Stefan Zobel
//
// 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.

//! Index and IndexMut implementations

use crate::matrix::*;
use std::ops::{Index, IndexMut};

// A1) Index for SMatrix
impl<T: Numeric<T>, const ROWS: usize, const COLS: usize> Index<usize> for SMatrix<T, ROWS, COLS> {
    type Output = [T; COLS];

    #[inline]
    fn index(&self, index: usize) -> &Self::Output {
        &self.array()[index]
    }
}

// A1-Mut) IndexMut for SMatrix
impl<T: Numeric<T>, const ROWS: usize, const COLS: usize> IndexMut<usize>
    for SMatrix<T, ROWS, COLS>
{
    #[inline]
    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
        &mut self.array_mut()[index]
    }
}

// A2) Index for &SMatrix (shared)
impl<'a, T: Numeric<T>, const ROWS: usize, const COLS: usize> Index<usize>
    for &'a SMatrix<T, ROWS, COLS>
{
    type Output = [T; COLS];

    #[inline]
    fn index(&self, index: usize) -> &Self::Output {
        &self.array()[index]
    }
}

// A3) Index for &mut SMatrix (exclusive)
impl<'a, T: Numeric<T>, const ROWS: usize, const COLS: usize> Index<usize>
    for &'a mut SMatrix<T, ROWS, COLS>
{
    type Output = [T; COLS];

    #[inline]
    fn index(&self, index: usize) -> &Self::Output {
        &self.array()[index]
    }
}

// A3-Mut) IndexMut for &mut SMatrix (exclusive)
impl<'a, T: Numeric<T>, const ROWS: usize, const COLS: usize> IndexMut<usize>
    for &'a mut SMatrix<T, ROWS, COLS>
{
    #[inline]
    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
        &mut self.array_mut()[index]
    }
}

// B1) Index for HMatrix
impl<T: Numeric<T>, const ROWS: usize, const COLS: usize> Index<usize> for HMatrix<T, ROWS, COLS> {
    type Output = [T; COLS];

    #[inline]
    fn index(&self, index: usize) -> &Self::Output {
        &self.array()[index]
    }
}

// B1-Mut) IndexMut for HMatrix
impl<T: Numeric<T>, const ROWS: usize, const COLS: usize> IndexMut<usize>
    for HMatrix<T, ROWS, COLS>
{
    #[inline]
    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
        &mut self.array_mut()[index]
    }
}

// B2) Index for &HMatrix (shared)
impl<'a, T: Numeric<T>, const ROWS: usize, const COLS: usize> Index<usize>
    for &'a HMatrix<T, ROWS, COLS>
{
    type Output = [T; COLS];

    #[inline]
    fn index(&self, index: usize) -> &Self::Output {
        &self.array()[index]
    }
}

// B3) Index for &mut HMatrix (exclusive)
impl<'a, T: Numeric<T>, const ROWS: usize, const COLS: usize> Index<usize>
    for &'a mut HMatrix<T, ROWS, COLS>
{
    type Output = [T; COLS];

    #[inline]
    fn index(&self, index: usize) -> &Self::Output {
        &self.array()[index]
    }
}

// B3-Mut) IndexMut for &mut HMatrix (exclusive)
impl<'a, T: Numeric<T>, const ROWS: usize, const COLS: usize> IndexMut<usize>
    for &'a mut HMatrix<T, ROWS, COLS>
{
    #[inline]
    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
        &mut self.array_mut()[index]
    }
}

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

    #[test]
    fn test_one_index() {
        let a = MF::<f64, 10, 10>::new_stack();
        let mut row = a[0];
        println!("row = {:?}", row);
        let a = MF::<f64, 10, 10>::new_heap();
        row = a[0];
        println!("row = {:?}", row);
        // shared ref
        let b1 = &MF::<f64, 10, 10>::new_stack();
        let b2 = &MF::<f64, 10, 10>::new_heap();
        let row1 = b1[0];
        let row2 = b2[0];
        println!("row1 = {:?}", row1);
        println!("row2 = {:?}", row2);
        // mutable ref
        let c1 = &mut MF::<f64, 10, 10>::new_stack();
        let c2 = &mut MF::<f64, 10, 10>::new_heap();
        let row1 = c1[0];
        let row2 = c2[0];
        println!("row1 = {:?}", row1);
        println!("row2 = {:?}", row2);
    }

    #[test]
    fn test_two_indices() {
        let a = MF::<f64, 10, 10>::new_stack();
        let mut elem = a[0][0];
        println!("a[0][0] = {}", elem);
        let a = MF::<f64, 10, 10>::new_heap();
        elem = a[0][0];
        println!("a[0][0] = {}", elem);
        // shared ref
        let b1 = &MF::<f64, 10, 10>::new_stack();
        let b2 = &MF::<f64, 10, 10>::new_heap();
        let elem1 = b1[0][0];
        let elem2 = b2[0][0];
        println!("e1[0][0] = {}", elem1);
        println!("e2[0][0] = {}", elem2);
        // mutable ref
        let c1 = &mut MF::<f64, 10, 10>::new_stack();
        let c2 = &mut MF::<f64, 10, 10>::new_heap();
        let elem1 = c1[0][0];
        let elem2 = c2[0][0];
        println!("e1[0][0] = {}", elem1);
        println!("e2[0][0] = {}", elem2);
    }

    #[test]
    fn test_one_index_assign() {
        let row = [9.5f64; 10];
        let mut a = MF::<f64, 10, 10>::new_stack();
        let mut b = MF::<f64, 10, 10>::new_heap();
        a[0] = row;
        b[0] = row;
        let row1 = a[0];
        let row2 = b[0];
        println!("row after assign = {:?}", row1);
        println!("row after assign = {:?}", row2);
        // mutable ref
        let mut c1 = &mut MF::<f64, 10, 10>::new_stack();
        let mut c2 = &mut MF::<f64, 10, 10>::new_heap();
        c1[0] = row;
        c2[0] = row;
        let row1 = c1[0];
        let row2 = c2[0];
        println!("row1 = {:?}", row1);
        println!("row2 = {:?}", row2);
        // shared ref
        // this doesn't work by design
        /*
        let mut b1 = &MF::<f64, 10, 10>::new_stack();
        let mut b2 = &MF::<f64, 10, 10>::new_heap();
        b1[0] = row;
        b2[0] = row;
        let row1 = b1[0];
        let row2 = b2[0];
        println!("row1 = {:?}", row1);
        println!("row2 = {:?}", row2);
        */
    }

    #[test]
    fn test_two_indices_assign() {
        let mut a = MF::<f64, 10, 10>::new_stack();
        let mut b = MF::<f64, 10, 10>::new_heap();
        a[0][0] = 199.99;
        b[0][0] = 199.99;
        let elem1 = a[0][0];
        let elem2 = a[0][0];
        println!("e1 - a[0][0] = {}", elem1);
        println!("e2 - a[0][0] = {}", elem2);
        // mutable ref
        let mut c1 = &mut MF::<f64, 10, 10>::new_stack();
        let mut c2 = &mut MF::<f64, 10, 10>::new_heap();
        c1[0][0] = 199.99;
        c2[0][0] = 199.99;
        let elem1 = c1[0][0];
        let elem2 = c2[0][0];
        println!("e1[0][0] = {}", elem1);
        println!("e2[0][0] = {}", elem2);
    }
}