redstone-ml 0.0.0

High-performance Machine Learning, Auto-Differentiation and Tensor Algebra crate for 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

use std::ops::{Range, RangeFrom, RangeFull, RangeInclusive, RangeTo, RangeToInclusive};

#[macro_export]
macro_rules! s {
    ($($x:expr),*) => {
        [$($crate::util::index::Index::from($x)),*]
    };
}

#[derive(Clone)]
pub enum Index {
    Usize(usize),
    Range(Range<usize>),
    RangeFrom(RangeFrom<usize>),
    RangeFull(RangeFull),
    RangeInclusive(RangeInclusive<usize>),
    RangeTo(RangeTo<usize>),
    RangeToInclusive(RangeToInclusive<usize>),
}

pub(crate) trait Indexer: Clone {
    /// The resulting dimension of the axis indexed by this indexer.
    fn indexed_length(&self, axis_length: usize) -> usize;
    
    /// The first element along the dimension indexed by this kind of indexer
    /// For example, 0 for `ndarray [..]` or `ndarray [..2]` but 5 for `ndarray [5..]` or `ndarray [5]`
    fn index_of_first_element(&self) -> usize;

    /// When indexed with this kind of object, does the dimension of the ndarray collapse?
    /// Only true for usize since all range-based indexers retain the dimension.
    fn collapse_dimension(&self) -> bool {
        false
    }
}

impl Indexer for Index {
    fn indexed_length(&self, len: usize) -> usize {
        match self {
            Index::Usize(index) => Indexer::indexed_length(index, len),
            Index::Range(index) => Indexer::indexed_length(index, len),
            Index::RangeFrom(index) => Indexer::indexed_length(index, len),
            Index::RangeFull(index) => Indexer::indexed_length(index, len),
            Index::RangeInclusive(index) => Indexer::indexed_length(index, len),
            Index::RangeTo(index) => Indexer::indexed_length(index, len),
            Index::RangeToInclusive(index) => Indexer::indexed_length(index, len),
        }
    }

    fn index_of_first_element(&self) -> usize {
        match self {
            Index::Usize(index) => index.index_of_first_element(),
            Index::Range(index) => index.index_of_first_element(),
            Index::RangeFrom(index) => index.index_of_first_element(),
            Index::RangeFull(index) => index.index_of_first_element(),
            Index::RangeInclusive(index) => index.index_of_first_element(),
            Index::RangeTo(index) => index.index_of_first_element(),
            Index::RangeToInclusive(index) => index.index_of_first_element(),
        }
    }
    
    fn collapse_dimension(&self) -> bool {
        matches!(self, Index::Usize(_))
    }
}

impl Indexer for usize {
    fn indexed_length(&self, _axis_length: usize) -> usize {
        1
    }

    fn index_of_first_element(&self) -> usize {
        *self
    }

    fn collapse_dimension(&self) -> bool {
        true
    }
}
impl Indexer for Range<usize> {
    fn indexed_length(&self, _axis_length: usize) -> usize {
        self.end - self.start
    }

    fn index_of_first_element(&self) -> usize {
        self.start
    }
}
impl Indexer for RangeFull {
    fn indexed_length(&self, axis_length: usize) -> usize {
        axis_length
    }
    fn index_of_first_element(&self) -> usize {
        0
    }
}
impl Indexer for RangeFrom<usize> {
    fn indexed_length(&self, axis_length: usize) -> usize {
        axis_length - self.start
    }
    fn index_of_first_element(&self) -> usize {
        self.start
    }
}
impl Indexer for RangeTo<usize> {
    fn indexed_length(&self, _axis_length: usize) -> usize {
        self.end
    }
    fn index_of_first_element(&self) -> usize {
        0
    }
}
impl Indexer for RangeToInclusive<usize> {
    fn indexed_length(&self, _axis_length: usize) -> usize {
        self.end + 1
    }
    fn index_of_first_element(&self) -> usize {
        0
    }
}
impl Indexer for RangeInclusive<usize> {
    fn indexed_length(&self, _axis_length: usize) -> usize {
        self.end() - self.start() + 1
    }
    fn index_of_first_element(&self) -> usize {
        *self.start()
    }
}

impl From<usize> for Index {
    fn from(val: usize) -> Self {
        Index::Usize(val)
    }
}

impl From<Range<usize>> for Index {
    fn from(val: Range<usize>) -> Self {
        Index::Range(val)
    }
}

impl From<RangeFrom<usize>> for Index {
    fn from(val: RangeFrom<usize>) -> Self {
        Index::RangeFrom(val)
    }
}

impl From<RangeFull> for Index {
    fn from(val: RangeFull) -> Self {
        Index::RangeFull(val)
    }
}

impl From<RangeInclusive<usize>> for Index {
    fn from(val: RangeInclusive<usize>) -> Self {
        Index::RangeInclusive(val)
    }
}

impl From<RangeTo<usize>> for Index {
    fn from(val: RangeTo<usize>) -> Self {
        Index::RangeTo(val)
    }
}

impl From<RangeToInclusive<usize>> for Index {
    fn from(val: RangeToInclusive<usize>) -> Self {
        Index::RangeToInclusive(val)
    }
}