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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
use crate::prelude_dev::*;
pub trait DimShapeAPI: DimBaseAPI {
/// Total number of elements in tensor.
///
/// # Note
///
/// For 0-dimension tensor, it contains one element.
/// For multi-dimension tensor with a dimension that have zero length, it
/// contains zero elements.
///
/// # Examples
///
/// ```
/// use rstsr_core::prelude_dev::*;
///
/// let shape = [2, 3];
/// assert_eq!(shape.shape_size(), 6);
///
/// let shape = vec![];
/// assert_eq!(shape.shape_size(), 1);
/// ```
fn shape_size(&self) -> usize;
/// Stride for a f-contiguous tensor using this shape.
///
/// # Examples
///
/// ```
/// use rstsr_core::prelude_dev::*;
///
/// let stride = [2, 3, 5].stride_f_contig();
/// assert_eq!(stride, [1, 2, 6]);
/// ```
fn stride_f_contig(&self) -> Self::Stride;
/// Stride for a c-contiguous tensor using this shape.
///
/// # Examples
///
/// ```
/// use rstsr_core::prelude_dev::*;
///
/// let stride = [2, 3, 5].stride_c_contig();
/// assert_eq!(stride, [15, 5, 1]);
/// ```
fn stride_c_contig(&self) -> Self::Stride;
/// Stride for contiguous tensor using this shape.
///
/// # Cargo feature dependent
///
/// Whether c-contiguous or f-contiguous will depends on cargo feature
/// `f_prefer`.
fn stride_contig(&self) -> Self::Stride;
/// Index (col-major) of tensor by list of indexes.
///
/// # Safety
///
/// This function does not check whether index is out of bounds.
unsafe fn unravel_index_f(&self, index: usize) -> Self;
/// Index (row-major) of tensor by list of indexes.
///
/// # Safety
///
/// This function does not check whether index is out of bounds.
unsafe fn unravel_index_c(&self, index: usize) -> Self;
}
impl<const N: usize> DimShapeAPI for Ix<N> {
fn shape_size(&self) -> usize {
self.iter().product()
}
fn stride_f_contig(&self) -> [isize; N] {
let mut stride = [1; N];
for i in 1..N {
stride[i] = stride[i - 1] * self[i - 1].max(1) as isize;
}
stride
}
fn stride_c_contig(&self) -> [isize; N] {
let mut stride = [1; N];
if N == 0 {
return stride;
}
for i in (0..N - 1).rev() {
stride[i] = stride[i + 1] * self[i + 1].max(1) as isize;
}
stride
}
fn stride_contig(&self) -> [isize; N] {
match FlagOrder::default() {
RowMajor => Self::stride_c_contig(self),
ColMajor => Self::stride_f_contig(self),
}
}
#[inline]
unsafe fn unravel_index_f(&self, index: usize) -> Self {
let mut index = index;
let mut result = self.new_shape();
match self.ndim() {
0 => (),
1 => {
result[0] = index;
},
2 => {
result[1] = index / self[0];
result[0] = index % self[0];
},
3 => {
result[2] = index / (self[0] * self[1]);
index %= self[0] * self[1];
result[1] = index / self[0];
result[0] = index % self[0];
},
4 => {
result[3] = index / (self[0] * self[1] * self[2]);
index %= self[0] * self[1] * self[2];
result[2] = index / (self[0] * self[1]);
index %= self[0] * self[1];
result[1] = index / self[0];
result[0] = index % self[0];
},
_ => {
for i in 0..(self.ndim() - 1) {
let dim = self[i];
result[i] = index % dim;
index /= dim;
}
result[self.ndim() - 1] = index;
},
}
return result;
}
#[inline]
unsafe fn unravel_index_c(&self, index: usize) -> Self {
let mut index = index;
let mut result = self.new_shape();
match self.ndim() {
0 => (),
1 => {
result[0] = index;
},
2 => {
result[0] = index / self[1];
result[1] = index % self[1];
},
3 => {
result[0] = index / (self[1] * self[2]);
index %= self[1] * self[2];
result[1] = index / self[2];
result[2] = index % self[2];
},
4 => {
result[0] = index / (self[1] * self[2] * self[3]);
index %= self[1] * self[2] * self[3];
result[1] = index / (self[2] * self[3]);
index %= self[2] * self[3];
result[2] = index / self[3];
result[3] = index % self[3];
},
_ => {
for i in (1..self.ndim()).rev() {
let dim = self[i];
result[i] = index % dim;
index /= dim;
}
result[0] = index;
},
}
return result;
}
}
impl DimShapeAPI for IxD {
fn shape_size(&self) -> usize {
self.iter().product()
}
fn stride_f_contig(&self) -> Vec<isize> {
let mut stride = vec![1; self.len()];
for i in 1..self.len() {
stride[i] = stride[i - 1] * self[i - 1] as isize;
}
stride
}
fn stride_c_contig(&self) -> Vec<isize> {
let mut stride = vec![1; self.len()];
if self.is_empty() {
return stride;
}
for i in (0..self.len() - 1).rev() {
stride[i] = stride[i + 1] * self[i + 1] as isize;
}
stride
}
fn stride_contig(&self) -> Vec<isize> {
match FlagOrder::default() {
RowMajor => Self::stride_c_contig(self),
ColMajor => Self::stride_f_contig(self),
}
}
#[inline]
unsafe fn unravel_index_f(&self, index: usize) -> Self {
let mut index = index;
let mut result = self.new_shape();
if self.ndim() >= 1 {
for i in 0..(self.ndim() - 1) {
let dim = self[i];
result[i] = index % dim;
index /= dim;
}
result[self.ndim() - 1] = index;
}
return result;
}
#[inline]
unsafe fn unravel_index_c(&self, index: usize) -> Self {
let mut index = index;
let mut result = self.new_shape();
if self.ndim() >= 1 {
for i in (1..self.ndim()).rev() {
let dim = self[i];
result[i] = index % dim;
index /= dim;
}
result[0] = index;
}
return result;
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_ndim() {
// general test
let shape = [2, 3];
assert_eq!(shape.ndim(), 2);
let shape = vec![2, 3];
assert_eq!(shape.ndim(), 2);
// empty dimension test
let shape = [];
assert_eq!(shape.ndim(), 0);
let shape = vec![];
assert_eq!(shape.ndim(), 0);
}
#[test]
fn test_size() {
// general test
let shape = [2, 3];
assert_eq!(shape.shape_size(), 6);
let shape = vec![];
assert_eq!(shape.shape_size(), 1);
// empty dimension test
let shape = [];
assert_eq!(shape.shape_size(), 1);
let shape = vec![];
assert_eq!(shape.shape_size(), 1);
// zero element test
let shape = [1, 2, 0, 4];
assert_eq!(shape.shape_size(), 0);
}
#[test]
fn test_stride_f_contig() {
// general test
let stride = [2, 3, 5].stride_f_contig();
assert_eq!(stride, [1, 2, 6]);
// empty dimension test
let stride = [].stride_f_contig();
assert_eq!(stride, []);
let stride = vec![].stride_f_contig();
assert_eq!(stride, vec![]);
// zero element test
let stride = [1, 2, 0, 4].stride_f_contig();
println!("{stride:?}");
}
#[test]
fn test_stride_c_contig() {
// general test
let stride = [2, 3, 5].stride_c_contig();
assert_eq!(stride, [15, 5, 1]);
// empty dimension test
let stride = [].stride_c_contig();
assert_eq!(stride, []);
let stride = vec![].stride_c_contig();
assert_eq!(stride, vec![]);
// zero element test
let stride = [1, 2, 0, 4].stride_c_contig();
println!("{stride:?}");
}
}