mathol 0.1.1

Math library in 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

use num::{Num, FromPrimitive};
use basics::pow;
use basics::convert_trait::Convert;
use std::f64;
use error::*;

/// Calculates the arithmetic mean of a slice of Numbers
/// # Remarks
/// Returns a f64 value if the slice contains numbers or an error message if the slice is empty
/// # Examples
/// ```
/// use mathol::statistics::get_arithmetic_mean;
///
/// let vec = vec![9.8, 10.1, 10.3, 10.2, 10.2, 10.0, 9.9, 10.3];
/// assert_eq!(10.1, get_arithmetic_mean(&vec).unwrap());
///
/// let arr = [8, 6, 5, 11, 6, 6];
/// assert_eq!(7.0, get_arithmetic_mean(&arr).unwrap());
/// ```
pub fn get_arithmetic_mean<T>(data: &[T]) -> Result<f64, MatholError>
    where T: Num + Convert + Copy
{
    let n = data.iter().len();

    match n {
        0 => Err(MatholError::EmptyVecCause(EmptyVectorError {
            message: "Vector or Array is empty".to_string(),
        })),
        _ => {
            let sum = data.iter().fold(T::zero(), |sum, x| sum + *x);
            let arithmetic_mean = sum.to_f64() / n.to_f64();
            Ok(arithmetic_mean)
        },
    }
}

/// Calculates the harmonic mean of a slice of Numbers
/// # Remarks
/// Returns a f64 value if the slice contains numbers or an error message if the slice is empty or if it contains a zero
/// # Examples
/// ```
/// use mathol::statistics::get_harmonic_mean;
///
/// let vec = vec![9.8, 10.1, 10.3, 10.2, 10.2, 10.0, 9.9, 10.3];
/// assert_eq!(10.097006905739999, get_harmonic_mean(&vec).unwrap());
///
/// let vec = vec![8, 6, 5, 11, 6, 6];
/// assert_eq!(6.550868486352359, get_harmonic_mean(&vec).unwrap());
/// ```
pub fn get_harmonic_mean<T>(data: &[T]) -> Result<f64, MatholError>
    where T: Num + Convert + Copy + PartialEq
{
    let n = data.iter().len();

    match n {
        0 => Err(MatholError::EmptyVecCause(EmptyVectorError {
            message: "Vector or Array is empty".to_string(),
        })),
        _ => {
            if data.contains(&T::zero()) {
                return Err(MatholError::ContainsZeroCause(ContainsZeroError {
                    message: "Vector or Array contains zero".to_string(),
                }));
            }

            let sum = data.iter().fold(0.0, |sum, x| sum + 1.0 / x.to_f64());
            let harmonic_mean = 1.0 / (sum / n.to_f64());
            Ok(harmonic_mean)
        }
    }
}

/// Calculates the quadratic mean of a slice of Numbers
/// # Remarks
/// Returns a f64 value if the slice contains numbers or an error message if the slice is empty
/// # Examples
/// ```
/// use mathol::statistics::get_quadratic_mean;
///
/// let vec = vec![9.8, 10.1, 10.3, 10.2, 10.2, 10.0, 9.9, 10.3];
/// assert_eq!(10.101485039339513, get_quadratic_mean(&vec).unwrap());
///
/// let vec = vec![8, 6, 5, 11, 6, 6];
/// assert_eq!(7.280109889280518, get_quadratic_mean(&vec).unwrap());
/// ```
pub fn get_quadratic_mean<T>(data: &[T]) -> Result<f64, MatholError>
    where T: Num + Convert + Copy + PartialEq
{
    let n = data.iter().len();

    match n {
        0 => Err(MatholError::EmptyVecCause(EmptyVectorError {
            message: "Vector or Array is empty".to_string(),
        })),
        _ => {
            let sum = data.iter().fold(T::zero(), |sum, x| sum + *x * *x);
            let quadratic_mean = (sum.to_f64() / n.to_f64()).sqrt();
            Ok(quadratic_mean )
        }
    }
}

