datas 0.1.8

A library for data structures and algorithms and data analisys
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345

use std::ops::Mul;

/// This enum represents possible errors that can happen during usage of the library.
#[derive(Debug, PartialEq)]
pub enum VectorError {
    DimensionMismatch,
}

/// Vector struct with private fields
#[derive(Debug, PartialEq)]
pub struct Vector<T> {
    /// Stores information about components of Vector inside well Vector
    components: Vec<T>,
    dimensions: u64,
}

impl Vector<i64> {
    /// Public constructor of Vector
    /// ```
    /// use datas::vector::Vector;
    /// let i_vector = Vector::<i64>::new(vec![3, 4]);
    /// ```
    pub fn new(components: Vec<i64>) -> Self {
        let dimensions = components.len() as u64;
        Self {
            components,
            dimensions,
        }
    }

    pub fn magnitude(&self) -> f64 {
        self.components
            .iter()
            .map(|&component| (component as f64).powi(2))
            .sum::<f64>()
            .sqrt()
    }

    /// Addition method that mutates vector similar to AddAssign trait
    pub fn add(&mut self, vector: &Vector<i64>) -> Result<(), VectorError> {
        if self.dimensions == vector.dimensions {
            for (index, component) in self.components.iter_mut().enumerate() {
                *component += vector.components[index];
            }
            return Ok(());
        } else {
            return Err(VectorError::DimensionMismatch);
        }
    }

    pub fn dot_product(&self, vector: &Vector<i64>) -> Result<i64, VectorError> {
        if self.dimensions != vector.dimensions {
            return Err(VectorError::DimensionMismatch);
        }
        Ok(self
            .components
            .iter()
            .zip(&vector.components)
            .map(|(a, b)| a * b)
            .sum())
    }
}

impl Mul<i64> for Vector<i64> {
    type Output = Vector<i64>;

    fn mul(mut self, scalar: i64) -> Vector<i64> {
        self.components
            .iter_mut()
            .for_each(|component| *component *= scalar);
        self
    }
}

impl Vector<f64> {
    pub fn new(components: Vec<f64>) -> Self {
        let dimensions = components.len() as u64;
        Self {
            components,
            dimensions,
        }
    }

    pub fn magnitude(&self) -> f64 {
        self.components
            .iter()
            .map(|&component| component.powi(2))
            .sum::<f64>()
            .sqrt()
    }

    pub fn add_i(&mut self, vector: &Vector<i64>) -> Result<(), VectorError> {
        if self.dimensions == vector.dimensions {
            for (index, component) in self.components.iter_mut().enumerate() {
                *component += vector.components[index] as f64;
            }
            return Ok(());
        } else {
            return Err(VectorError::DimensionMismatch);
        }
    }

    pub fn add_f(&mut self, vector: &Vector<f64>) -> Result<(), VectorError> {
        if self.dimensions == vector.dimensions {
            for (index, component) in self.components.iter_mut().enumerate() {
                *component += vector.components[index];
            }
            return Ok(());
        } else {
            return Err(VectorError::DimensionMismatch);
        }
    }

    pub fn dot_product_i(&self, vector: &Vector<i64>) -> Result<f64, VectorError> {
        if self.dimensions != vector.dimensions {
            return Err(VectorError::DimensionMismatch);
        }
        Ok(self
            .components
            .iter()
            .zip(&vector.components)
            .map(|(a, b)| a * (*b as f64))
            .sum())
    }

    pub fn dot_product_f(&self, vector: &Vector<f64>) -> Result<f64, VectorError> {
        if self.dimensions != vector.dimensions {
            return Err(VectorError::DimensionMismatch);
        }
        Ok(self
            .components
            .iter()
            .zip(&vector.components)
            .map(|(a, b)| a * b)
            .sum())
    }
}

impl Mul<f64> for Vector<f64> {
    type Output = Vector<f64>;

    fn mul(mut self, scalar: f64) -> Vector<f64> {
        self.components
            .iter_mut()
            .for_each(|component| *component *= scalar);
        self
    }
}

impl Mul<i64> for Vector<f64> {
    type Output = Vector<f64>;

