easy-ml 2.1.0

Machine learning library providing matrices, named tensors, linear algebra and automatic differentiation aimed at being easy to use
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

/*!
 * Trait implementations for [TensorRef] and [TensorMut].
 *
 * These implementations are written here but Rust docs will display them on the
 * traits' pages.
 *
 * An owned or referenced [Tensor] is a TensorRef, and a TensorMut if not a shared
 * reference, Therefore, you can pass a Tensor to any function which takes a TensorRef.
 *
 * Boxed TensorRef and TensorMut values also implement TensorRef and TensorMut respectively.
 */

use crate::tensors::Dimension;
#[allow(unused_imports)] // used in doc links
use crate::tensors::Tensor;
use crate::tensors::views::{DataLayout, TensorMut, TensorRef};

// # Safety
//
// The type implementing TensorRef must implement it correctly, so by delegating to it
// without changing any indexes or introducing interior mutability, we implement TensorRef
// correctly as well.
/**
 * If some type implements TensorRef, then a reference to it implements TensorRef as well
 */
unsafe impl<T, S, const D: usize> TensorRef<T, D> for &S
where
    S: TensorRef<T, D>,
{
    fn get_reference(&self, indexes: [usize; D]) -> Option<&T> {
        TensorRef::get_reference(*self, indexes)
    }

    fn view_shape(&self) -> [(Dimension, usize); D] {
        TensorRef::view_shape(*self)
    }

    unsafe fn get_reference_unchecked(&self, indexes: [usize; D]) -> &T {
        unsafe { TensorRef::get_reference_unchecked(*self, indexes) }
    }

    fn data_layout(&self) -> DataLayout<D> {
        TensorRef::data_layout(*self)
    }
}

// # Safety
//
// The type implementing TensorRef must implement it correctly, so by delegating to it
// without changing any indexes or introducing interior mutability, we implement TensorRef
// correctly as well.
/**
 * If some type implements TensorRef, then an exclusive reference to it implements TensorRef
 * as well
 */
unsafe impl<T, S, const D: usize> TensorRef<T, D> for &mut S
where
    S: TensorRef<T, D>,
{
    fn get_reference(&self, indexes: [usize; D]) -> Option<&T> {
        TensorRef::get_reference(*self, indexes)
    }

    fn view_shape(&self) -> [(Dimension, usize); D] {
        TensorRef::view_shape(*self)
    }

    unsafe fn get_reference_unchecked(&self, indexes: [usize; D]) -> &T {
        unsafe { TensorRef::get_reference_unchecked(*self, indexes) }
    }

    fn data_layout(&self) -> DataLayout<D> {
        TensorRef::data_layout(*self)
    }
}

// # Safety
//
// The type implementing TensorMut must implement it correctly, so by delegating to it
// without changing any indexes or introducing interior mutability, we implement TensorMut
// correctly as well.
/**
 * If some type implements TensorMut, then an exclusive reference to it implements TensorMut
 * as well
 */
unsafe impl<T, S, const D: usize> TensorMut<T, D> for &mut S
where
    S: TensorMut<T, D>,
{
    fn get_reference_mut(&mut self, indexes: [usize; D]) -> Option<&mut T> {
        TensorMut::get_reference_mut(*self, indexes)
    }

    unsafe fn get_reference_unchecked_mut(&mut self, indexes: [usize; D]) -> &mut T {
        unsafe { TensorMut::get_reference_unchecked_mut(*self, indexes) }
    }
}

// # Safety
//
// The type implementing TensorRef must implement it correctly, so by delegating to it
// without changing any indexes or introducing interior mutability, we implement TensorRef
// correctly as well.
/**
 * A box of a TensorRef also implements TensorRef.
 */
unsafe impl<T, S, const D: usize> TensorRef<T, D> for Box<S>
where
    S: TensorRef<T, D>,
{
    fn get_reference(&self, indexes: [usize; D]) -> Option<&T> {
        self.as_ref().get_reference(indexes)
    }

    fn view_shape(&self) -> [(Dimension, usize); D] {
        self.as_ref().view_shape()
    }

    unsafe fn get_reference_unchecked(&self, indexes: [usize; D]) -> &T {
        unsafe { self.as_ref().get_reference_unchecked(indexes) }
    }

    fn data_layout(&self) -> DataLayout<D> {
        self.as_ref().data_layout()
    }
}

// # Safety
//
// The type implementing TensorMut must implement it correctly, so by delegating to it
// without changing any indexes or introducing interior mutability, we implement TensorMut
// correctly as well.
/**
 * A box of a TensorMut also implements TensorMut.
 */
unsafe impl<T, S, const D: usize> TensorMut<T, D> for Box<S>
where
    S: TensorMut<T, D>,
{
    fn get_reference_mut(&mut self, indexes: [usize; D]) -> Option<&mut T> {
        self.as_mut().get_reference_mut(indexes)
    }

    unsafe fn get_reference_unchecked_mut(&mut self, indexes: [usize; D]) -> &mut T {
        unsafe { self.as_mut().get_reference_unchecked_mut(indexes) }
    }
}

// # Safety
//
// The type implementing TensorRef must implement it correctly, so by delegating to it
// without changing any indexes or introducing interior mutability, we implement TensorRef
// correctly as well.
/**
 * A box of a dynamic TensorRef also implements TensorRef.
 */
unsafe impl<T, const D: usize> TensorRef<T, D> for Box<dyn TensorRef<T, D>> {
    fn get_reference(&self, indexes: [usize; D]) -> Option<&T> {
        self.as_ref().get_reference(indexes)
    }

    fn view_shape(&self) -> [(Dimension, usize); D] {
        self.as_ref().view_shape()
    }

    unsafe fn get_reference_unchecked(&self, indexes: [usize; D]) -> &T {
        unsafe { self.as_ref().get_reference_unchecked(indexes) }
    }

    fn data_layout(&self) -> DataLayout<D> {
        self.as_ref().data_layout()
    }
}

// # Safety
//
// The type implementing TensorMut must implement TensorRef correctly, so by delegating to it
// without changing any indexes or introducing interior mutability, we implement TensorRef
// correctly as well.
/**
 * A box of a dynamic TensorMut also implements TensorRef.
 */
unsafe impl<T, const D: usize> TensorRef<T, D> for Box<dyn TensorMut<T, D>> {
    fn get_reference(&self, indexes: [usize; D]) -> Option<&T> {
        self.as_ref().get_reference(indexes)
    }

    fn view_shape(&self) -> [(Dimension, usize); D] {
        self.as_ref().view_shape()
    }

    unsafe fn get_reference_unchecked(&self, indexes: [usize; D]) -> &T {
        unsafe { self.as_ref().get_reference_unchecked(indexes) }
    }

    fn data_layout(&self) -> DataLayout<D> {
        self.as_ref().data_layout()
    }
}

// # Safety
//
// The type implementing TensorMut must implement it correctly, so by delegating to it
// without changing any indexes or introducing interior mutability, we implement TensorMut
// correctly as well.
/**
 * A box of a dynamic TensorMut also implements TensorMut.
 */
unsafe impl<T, const D: usize> TensorMut<T, D> for Box<dyn TensorMut<T, D>> {
    fn get_reference_mut(&mut self, indexes: [usize; D]) -> Option<&mut T> {
        self.as_mut().get_reference_mut(indexes)
    }

    unsafe fn get_reference_unchecked_mut(&mut self, indexes: [usize; D]) -> &mut T {
        unsafe { self.as_mut().get_reference_unchecked_mut(indexes) }
    }
}