/// Calculates the variance of a slice of Numbers
/// # Remarks
/// Returns a f64 value if the slice contains numbers or an error message if the slice is empty
/// # Examples
/// ```
/// use mathol::statistics::get_variance;
///
/// let vec = vec![9.8, 10.1, 10.3, 10.2, 10.2, 10.0, 9.9, 10.3];
/// assert_eq!(0.034285714285714246, get_variance(&vec).unwrap());
///
/// let vec = vec![8, 6, 5, 11, 6, 6];
/// assert_eq!(4.8, get_variance(&vec).unwrap());
/// ```
pub fn get_variance<T>(data: &[T]) -> Result<f64, MatholError>
    where T: Num + Convert + Copy + FromPrimitive
{
    let n = data.iter().len();

    match n {
        0 => Err(MatholError::EmptyVecCause(EmptyVectorError {
            message: "Vector or Array is empty".to_string(),
        })),
        _ => {
            let mean = FromPrimitive::from_f64(get_arithmetic_mean(data)?);
            let a = data.iter().fold(T::zero(), |sum, x| sum + pow((*x - mean.unwrap()), 2));
            Ok(a.to_f64() / (n - 1).to_f64())
        }
    }
}

/// Calculates the standard deviation of a slice of Numbers
/// # Remarks
/// Returns a f64 value if the slice contains numbers or an error message if the slice is empty
/// # Examples
/// ```
/// use mathol::statistics::get_standard_deviation;
///
/// let vec = vec![9.8, 10.1, 10.3, 10.2, 10.2, 10.0, 9.9, 10.3];
/// assert_eq!(0.18516401995451018, get_standard_deviation(&vec).unwrap());
///
/// let vec = vec![8, 6, 5, 11, 6, 6];
/// assert_eq!(2.1908902300206643, get_standard_deviation(&vec).unwrap());
/// ```
pub fn get_standard_deviation<T>(data: &[T]) -> Result<f64, MatholError>
    where T: Num + Convert + Copy + FromPrimitive
{
    let n = data.iter().len();

    match n {
        0 => Err(MatholError::EmptyVecCause(EmptyVectorError {
            message: "Vector or Array is empty".to_string(),
        })),
        _ => Ok(get_variance(data)?.sqrt()),
    }
}

/// # Remarks
/// Returns the minimum value of a slice or an error message it the slice is empty
/// # Examples
/// ```
/// use mathol::statistics::get_min;
///
/// let vec = vec![9.8, 10.1, 10.3, 10.2, 10.2, 10.0, 9.9, 10.3];
/// assert_eq!(9.8, get_min(&vec).unwrap());
///
/// let vec = vec![8, 6, 5, 11, 6, 6];
/// assert_eq!(5, get_min(&vec).unwrap());
/// ```
pub fn get_min<T>(data: &[T]) -> Result<T, MatholError>
    where T: Num + Convert + Copy + FromPrimitive + PartialOrd
{
    match data.iter().len() {
        0 => Err(MatholError::EmptyVecCause(EmptyVectorError {
            message: "Vector or Array is empty".to_string(),
        })),
        _ => {
            let min = data.iter().fold(data[0], |mut min, x| {
                if *x < min {
                    min = *x;
                }

                min
            });

            Ok(min)
        }
    }
}

/// # Remarks
/// Returns the maximum value of a slice or an error message it the slice is empty
/// # Examples
/// ```
/// use mathol::statistics::get_max;
///
/// let vec = vec![9.8, 10.1, 10.3, 10.2, 10.2, 10.0, 9.9, 10.3];
/// assert_eq!(10.3, get_max(&vec).unwrap());
///
/// let vec = vec![8, 6, 5, 11, 6, 6];
/// assert_eq!(11, get_max(&vec).unwrap());
/// ```
pub fn get_max<T>(data: &[T]) -> Result<T, MatholError>
    where T: Num + Convert + Copy + FromPrimitive + PartialOrd
{
    match data.iter().len() {
        0 => Err(MatholError::EmptyVecCause(EmptyVectorError {
            message: "Vector or Array is empty".to_string(),
        })),
        _ => {
            let max = data.iter().fold(data[0], |mut max, x| {
                if *x > max {
                    max = *x;
                }

                max
            });

            Ok(max)
        }
    }
}

/// # Remarks
/// Returns the difference between the minimum and maximum of a slice or an error message it the slice is empty
/// # Examples
/// ```
/// use mathol::statistics::get_span;
///
/// let vec = vec![9.8, 10.1, 10.3, 10.2, 10.2, 10.0, 9.9, 10.3];
/// assert_eq!(0.5, get_span(&vec).unwrap());
///
/// let vec = vec![8, 6, 5, 11, 6, 6];
/// assert_eq!(6, get_span(&vec).unwrap());
/// ```
pub fn get_span<T>(data: &[T]) -> Result<T, MatholError>
    where T: Num + Convert + Copy + FromPrimitive + PartialOrd
{
    match data.iter().len() {
        0 => Err(MatholError::EmptyVecCause(EmptyVectorError {
            message: "Vector or Array is empty".to_string(),
        })),
        _ => Ok(get_max(data)? - get_min(data)?),
    }
}