    fn mul(mut self, scalar: i64) -> Vector<f64> {
        self.components
            .iter_mut()
            .for_each(|component| *component *= scalar as f64);
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn new_ivec_creation_test() {
        let i_vector: Vector<i64> = Vector::<i64>::new(vec![1, 2, 3]);
        assert_eq!(
            i_vector,
            Vector::<i64> {
                components: vec![1, 2, 3],
                dimensions: 3
            }
        )
    }

    #[test]
    fn new_fvec_creation_test() {
        let f_vector: Vector<f64> = Vector::<f64>::new(vec![1.0, 2.2, 3.2]);
        assert_eq!(
            f_vector,
            Vector::<f64> {
                components: vec![1.0, 2.2, 3.2],
                dimensions: 3
            }
        )
    }

    #[test]
    fn ivec_magnitude() {
        let i_vector = Vector::<i64>::new(vec![3, 4]);
        assert_eq!(i_vector.magnitude(), 5.0);
    }

    #[test]
    fn fvec_magnitude() {
        let f_vector: Vector<f64> = Vector::<f64>::new(vec![6.0, 8.0]);
        assert_eq!(f_vector.magnitude(), 10.0);
    }

    #[test]
    fn ivec_addition() {
        let mut i_vector = Vector::<i64>::new(vec![3, 4]);
        let i_vector_2 = Vector::<i64>::new(vec![3, 4]);
        let _ = i_vector.add(&i_vector_2).expect("mismatched dimensions");
        assert_eq!(
            i_vector,
            Vector::<i64> {
                components: vec![6, 8],
                dimensions: 2
            }
        )
    }

    #[test]
    fn fvec_and_fvec_addition() {
        let mut f_vector = Vector::<f64>::new(vec![3.5, 4.2]);
        let f_vector_2 = Vector::<f64>::new(vec![3.2, 4.1]);
        let _ = f_vector.add_f(&f_vector_2).expect("mismatched dimensions");
        assert_eq!(
            f_vector,
            Vector::<f64> {
                components: vec![6.7, 8.3],
                dimensions: 2
            }
        )
    }

    #[test]
    fn fvec_and_ivec_addition() {
        let mut f_vector = Vector::<f64>::new(vec![3.5, 4.2]);
        let i_vector = Vector::<i64>::new(vec![3, 4]);
        let _ = f_vector.add_i(&i_vector).expect("mismatched dimensions");
        assert_eq!(
            f_vector,
            Vector::<f64> {
                components: vec![6.5, 8.2],
                dimensions: 2
            }
        )
    }

    #[test]
    fn ivec_addition_failure() {
        let mut i_vector = Vector::<i64>::new(vec![3, 4]);
        let i_vector_2 = Vector::<i64>::new(vec![3, 4, 5]);
        let res = i_vector.add(&i_vector_2).err();
        assert_eq!(res, Some(VectorError::DimensionMismatch));
    }

    #[test]
    fn fvec_and_fvec_addition_failure() {
        let mut f_vector = Vector::<f64>::new(vec![3.3, 4.1]);
        let f_vector_2 = Vector::<f64>::new(vec![3.2, 4.34, 5.2]);
        let res = f_vector.add_f(&f_vector_2).err();
        assert_eq!(res, Some(VectorError::DimensionMismatch));
    }

    #[test]
    fn fvec_and_ivec_addition_failure() {
        let mut f_vector = Vector::<f64>::new(vec![3.3, 4.1]);
        let i_vector = Vector::<i64>::new(vec![3, 4, 52]);
        let res = f_vector.add_i(&i_vector).err();
        assert_eq!(res, Some(VectorError::DimensionMismatch));
    }

    #[test]
    fn test_dot_product_i_success() {
        let vec1 = Vector::<i64>::new(vec![1, 2, 3]);
        let vec2 = Vector::<i64>::new(vec![4, 5, 6]);

        let result = vec1.dot_product(&vec2);
        assert_eq!(result, Ok(32));
    }

    #[test]
    fn test_dot_product_i_dimension_mismatch() {
        let vec1 = Vector::<i64>::new(vec![1, 2, 3]);
        let vec2 = Vector::<i64>::new(vec![4, 5]);

        let result = vec1.dot_product(&vec2);
        assert_eq!(result, Err(VectorError::DimensionMismatch));
    }

    #[test]
    fn test_dot_product_f_success() {
        let vec1 = Vector::<f64>::new(vec![1.0, 2.0, 3.0]);
        let vec2 = Vector::<f64>::new(vec![4.0, 5.0, 6.0]);

        let result = vec1.dot_product_f(&vec2);
        assert_eq!(result, Ok(32.0));
    }

    #[test]
    fn test_dot_product_f_and_i_success() {
        let vec1 = Vector::<f64>::new(vec![1.0, 2.0, 3.0]);
        let vec2 = Vector::<i64>::new(vec![4, 5, 6]);

        let result = vec1.dot_product_i(&vec2);
        assert_eq!(result, Ok(32.0));
    }

    #[test]
    fn test_dot_product_f_dimension_mismatch() {
        let vec1 = Vector::<f64>::new(vec![1.0, 2.0, 3.0]);
        let vec2 = Vector::<f64>::new(vec![4.0, 5.0]);

        let result = vec1.dot_product_f(&vec2);
        assert_eq!(result, Err(VectorError::DimensionMismatch));
    }

    #[test]
    fn test_dot_product_f_and_i_dimension_mismatch() {
        let vec1 = Vector::<f64>::new(vec![1.0, 2.0, 3.0]);
        let vec2 = Vector::<i64>::new(vec![40, 50]);

        let result = vec1.dot_product_i(&vec2);
        assert_eq!(result, Err(VectorError::DimensionMismatch));
    }

    #[test]
    fn test_dot_product_i_empty_vectors() {
        let vec1 = Vector::<i64>::new(vec![]);
        let vec2 = Vector::<i64>::new(vec![]);

        let result = vec1.dot_product(&vec2);
        assert_eq!(result, Ok(0));
    }

    #[test]
    fn test_dot_product_f_empty_vectors() {
        let vec1 = Vector::<f64>::new(vec![]);
        let vec2 = Vector::<f64>::new(vec![]);

        let result = vec1.dot_product_f(&vec2);
        assert_eq!(result, Ok(0.0));
    }
    #[test]
    fn test_dot_product_f_and_i_empty_vectors() {
        let vec1 = Vector::<f64>::new(vec![]);
        let vec2 = Vector::<i64>::new(vec![]);

        let result = vec1.dot_product_i(&vec2);
        assert_eq!(result, Ok(0.0));
    }
}