simp_linalg 0.2.0

A generically defined, light-weight linear algebra library for simple addition and multiplication of vectors and matrices.
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

use crate::vector_impl::Vector;

impl<T> Vector<T> {
    /// Applies an anonymous function relative to value
    /// to each element of the vector and returns a vector 
    /// with the corresponding results.
    /// 
    /// # Example
    /// ```
    /// use simp_linalg::vector_impl::Vector;
    /// use simp_linalg::vector;
    /// 
    /// let vector_x = vector![1, 2, 3];
    /// 
    /// // squares each element in vector_x
    /// let vector_y = vector_x.lambda(|val| val * val);
    /// 
    /// assert_eq!(vector_y, vector![1, 4, 9])
    /// ```
    pub fn lambda<F>(&self, funct: F) -> Vector<T>
    where
        F: Fn(&T) -> T
    {
        let mut params = Vec::with_capacity(self.len());
        
        for item in self.list() {
            params.push(funct(item))
        }

        Vector::from(params)
    }
    
    /// Applies an anonymous function relative to location
    /// to each location of the vector and returns a vector
    /// with the corresponding results.
    /// 
    /// # Example
    /// ```
    /// use simp_linalg::vector_impl::Vector;
    /// use simp_linalg::vector;
    /// 
    /// let vector_x = vector![0, 0, 0];
    /// 
    /// // counts upwards starting from 1
    /// let vector_y = vector_x.lambda_index(|idx| idx + 1);
    /// 
    /// assert_eq!(vector_y, vector![1, 2, 3])
    /// ```
    pub fn lambda_index<F>(&self, funct : F) -> Vector<T>
    where
        F: Fn(usize) -> T
    {
        let mut params = Vec::with_capacity(self.len());
        
        for item in 0..self.len() {
            params.push(funct(item))
        }

        Vector::from(params)
    }

    /// Applies an anonymous function relative to location and value
    /// to each element of the vector and returns a vector
    /// with the corresponding results.
    /// 
    /// # Example
    /// ```
    /// use simp_linalg::vector_impl::Vector;
    /// use simp_linalg::vector;
    /// 
    /// let vector_x = vector![1, 2, 3];
    /// 
    /// let vector_y = vector_x.lambda_enumerate(|idx, val| idx * val);
    /// 
    /// assert_eq!(vector_y, vector![0, 2, 6])
    /// ```
    pub fn lambda_enumerate<F>(&self, funct : F) -> Vector<T>
    where
        F: Fn(usize, &T) -> T
    {
        let mut params = Vec::with_capacity(self.len());

        for (idx, item) in self.list.iter().enumerate() {
            params.push(funct(idx, item))
        }

        Vector::from(params)
    }
}