matten 0.10.0

A family car multidimensional array (tensor) library for small numerical trials / PoCs.
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

//! Scalar arithmetic operators: `&Tensor op f64` and `f64 op &Tensor` (RFC-006).
//!
//! The scalar-on-left forms (`f64 op &Tensor`) are legal under Rust's coherence
//! rules: `&Tensor` is a local type in the trait's parameter position, so a
//! concrete `impl Add<&Tensor> for f64` does not violate the orphan rule. Only a
//! generic blanket `impl<T> Add<&Tensor> for T` would.

use crate::Tensor;
use std::ops::{Add, Div, Mul, Sub};

// ---- &Tensor op f64 ---------------------------------------------------

impl Add<f64> for &Tensor {
    type Output = Tensor;
    /// Adds a scalar to every element.
    ///
    /// ```
    /// use matten::Tensor;
    /// let t = Tensor::new(vec![1.0, 2.0, 3.0], &[3]);
    /// let r = &t + 10.0;
    /// assert_eq!(r.as_slice(), &[11.0, 12.0, 13.0]);
    /// ```
    fn add(self, rhs: f64) -> Tensor {
        Tensor {
            data: self.data.iter().map(|&v| v + rhs).collect(),
            shape: self.shape.clone(),
            #[cfg(feature = "dynamic")]
            dynamic: None,
        }
    }
}

impl Sub<f64> for &Tensor {
    type Output = Tensor;
    /// Subtracts a scalar from every element.
    ///
    /// ```
    /// use matten::Tensor;
    /// let t = Tensor::new(vec![5.0, 3.0, 1.0], &[3]);
    /// let r = &t - 1.0;
    /// assert_eq!(r.as_slice(), &[4.0, 2.0, 0.0]);
    /// ```
    fn sub(self, rhs: f64) -> Tensor {
        Tensor {
            data: self.data.iter().map(|&v| v - rhs).collect(),
            shape: self.shape.clone(),
            #[cfg(feature = "dynamic")]
            dynamic: None,
        }
    }
}

impl Mul<f64> for &Tensor {
    type Output = Tensor;
    /// Multiplies every element by a scalar.
    ///
    /// ```
    /// use matten::Tensor;
    /// let t = Tensor::new(vec![1.0, 2.0, 3.0], &[3]);
    /// let r = &t * 3.0;
    /// assert_eq!(r.as_slice(), &[3.0, 6.0, 9.0]);
    /// ```
    fn mul(self, rhs: f64) -> Tensor {
        Tensor {
            data: self.data.iter().map(|&v| v * rhs).collect(),
            shape: self.shape.clone(),
            #[cfg(feature = "dynamic")]
            dynamic: None,
        }
    }
}

impl Div<f64> for &Tensor {
    type Output = Tensor;
    /// Divides every element by a scalar. Division by zero follows IEEE 754.
    ///
    /// ```
    /// use matten::Tensor;
    /// let t = Tensor::new(vec![6.0, 4.0, 2.0], &[3]);
    /// let r = &t / 2.0;
    /// assert_eq!(r.as_slice(), &[3.0, 2.0, 1.0]);
    /// ```
    fn div(self, rhs: f64) -> Tensor {
        Tensor {
            data: self.data.iter().map(|&v| v / rhs).collect(),
            shape: self.shape.clone(),
            #[cfg(feature = "dynamic")]
            dynamic: None,
        }
    }
}

// ---- f64 op &Tensor ---------------------------------------------------

impl Add<&Tensor> for f64 {
    type Output = Tensor;
    /// Adds every element of the tensor to a scalar (`scalar + &tensor`).
    ///
    /// ```
    /// use matten::Tensor;
    /// let t = Tensor::new(vec![1.0, 2.0, 3.0], &[3]);
    /// let r = 10.0 + &t;
    /// assert_eq!(r.as_slice(), &[11.0, 12.0, 13.0]);
    /// ```
    fn add(self, rhs: &Tensor) -> Tensor {
        Tensor {
            data: rhs.data.iter().map(|&v| self + v).collect(),
            shape: rhs.shape.clone(),
            #[cfg(feature = "dynamic")]
            dynamic: None,
        }
    }
}

impl Sub<&Tensor> for f64 {
    type Output = Tensor;
    /// Subtracts each tensor element from a scalar (`scalar - &tensor`).
    ///
    /// ```
    /// use matten::Tensor;
    /// let t = Tensor::new(vec![1.0, 2.0, 3.0], &[3]);
    /// let r = 10.0 - &t;
    /// assert_eq!(r.as_slice(), &[9.0, 8.0, 7.0]);
    /// ```
    fn sub(self, rhs: &Tensor) -> Tensor {
        Tensor {
            data: rhs.data.iter().map(|&v| self - v).collect(),
            shape: rhs.shape.clone(),
            #[cfg(feature = "dynamic")]
            dynamic: None,
        }
    }
}

impl Mul<&Tensor> for f64 {
    type Output = Tensor;
    /// Multiplies every element of the tensor by a scalar (`scalar * &tensor`).
    ///
    /// ```
    /// use matten::Tensor;
    /// let t = Tensor::new(vec![1.0, 2.0, 3.0], &[3]);
    /// let r = 3.0 * &t;
    /// assert_eq!(r.as_slice(), &[3.0, 6.0, 9.0]);
    /// ```
    fn mul(self, rhs: &Tensor) -> Tensor {
        Tensor {
            data: rhs.data.iter().map(|&v| self * v).collect(),
            shape: rhs.shape.clone(),
            #[cfg(feature = "dynamic")]
            dynamic: None,
        }
    }
}

impl Div<&Tensor> for f64 {
    type Output = Tensor;
    /// Divides a scalar by each tensor element (`scalar / &tensor`). Division by
    /// zero follows IEEE 754.
    ///
    /// ```
    /// use matten::Tensor;
    /// let t = Tensor::new(vec![2.0, 4.0, 8.0], &[3]);
    /// let r = 16.0 / &t;
    /// assert_eq!(r.as_slice(), &[8.0, 4.0, 2.0]);
    /// ```
    fn div(self, rhs: &Tensor) -> Tensor {
        Tensor {
            data: rhs.data.iter().map(|&v| self / v).collect(),
            shape: rhs.shape.clone(),
            #[cfg(feature = "dynamic")]
            dynamic: None,
        }
    }
}