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
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

use std::ptr::addr_of;
use crate::collapse_contiguous::collapse_to_uniform_stride;
use crate::flat_index_generator::FlatIndexGenerator;
use paste::paste;
use std::ops::{BitAnd, BitOr, Rem, Shl, Shr};


#[macro_export]
macro_rules! define_binary_op_trait {
    ($trait_name:ident, $required_trait:ident, $name:ident, $operator:tt; $($default_dtypes:ty),*) => {
        define_binary_op_trait!($trait_name, $required_trait, $name, $operator);
        impl_default_trait_for_dtypes!($trait_name, $($default_dtypes),*);
    };

    ($trait_name:ident, $required_trait:ident, $name:ident, $operator:tt) => {
        paste! {
            pub(crate) trait $trait_name: $required_trait<Output=Self> + Sized + Copy {
                unsafe fn [<$name _stride_0_1>](lhs: *const Self,
                                                rhs: *const Self,
                                                dst: *mut Self, count: usize) {
                    Self::[<$name _stride_n_n>](lhs, 0, rhs, 1, dst, count)
                }

                unsafe fn [<$name _stride_1_0>](lhs: *const Self,
                                                rhs: *const Self, dst: *mut Self, count: usize) {
                    Self::[<$name _stride_n_n>](lhs, 1, rhs, 0, dst, count)
                }

                unsafe fn [<$name _stride_n_0>](lhs: *const Self, lhs_stride: usize,
                                                rhs: *const Self, dst: *mut Self, count: usize) {
                    Self::[<$name _stride_n_n>](lhs, lhs_stride, rhs, 0, dst, count)
                }

                unsafe fn [<$name _stride_0_n>](lhs: *const Self,
                                                rhs: *const Self, rhs_stride: usize,
                                                dst: *mut Self, count: usize) {
                    Self::[<$name _stride_n_n>](lhs, 0, rhs, rhs_stride, dst, count)
                }

                unsafe fn [<$name _stride_1_1>](lhs: *const Self, rhs: *const Self, dst: *mut Self, count: usize) {
                    Self::[<$name _stride_n_n>](lhs, 1, rhs, 1, dst, count)
                }

                unsafe fn [<$name _stride_n_1>](lhs: *const Self, lhs_stride: usize,
                                                rhs: *const Self, dst: *mut Self, count: usize) {
                    Self::[<$name _stride_n_n>](lhs, lhs_stride, rhs, 1, dst, count)
                }

                unsafe fn [<$name _stride_1_n>](lhs: *const Self,
                                                rhs: *const Self, rhs_stride: usize,
                                                dst: *mut Self, count: usize) {
                    Self::[<$name _stride_n_n>](lhs, 1, rhs, rhs_stride, dst, count)
                }

                #[inline(never)]
                unsafe fn [<$name _stride_n_n>](mut lhs: *const Self, lhs_stride: usize,
                                                mut rhs: *const Self, rhs_stride: usize,
                                                mut dst: *mut Self, mut count: usize) {
                    while count != 0 {
                        *dst = *lhs $operator *rhs;

                        count -= 1;
                        lhs = lhs.add(lhs_stride);
                        rhs = rhs.add(rhs_stride);
                        dst = dst.add(1);
                    }
                }

                unsafe fn [<$name _nonunif_0>](lhs: *const Self, lhs_shape: &[usize], lhs_stride: &[usize],
                                               rhs: *const Self,
                                               dst: *mut Self, count: usize) {
                    Self::[<$name _nonunif_n>](lhs, lhs_shape, lhs_stride, rhs, 0, dst, count)
                }

                unsafe fn [<$name _0_nonunif>](lhs: *const Self,
                                               rhs: *const Self, rhs_shape: &[usize], rhs_stride: &[usize],
                                               dst: *mut Self, count: usize) {
                    Self::[<$name _n_nonunif>](lhs, 0, rhs, rhs_shape, rhs_stride, dst, count)
                }

                unsafe fn [<$name _nonunif_1>](lhs: *const Self, lhs_shape: &[usize], lhs_stride: &[usize],
                                               rhs: *const Self,
                                               dst: *mut Self, count: usize) {
                    Self::[<$name _nonunif_n>](lhs, lhs_shape, lhs_stride, rhs, 1, dst, count)
                }

                unsafe fn [<$name _1_nonunif>](lhs: *const Self,
                                               rhs: *const Self, rhs_shape: &[usize], rhs_stride: &[usize],
                                               dst: *mut Self, count: usize) {
                    Self::[<$name _n_nonunif>](lhs, 1, rhs, rhs_shape, rhs_stride, dst, count)
                }

                unsafe fn [<$name _nonunif_n>](lhs: *const Self, lhs_shape: &[usize], lhs_stride: &[usize],
                                               mut rhs: *const Self, rhs_stride: usize,
                                               mut dst: *mut Self, mut count: usize) {
                    let mut lhs_indices = FlatIndexGenerator::from(lhs_shape, lhs_stride);

                    while count != 0 {
                        let lhs_index = lhs_indices.next().unwrap_unchecked();
                        *dst = *lhs.add(lhs_index) $operator *rhs;

                        count -= 1;
                        dst = dst.add(1);
                        rhs = rhs.add(rhs_stride);
                    }
                }

                unsafe fn [<$name _n_nonunif>](mut lhs: *const Self, lhs_stride: usize,
                                               rhs: *const Self, rhs_shape: &[usize], rhs_stride: &[usize],
                                               mut dst: *mut Self, mut count: usize) {
                    let mut rhs_indices = FlatIndexGenerator::from(rhs_shape, rhs_stride);

                    while count != 0 {
                        let rhs_index = rhs_indices.next().unwrap_unchecked();
                        *dst = *lhs $operator *rhs.add(rhs_index);

                        count -= 1;
                        dst = dst.add(1);
                        lhs = lhs.add(lhs_stride);
                    }
                }

                unsafe fn [<$name _unspecialized>](lhs: *const Self, lhs_shape: &[usize], lhs_stride: &[usize],
                                                   rhs: *const Self, rhs_shape: &[usize], rhs_stride: &[usize],
                                                   mut dst: *mut Self) {
                    let lhs_indices = FlatIndexGenerator::from(lhs_shape, lhs_stride);
                    let rhs_indices = FlatIndexGenerator::from(rhs_shape, rhs_stride);

                    for (lhs_index, rhs_index) in lhs_indices.zip(rhs_indices) {
                        *dst = *lhs.add(lhs_index) $operator *rhs.add(rhs_index);
                        dst = dst.add(1);
                    }
                }

                unsafe fn [<$name _scalar>](lhs: *const Self, lhs_shape: &[usize], lhs_stride: &[usize],
                                            rhs: Self, dst: *mut Self) {
                    // special case for scalar operands
                    if lhs_stride.is_empty() {
                        *dst = *lhs $operator rhs;
                        return;
                    }

                    let rhs = addr_of!(rhs);

                    let (lhs_shape, lhs_stride) = collapse_to_uniform_stride(lhs_shape, &lhs_stride);
                    let lhs_dims = lhs_shape.len();
                    let lhs_inner_stride = lhs_stride[lhs_dims - 1];

                    if lhs_dims == 1 {
                        if lhs_inner_stride == 1 {
                            return Self::[<$name _stride_1_0>](lhs, rhs, dst, lhs_shape[0]);
                        }
                        else {
                            return Self::[<$name _stride_n_0>](lhs, lhs_inner_stride, rhs, dst, lhs_shape[0]);
                        }
                    }

                    let count = lhs_shape.iter().product();
                    return Self::[<$name _nonunif_0>](lhs, &lhs_shape, &lhs_stride, rhs, dst, count);
                }

                unsafe fn $name(lhs: *const Self, lhs_stride: &[usize],
                                rhs: *const Self, rhs_stride: &[usize],
                                dst: *mut Self, shape: &[usize]) {
                    // special case for scalar operands
                    if lhs_stride.is_empty() && rhs_stride.is_empty() {
                        *dst = *lhs $operator *rhs;
                        return;
                    }

                    let (lhs_shape, lhs_stride) = collapse_to_uniform_stride(shape, &lhs_stride);
                    let (rhs_shape, rhs_stride) = collapse_to_uniform_stride(shape, &rhs_stride);

                    let lhs_dims = lhs_shape.len();
                    let rhs_dims = rhs_shape.len();

                    let lhs_inner_stride = lhs_stride[lhs_dims - 1];
                    let rhs_inner_stride = rhs_stride[rhs_dims - 1];

                    if lhs_dims == 1 && rhs_dims == 1 { // both operands have a uniform stride

                        // one operand is a scalar
                        if rhs_inner_stride == 0 {
                            if lhs_inner_stride == 1 {
                                return Self::[<$name _stride_1_0>](lhs, rhs, dst, lhs_shape[0]);
                            }
                            else {
                                return Self::[<$name _stride_n_0>](lhs, lhs_inner_stride, rhs, dst, lhs_shape[0]);
                            }

                        } else if lhs_inner_stride == 0 {
                            if rhs_inner_stride == 1 {
                                return Self::[<$name _stride_0_1>](lhs, rhs, dst, rhs_shape[0]);
                            }
                            else {
                                return Self::[<$name _stride_0_n>](lhs, rhs, rhs_inner_stride, dst, rhs_shape[0]);
                            }
                        }

                        // both operands are contiguous
                        if lhs_inner_stride == 1 && rhs_inner_stride == 1 {
                            return Self::[<$name _stride_1_1>](lhs, rhs, dst, lhs_shape[0]);
                        }

                        if lhs_inner_stride == 1 {
                            return Self::[<$name _stride_1_n>](lhs, rhs, rhs_inner_stride, dst, lhs_shape[0]);
                        }
                        else if rhs_inner_stride == 1 {
                            return Self::[<$name _stride_n_1>](lhs, lhs_inner_stride, rhs, dst, rhs_shape[0]);
                        }

                        // neither element is contiguous
                        return Self::[<$name _stride_n_n>](lhs, lhs_inner_stride, rhs, rhs_inner_stride, dst, lhs_shape[0]);
                    }

                    // only 1 operand has a uniform stride
                    if rhs_dims == 1 && rhs_inner_stride == 0 {
                        return Self::[<$name _nonunif_0>](lhs, &lhs_shape, &lhs_stride,
                                                          rhs, dst, rhs_shape[0]);
                    } else if lhs_dims == 1 && lhs_inner_stride == 0 {
                        return Self::[<$name _0_nonunif>](lhs,
                                                          rhs, &rhs_shape, &rhs_stride,
                                                          dst, lhs_shape[0]);
                    }

                    if rhs_dims == 1 && rhs_inner_stride == 1 {
                        return Self::[<$name _nonunif_1>](lhs, &lhs_shape, &lhs_stride,
                                                          rhs, dst, rhs_shape[0]);
                    } else if lhs_dims == 1 && lhs_inner_stride == 1 {
                        return Self::[<$name _1_nonunif>](lhs,
                                                          rhs, &rhs_shape, &rhs_stride,
                                                          dst, lhs_shape[0]);
                    }

                    if rhs_dims == 1 {
                        return Self::[<$name _nonunif_n>](lhs, &lhs_shape, &lhs_stride,
                                                          rhs, rhs_inner_stride,
                                                          dst, rhs_shape[0]);
                    } else if lhs_dims == 1 {
                        return Self::[<$name _n_nonunif>](lhs, lhs_inner_stride,
                                                          rhs, &rhs_shape, &rhs_stride,
                                                          dst, lhs_shape[0]);
                    }

                    // unspecialized loop
                    Self::[<$name _unspecialized>](lhs, &lhs_shape, &lhs_stride,
                                                   rhs, &rhs_shape, &rhs_stride,
                                                   dst);
                }
            }
        }
    }
}

define_binary_op_trait!(BinaryOpRem, Rem, rem, %;
                        i8, i16, i32, i64, i128, isize,
                        u8, u16, u32, u64, u128, usize,
                        f32, f64);

define_binary_op_trait!(BinaryOpBitAnd, BitAnd, bitand, &;
                        i8, i16, i32, i64, i128, isize,
                        u8, u16, u32, u64, u128, usize);

define_binary_op_trait!(BinaryOpBitOr, BitOr, bitor, |;
                        i8, i16, i32, i64, i128, isize,
                        u8, u16, u32, u64, u128, usize);

define_binary_op_trait!(BinaryOpShl, Shl, shl, <<;
                        i8, i16, i32, i64, i128, isize,
                        u8, u16, u32, u64, u128, usize);

define_binary_op_trait!(BinaryOpShr, Shr, shr, >>;
                        i8, i16, i32, i64, i128, isize,
                        u8, u16, u32, u64, u128, usize);