tenso-rs 0.0.1

N Dimensional Tensors 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
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
228
229
230
231
232
233
234

use crate::utils::errors::Errors;

/// The Storage of data held in each Tensor
#[derive(Debug)]
pub struct TensorStorage<T> {
    arr: Vec<T>,
    sz: usize,
}

impl<T: Copy> TensorStorage<T> {
    /// Create new Tensor Storage with `len` elements each equal to `val`
    pub fn from_val(len: usize, value: T) -> TensorStorage<T> {
        TensorStorage {
            arr: vec![value; len],
            sz: len,
        }
    }

    /// Create new Tensor Storage from `vec`
    pub fn from_slice(vec: &[T]) -> TensorStorage<T> {
        TensorStorage {
            arr: vec.to_vec(),
            sz: vec.len(),
        }
    }

    /// Get number of elements in `self`
    pub fn len(&self) -> usize {
        self.sz
    }

    /// Get element in `self` on index `idx`
    pub fn get(&self, idx: usize) -> Result<T, Errors> {
        if idx < self.sz {
            Ok(self.arr[idx])
        } else {
            Err(Errors::OutOfBounds {
                expected: self.arr.len(),
                found: idx,
                axis: 0,
            })
        }
    }

    /// Get element in `self` on index `idx` without any checks
    pub fn get_unchecked(&self, idx: usize) -> T {
        self.arr[idx]
    }

    /// Update element in `self` on index `idx` to `val`
    pub fn upd(&mut self, idx: usize, new_val: T) -> Result<(), Errors> {
        if idx < self.sz {
            self.arr[idx] = new_val;
            Ok(())
        } else {
            Err(Errors::OutOfBounds {
                expected: self.arr.len(),
                found: idx,
                axis: 0,
            })
        }
    }

    /// Update element in `self` on index `idx` to `val` without any checks
    pub fn upd_unchecked(&mut self, idx: usize, new_val: T) {
        self.arr[idx] = new_val;
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::utils::errors::Errors;

    #[test]
    fn create_new() {
        let tensor_storage = TensorStorage::from_val(10000000, 3723_i32);
        tensor_storage
            .arr
            .iter()
            .for_each(|x| assert_eq!(*x, 3723_i32));

        let tensor_storage = TensorStorage::from_val(10000000, 1_000_000_000_000_000_000_i64);
        tensor_storage
            .arr
            .iter()
            .for_each(|x| assert_eq!(*x, 1_000_000_000_000_000_000_i64));

        let pi = std::f64::consts::PI;
        let eps = 0.000_000_000_1;
        let tensor_storage = TensorStorage::from_val(10000000, pi);
        tensor_storage
            .arr
            .iter()
            .for_each(|x| assert!((*x - pi).abs() < eps));
    }

    #[test]
    fn create_new_from_vec() {
        let vec = vec![3723_i32; 10000000];
        let tensor_storage = TensorStorage::from_slice(&vec);
        tensor_storage
            .arr
            .iter()
            .for_each(|x| assert_eq!(*x, 3723_i32));

        let vec = vec![1_000_000_000_000_000_000_i64; 10000000];
        let tensor_storage = TensorStorage::from_slice(&vec);
        tensor_storage
            .arr
            .iter()
            .for_each(|x| assert_eq!(*x, 1_000_000_000_000_000_000_i64));

        let pi = std::f64::consts::PI;
        let eps = 0.000_000_000_1;
        let vec = vec![pi; 10000000];
        let tensor_storage = TensorStorage::from_slice(&vec);
        tensor_storage
            .arr
            .iter()
            .for_each(|x| assert!((*x - pi).abs() < eps));

        let vec = vec![1, 4, 9, 16, 25, 36, 49];
        let tensor_storage = TensorStorage::from_slice(&vec);
        assert_eq!(vec, tensor_storage.arr);

        let mut vec = vec![0_i64, 1_i64];
        for _ in 2..88 {
            vec.push(vec[vec.len() - 1] + vec[vec.len() - 2]);
        }
        let tensor_storage = TensorStorage::from_slice(&vec);
        assert_eq!(vec, tensor_storage.arr);
    }

    #[test]
    fn get() {
        let tensor_storage = TensorStorage::from_val(10000000, 3723_i32);
        (0..10000000).for_each(|x| assert_eq!(tensor_storage.get_unchecked(x), 3723_i32));
        (0..10000000).for_each(|x| assert_eq!(tensor_storage.get(x).unwrap(), 3723_i32));
        assert!(match tensor_storage.get(10000001) {
            Ok(_) => false,
            Err(e) => match e {
                Errors::OutOfBounds {
                    expected: _,
                    found: _,
                    axis: _,
                } => true,
                _ => false,
            },
        });

        let tensor_storage = TensorStorage::from_val(10000000, 1_000_000_000_000_000_000_i64);
        (0..10000000).for_each(|x| {
            assert_eq!(
                tensor_storage.get_unchecked(x),
                1_000_000_000_000_000_000_i64
            )
        });
        (0..10000000).for_each(|x| {
            assert_eq!(
                tensor_storage.get(x).unwrap(),
                1_000_000_000_000_000_000_i64
            )
        });
        assert!(match tensor_storage.get(10000001) {
            Ok(_) => false,
            Err(e) => match e {
                Errors::OutOfBounds {
                    expected: _,
                    found: _,
                    axis: _,
                } => true,
                _ => false,
            },
        });

        let pi = std::f64::consts::PI;
        let eps = 0.000_000_000_1;
        let tensor_storage = TensorStorage::from_val(10000000, pi);
        (0..10000000).for_each(|x| assert!((tensor_storage.get_unchecked(x) - pi).abs() < eps));
        (0..10000000).for_each(|x| assert!((tensor_storage.get(x).unwrap() - pi).abs() < eps));
        assert!(match tensor_storage.get(10000001) {
            Ok(_) => false,
            Err(e) => match e {
                Errors::OutOfBounds {
                    expected: _,
                    found: _,
                    axis: _,
                } => true,
                _ => false,
            },
        });
    }

    #[test]
    fn upd() {
        let mut vec = vec![1, 4, 9, 16, 25, 36, 49];
        let mut tensor_storage = TensorStorage::from_slice(&vec);
        tensor_storage.upd_unchecked(1, 5);
        vec[1] = 5;
        assert_eq!(vec, tensor_storage.arr);
        assert!(match tensor_storage.upd(10, 10) {
            Ok(_) => false,
            Err(e) => match e {
                Errors::OutOfBounds {
                    expected: e,
                    found: f,
                    axis: a,
                } => e == 7 && f == 10 && a == 0,
                _ => false,
            },
        });

        let mut vec = vec![0_i64, 1_i64];
        for _ in 2..88 {
            vec.push(vec[vec.len() - 1] + vec[vec.len() - 2]);
        }
        let mut tensor_storage = TensorStorage::from_slice(&vec);
        tensor_storage.upd_unchecked(3, 0);
        vec[3] = 0_i64;
        assert_eq!(vec, tensor_storage.arr);
        assert!(match tensor_storage.upd(100, 100) {
            Ok(_) => false,
            Err(e) => match e {
                Errors::OutOfBounds {
                    expected: e,
                    found: f,
                    axis: a,
                } => e == 88 && f == 100 && a == 0,
                _ => false,
            },
        });
    }
}