numrs 0.2.0

A numerical computations library 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

//! A 1D Vector type
//!
//! The Vector type supports simple arithmetic operations from the start and
//! provides convenient methods for accessing the elements of the vector.
//!
//! # Examples
//! ```
//! use numrs::vector;
//! use numrs::vector::Vector;
//!
//! // Create a new vector with all values 0.0
//! let v1 = Vector::new(4, 0.0);
//!
//! // Creates a vector from the below elements
//! let elems = [1.0, 2.0, 3.0, 4.0];
//! let v2 = vector::from_elems(&elems);
//!
//! let mut res = v1.clone() + v2.clone(); // add two vectors
//! res = v1.clone() - v2.clone(); // subtract 2 vector
//! res = v1.clone() * v2.clone(); // matrix product of 2 vector
//! res = v2.clone() * 5.0; // multiply a vector with a constant
//! ```

use std::ops::{Index, IndexMut, Add, Sub, Mul, Neg};
use common::Number;

/// 1D Vector
pub struct Vector<T: Number> {
  pub data: Vec<T>
}

impl<T: Number> Index<usize> for Vector<T> {
  type Output = T;

  #[inline]
  fn index<'a>(&'a self, index: usize) -> &'a T {
    &self.data[index]
  }
}

impl<T: Number> IndexMut<usize> for Vector<T> {
  #[inline]
  fn index_mut<'a>(&'a mut self, index: usize) -> &'a mut T {
    &mut self.data[index]
  }
}

impl<T: Number> Clone for Vector<T> {
  fn clone(&self) -> Vector<T> {
    Vector::<T> {
      data: self.data.clone()
    }
  }

  fn clone_from(&mut self, source: &Vector<T>) {
    self.data = source.data.clone();
  }
}

impl<T: Number> Add<Vector<T>> for Vector<T> {
  type Output = Vector<T>;

  fn add(self, rhs: Vector<T>) -> Vector<T> {
    if self.len() == rhs.len() {
      let mut new_vec = Vector::<T>::new(self.len(), T::zero());
      for i in 0..self.len() {
        new_vec.data[i] = self.data[i] + rhs.data[i];
      }
      new_vec
    } else {
      panic!("Vectors are not conformable for addition.");
    }
  }
}

impl<T: Number> Sub<Vector<T>> for Vector<T> {
  type Output = Vector<T>;

  fn sub(self, rhs: Vector<T>) -> Vector<T> {
    if self.len() == rhs.len() {
      let mut new_vec = Vector::<T>::new(self.len(), T::zero());
      for i in 0..self.len() {
        new_vec.data[i] = self.data[i] - rhs.data[i];
      }
      new_vec
    } else {
      panic!("Vectors are not conformable for subtraction.");
    }
  }
}

impl<T: Number> Mul<Vector<T>> for Vector<T> {
  type Output = Vector<T>;

  fn mul(self, rhs: Vector<T>) -> Vector<T> {
    if self.len() == rhs.len() {
      let mut new_vec = Vector::<T>::new(self.len(), T::zero());
      for i in 0..self.len() {
        new_vec.data[i] = self.data[i] * rhs.data[i];
      }
      new_vec
    } else {
      panic!("Vectors are not conformable for multiplication.")
    }
  }
}

impl<T: Number + Neg<Output = T>> Neg for Vector<T> {
  type Output = Vector<T>;

  fn neg(self) -> Vector<T> {
    let mut v = self.clone();
    for i in 0..self.len() {
      v.data[i] = -self.data[i];
    }
    v
  }
}

impl<T: Number> Mul<T> for Vector<T> {
  type Output = Vector<T>;

  fn mul(self, rhs: T) -> Vector<T> {
    let mut v = self.clone();
    for i in 0..self.len() {
      v.data[i] = rhs * self.data[i];
    }
    v
  }
}

impl<T: Number> PartialEq for Vector<T> {
  fn eq(&self, other: &Vector<T>) -> bool {
    if self.len() != other.len() {
      return false;
    }
    for i in 0..self.len() {
      if self.data[i] != other.data[i] {
        return false;
      }
    }
    true
  }
}

impl<T: Number> Eq for Vector<T> {}

impl<T: Number> Vector<T> {
  #[inline]
  pub fn len(&self) -> usize {
    self.data.len()
  }

  pub fn new(length: usize, default: T) -> Vector<T> {
    let d = vec![default; length];
    Vector::<T> {
      data: d
    }
  }
}

pub fn from_elems<T: Number>(elems: &[T]) -> Vector<T> {
  let mut v = Vector::<T> {
    data: Vec::with_capacity(elems.len())
  };
  v.data.extend_from_slice(elems);
  v
}