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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
use std::fmt;
use std::iter::{self, FromIterator};
use std::ops::{self, Deref, DerefMut};
use itertools::{Itertools, MultiProduct};
use safecast::{Match, TryCastFrom, TryCastInto};
use tc_error::*;
use tc_value::Value;
use super::Coord;
pub type Coords = MultiProduct<AxisIter>;
#[derive(Clone)]
pub enum AxisIter {
One(std::iter::Once<u64>),
Each(Vec<u64>, usize),
Step(iter::StepBy<ops::Range<u64>>),
}
impl Iterator for AxisIter {
type Item = u64;
fn next(&mut self) -> Option<u64> {
use AxisIter::*;
match self {
One(iter) => iter.next(),
Each(v, at) => {
if at == &v.len() {
None
} else {
Some(v[*at])
}
}
Step(iter) => iter.next(),
}
}
}
#[derive(Clone)]
pub enum AxisBounds {
At(u64),
In(ops::Range<u64>),
Of(Vec<u64>),
}
impl AxisBounds {
pub fn all(dim: u64) -> AxisBounds {
AxisBounds::In(0..dim)
}
pub fn dim(&self) -> u64 {
match self {
Self::At(_) => 1,
Self::In(range) => range.end - range.start,
Self::Of(indices) => indices.len() as u64,
}
}
pub fn is_index(&self) -> bool {
if let Self::At(_) = self {
true
} else {
false
}
}
}
impl PartialEq for AxisBounds {
fn eq(&self, other: &AxisBounds) -> bool {
use AxisBounds::*;
match (self, other) {
(At(l), At(r)) if l == r => true,
(In(lr), In(rr)) if lr == rr => true,
(Of(l), Of(r)) if l == r => true,
_ => false,
}
}
}
impl From<u64> for AxisBounds {
fn from(at: u64) -> AxisBounds {
AxisBounds::At(at)
}
}
impl From<Vec<u64>> for AxisBounds {
fn from(of: Vec<u64>) -> AxisBounds {
AxisBounds::Of(of)
}
}
impl From<ops::Range<u64>> for AxisBounds {
fn from(range: ops::Range<u64>) -> AxisBounds {
AxisBounds::In(range)
}
}
impl TryCastFrom<Value> for AxisBounds {
fn can_cast_from(value: &Value) -> bool {
value.matches::<u64>() || value.matches::<(u64, u64)>() || value.matches::<Vec<u64>>()
}
fn opt_cast_from(value: Value) -> Option<AxisBounds> {
if value.matches::<u64>() {
value.opt_cast_into().map(AxisBounds::At)
} else if value.matches::<(u64, u64)>() {
let range: (u64, u64) = value.opt_cast_into().unwrap();
Some(AxisBounds::In(range.0..range.1))
} else if value.matches::<Vec<u64>>() {
value.opt_cast_into().map(AxisBounds::Of)
} else {
None
}
}
}
impl fmt::Debug for AxisBounds {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
fmt::Display::fmt(self, f)
}
}
impl fmt::Display for AxisBounds {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
use AxisBounds::*;
match self {
At(at) => write!(f, "{}", at),
In(range) => write!(f, "[{}, {})", range.start, range.end),
Of(indices) => write!(
f,
"{{{}}}",
indices
.iter()
.map(|i| i.to_string())
.collect::<Vec<String>>()
.join(", ")
),
}
}
}
#[derive(Clone)]
pub struct Bounds {
axes: Vec<AxisBounds>,
}
impl Bounds {
pub fn all(shape: &Shape) -> Bounds {
shape
.0
.iter()
.map(|dim| AxisBounds::In(0..*dim))
.collect::<Vec<AxisBounds>>()
.into()
}
pub fn affected(&self) -> Coords {
use AxisBounds::*;
let mut axes = Vec::with_capacity(self.len());
for axis in 0..self.len() {
axes.push(match &self[axis] {
At(i) => AxisIter::One(iter::once(*i)),
In(range) => AxisIter::Step(range.clone().step_by(1)),
Of(indices) => AxisIter::Each(indices.to_vec(), 0),
});
}
axes.iter().cloned().multi_cartesian_product()
}
pub fn contains_coord(&self, coord: &[u64]) -> bool {
if coord.len() != self.len() {
return false;
}
use AxisBounds::*;
for (bound, c) in self.axes.iter().zip(coord) {
match bound {
At(i) if i != c => return false,
In(range) if !range.contains(c) => return false,
Of(indices) if !indices.contains(c) => return false,
_ => {}
}
}
true
}
pub fn as_coord(&self, shape: &[u64]) -> Option<Coord> {
if shape.len() != self.axes.len() {
return None;
}
let mut coord = Vec::with_capacity(self.axes.len());
for x in &self.axes {
match x {
AxisBounds::At(i) => coord.push(*i),
AxisBounds::In(range) if range.end - range.start == 1 => coord.push(range.start),
AxisBounds::Of(indices) if indices.len() == 1 => coord.push(indices[0]),
_ => return None,
}
}
Some(coord)
}
pub fn is_coord(&self, shape: &[u64]) -> bool {
self.len() == shape.len() && self.axes.iter().all(|bound| bound.is_index())
}
pub fn ndim(&self) -> usize {
self.axes.iter().filter(|bound| !bound.is_index()).count()
}
pub fn normalize(&mut self, shape: &Shape) {
assert!(self.len() <= shape.len());
for axis in self.axes.len()..shape.len() {
self.axes.push(AxisBounds::all(shape[axis]))
}
}
pub fn to_shape(&self, source_shape: &Shape) -> TCResult<Shape> {
if source_shape.len() < self.len() {
return Err(TCError::unsupported(format!(
"invalid bounds {} for shape {}",
self, source_shape
)));
}
let mut shape = source_shape.to_vec();
let mut axis = 0;
for bound in &self.axes {
match bound {
AxisBounds::In(range) => {
shape[axis] = range.end - range.start;
axis += 1;
}
AxisBounds::At(_) => {
shape.remove(axis);
}
AxisBounds::Of(indices) => {
shape[axis] = indices.len() as u64;
axis += 1;
}
}
}
Ok(shape.into())
}
pub fn size(&self) -> u64 {
self.axes.iter().map(|bound| bound.dim()).product()
}
}
impl IntoIterator for Bounds {
type Item = AxisBounds;
type IntoIter = <Vec<AxisBounds> as IntoIterator>::IntoIter;
fn into_iter(self) -> Self::IntoIter {
self.axes.into_iter()
}
}
impl Default for Bounds {
fn default() -> Self {
Self { axes: vec![] }
}
}
impl Deref for Bounds {
type Target = Vec<AxisBounds>;
fn deref(&'_ self) -> &'_ Self::Target {
&self.axes
}
}
impl DerefMut for Bounds {
fn deref_mut(&'_ mut self) -> &'_ mut Self::Target {
&mut self.axes
}
}
impl PartialEq for Bounds {
fn eq(&self, other: &Self) -> bool {
self.axes == other.axes
}
}
impl FromIterator<AxisBounds> for Bounds {
fn from_iter<T: IntoIterator<Item = AxisBounds>>(iter: T) -> Self {
Self {
axes: iter.into_iter().collect(),
}
}
}
impl From<Vec<AxisBounds>> for Bounds {
fn from(axes: Vec<AxisBounds>) -> Bounds {
Bounds { axes }
}
}
impl From<&[u64]> for Bounds {
fn from(coord: &[u64]) -> Bounds {
let axes = coord.iter().map(|i| AxisBounds::At(*i)).collect();
Bounds { axes }
}
}
impl From<Vec<u64>> for Bounds {
fn from(coord: Vec<u64>) -> Bounds {
let axes = coord.iter().map(|i| AxisBounds::At(*i)).collect();
Bounds { axes }
}
}
impl From<(Vec<u64>, Vec<u64>)> for Bounds {
fn from(bounds: (Vec<u64>, Vec<u64>)) -> Bounds {
bounds
.0
.iter()
.zip(bounds.1.iter())
.map(|(s, e)| AxisBounds::In(*s..*e))
.collect::<Vec<AxisBounds>>()
.into()
}
}
impl From<(AxisBounds, Vec<u64>)> for Bounds {
fn from(tuple: (AxisBounds, Vec<u64>)) -> Bounds {
let mut axes = Vec::with_capacity(tuple.1.len() + 1);
axes.push(tuple.0);
for axis in tuple.1.into_iter() {
axes.push(axis.into());
}
Bounds { axes }
}
}
impl TryCastFrom<Value> for Bounds {
fn can_cast_from(value: &Value) -> bool {
value.matches::<Vec<AxisBounds>>()
}
fn opt_cast_from(value: Value) -> Option<Bounds> {
let bounds: Option<Vec<AxisBounds>> = value.opt_cast_into();
bounds.map(Bounds::from)
}
}
impl fmt::Debug for Bounds {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(
f,
"[{}]",
self.axes
.iter()
.map(|axis| format!("{:?}", axis))
.collect::<Vec<String>>()
.join(", ")
)
}
}
impl fmt::Display for Bounds {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(
f,
"[{}]",
self.axes
.iter()
.map(|axis| format!("{}", axis))
.collect::<Vec<String>>()
.join(", ")
)
}
}
#[derive(Clone, Default, Eq, PartialEq)]
pub struct Shape(Vec<u64>);
impl Shape {
pub fn contains_bounds(&self, bounds: &Bounds) -> bool {
if bounds.len() > self.len() {
return false;
}
for axis in 0..bounds.len() {
let size = &self[axis];
match &bounds[axis] {
AxisBounds::At(i) => {
if i > size {
return false;
}
}
AxisBounds::In(range) => {
if range.start > *size || range.end > *size {
return false;
}
}
AxisBounds::Of(indices) => {
for i in indices {
if i > size {
return false;
}
}
}
}
}
true
}
pub fn contains_coord(&self, coord: &[u64]) -> bool {
if coord.len() != self.len() {
return false;
}
for axis in 0..coord.len() {
if coord[axis] >= self[axis] {
return false;
}
}
true
}
pub fn into_vec(self) -> Vec<u64> {
self.0
}
pub fn origin(&self) -> Coord {
iter::repeat(0).take(self.len()).collect()
}
pub fn size(&self) -> u64 {
self.0.iter().product()
}
pub fn validate(&self, debug_info: &'static str) -> TCResult<()> {
if self.0.is_empty() {
return Err(TCError::unsupported(format!(
"error in {}: invalid tensor shape {}",
debug_info, self
)));
}
let mut size = 1u64;
for dim in &self.0 {
if dim == &0 {
return Err(TCError::unsupported(format!(
"error in {}: invalid tensor dimension {}",
debug_info, dim
)));
} else if let Some(m) = size.checked_mul(*dim) {
size = m;
} else {
return Err(TCError::unsupported(format!(
"error in {}: tensor shape {} exceeds the maximum allowed size of 2^64",
debug_info, self
)));
}
}
Ok(())
}
pub fn validate_axes(&self, axes: &[usize]) -> TCResult<()> {
match axes.iter().max() {
Some(max) if max > &self.len() => Err(TCError::unsupported(format!(
"shape {} has no axis {}",
self, max
))),
_ => Ok(()),
}
}
pub fn validate_bounds(&self, bounds: &Bounds) -> TCResult<()> {
if self.contains_bounds(bounds) {
Ok(())
} else {
Err(TCError::unsupported(format!(
"Tensor of shape {} does not contain bounds {}",
self, bounds
)))
}
}
pub fn validate_coord(&self, coord: &[u64]) -> TCResult<()> {
for (axis, index) in coord.iter().enumerate() {
if index >= &self[axis] {
return Err(TCError::unsupported(format!(
"Tensor of shape {} does not contain {}",
self,
Value::from_iter(coord.to_vec())
)));
}
}
Ok(())
}
}
impl Deref for Shape {
type Target = Vec<u64>;
fn deref(&'_ self) -> &'_ Vec<u64> {
&self.0
}
}
impl DerefMut for Shape {
fn deref_mut(&'_ mut self) -> &'_ mut Vec<u64> {
&mut self.0
}
}
impl From<Vec<u64>> for Shape {
fn from(shape: Vec<u64>) -> Shape {
Shape(shape)
}
}
impl FromIterator<u64> for Shape {
fn from_iter<I: IntoIterator<Item = u64>>(iter: I) -> Self {
let dims = Vec::<u64>::from_iter(iter);
Self(dims)
}
}
impl TryCastFrom<Value> for Shape {
fn can_cast_from(value: &Value) -> bool {
value.matches::<Vec<u64>>()
}
fn opt_cast_from(value: Value) -> Option<Shape> {
let shape: Option<Vec<u64>> = value.opt_cast_into();
shape.map(Shape::from)
}
}
impl fmt::Display for Shape {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(
f,
"[{}]",
self.0
.iter()
.map(|dim| format!("{}", dim))
.collect::<Vec<String>>()
.join(", ")
)
}
}
impl fmt::Debug for Shape {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
fmt::Display::fmt(self, f)
}
}