From c82d7e77dcbc9c41b4d2853790aa4a6616db43ac Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Fri, 28 Jul 2017 00:10:45 +0100 Subject: Updating docs --- matrix_8hpp_source.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'matrix_8hpp_source.html') diff --git a/matrix_8hpp_source.html b/matrix_8hpp_source.html index 7b652138..ff189d16 100644 --- a/matrix_8hpp_source.html +++ b/matrix_8hpp_source.html @@ -67,10 +67,10 @@ $(function() {
matrix.hpp
-
1 /* ----------------------------------------------------------------------------
2  * matrix.hpp
3  *
4  * Copyright (c) 2017 Yann Herklotz Grave <ymherklotz@gmail.com> -- MIT License
5  * See file LICENSE for more details
6  * ----------------------------------------------------------------------------
7  */
8 
9 #ifndef YAGE_MATH_MATRIX_HPP
10 #define YAGE_MATH_MATRIX_HPP
11 
12 #include <algorithm>
13 #include <exception>
14 #include <iostream>
15 #include <sstream>
16 #include <string>
17 #include <vector>
18 
19 namespace yage
20 {
21 
22 template<int Rows, int Cols, class Type> class Matrix;
23 
24 // includes implementation details that should not be accessible to the user
25 namespace detail
26 {
27 
28 // Row class
29 //
30 // Used to implement the double square bracket operator and be able
31 // to return the value by reference of the array.
32 template<int Rows, int Cols, class Type> class Row
33 {
34 private:
35  Matrix<Rows, Cols, Type> *parent_;
36  int index_;
37 
38 public:
39  Row<Rows, Cols, Type>(Matrix<Rows, Cols, Type> *parent, int index) :
40  parent_(parent), index_(index)
41  {}
42 
43  Type& operator[](int col)
44  {
45  // the index is the y-position of the element in the matrix
46  return parent_->data_[index_*Cols+col];
47  }
48 
49  const Type& operator[](int col) const
50  {
51  return parent_->data_[index_*Cols+col];
52  }
53 };
54 
55 } // detail
56 
57 // Matrix class
58 //
59 // Implements the base Matrix class that is inherited by other classes to make them more
60 // specific.
61 template<int Rows=4, int Cols=4, class Type=double> class Matrix
62 {
63  // friended with the row class so that it can access protected member data
64  friend class detail::Row<Rows, Cols, Type>;
65 protected:
66  std::vector<Type> data_;
67 
68 public:
69  Matrix<Rows, Cols, Type>() : data_(Rows*Cols) {}
70 
71  int rowSize() const
72  {
73  return Rows;
74  }
75 
76  int colSize() const
77  {
78  return Cols;
79  }
80 
81  // returns the row in a row matrix
82  Matrix<1, Cols, Type> getRow(int row) const
83  {
84  Matrix<1, Cols, Type> rowMatrix;
85  for(int i=0; i<Cols; ++i)
86  {
87  rowMatrix[0][i]=data_[row][i];
88  }
89  return rowMatrix;
90  }
91 
92  // returns the column in a column matrix
93  Matrix<Rows, 1, Type> getCol(int col) const
94  {
95  Matrix<Rows, 1, Type> colMatrix;
96  for(int i=0; i<Rows; ++i)
97  {
98  colMatrix[i][0]=data_[i][col];
99  }
100  return colMatrix;
101  }
102 
103  // iterator support for begin
104  typename std::vector<Type>::iterator begin()
105  {
106  return data_.begin();
107  }
108 
109  // iterator support for end
110  typename std::vector<Type>::iterator end()
111  {
112  return data_.end();
113  }
114 
115  // prints out the matrix, but can also be implemented by other classes to print data
116  // differently
117  virtual std::string toString() const
118  {
119  std::stringstream ss;
120  ss<<'[';
121  for(int i=0; i<Rows-1; ++i)
122  {
123  ss<<'[';
124  for(int j=0; j<Cols-1; ++j)
125  {
126  ss<<data_[i*Cols+j]<<' ';
127  }
128  ss<<data_[(Rows-1)*Cols+Cols-1]<<"],";
129  }
130  ss<<'[';
131  for(int j=0; j<Cols-1; ++j)
132  {
133  ss<<data_[(Rows-1)*Cols+j]<<' ';
134  }
135  ss<<data_[(Rows-1)*Cols+Cols-1]<<"]]";
136  return ss.str();
137  }
138 
139  detail::Row<Rows, Cols, Type> operator[](int row)
140  {
141  return detail::Row<Rows, Cols, Type>(this, row);
142  }
143 
144  detail::Row<Rows, Cols, Type> operator[](int row) const
145  {
146  // TODO got to fix this
147  return detail::Row<Rows, Cols, Type>((Matrix<Rows, Cols, Type>*)this, row);
148  }
149 
150  Matrix<Rows, Cols, Type>& operator=(const Matrix<Rows, Cols, Type> &other)
151  {
152  if(this!=&other)
153  {
154  data_=other.data_;
155  }
156  return *this;
157  }
158 
159  Matrix<Rows, Cols, Type>& operator+=(const Matrix<Rows, Cols, Type> &rhs)
160  {
161  std::vector<Type> out;
162  out.reserve(data_.size());
163  std::transform(data_.begin(), data_.end(), rhs.data_.begin(), std::back_inserter(out),
164  [] (Type a, Type b) {
165  return a+b;
166  });
167  data_=std::move(out);
168  return *this;
169  }
170 
171  Matrix<Rows, Cols, Type>& operator-=(const Matrix<Rows, Cols, Type> &rhs)
172  {
173  std::vector<Type> out;
174  out.reserve(data_.size());
175  std::transform(data_.begin(), data_.end(), rhs.begin(), std::back_inserter(out),
176  [] (Type a, Type b) {
177  return a-b;
178  });
179  data_=std::move(out);
180  return *this;
181  }
182 };
183 
184 template<int M, int N, class T>
185 Matrix<M, N, T> operator+(Matrix<M, N, T> lhs, const Matrix<M, N, T> &rhs)
186 {
187  lhs+=rhs;
188  return lhs;
189 }
190 
191 template<int M, int N, class T>
192 Matrix<M, N, T> operator-(Matrix<M, N, T> lhs, const Matrix<M, N, T> &rhs)
193 {
194  lhs-=rhs;
195  return lhs;
196 }
197 
198 template<int M, int N, class T>
199 Matrix<M, N, T> operator+(Matrix<M, N, T> lhs, const T &rhs)
200 {
201  for(auto &data : lhs)
202  {
203  data+=rhs;
204  }
205  return lhs;
206 }
207 
208 template<int M, int N, class T>
209 Matrix<M, N, T> operator+(const T &lhs, Matrix<M, N, T> rhs)
210 {
211  for(auto &data : rhs)
212  {
213  data+=lhs;
214  }
215  return rhs;
216 }
217 
218 template<int M, int N, class T>
219 Matrix<M, N, T> operator-(Matrix<M, N, T> lhs, const T &rhs)
220 {
221  for(auto &data : lhs)
222  {
223  data-=rhs;
224  }
225  return lhs;
226 }
227 
228 template<int M, int N, class T>
229 Matrix<M, N, T> operator-(const T &lhs, Matrix<M, N, T> rhs)
230 {
231  for(auto &data : rhs)
232  {
233  data=lhs-data;
234  }
235  return rhs;
236 }
237 
238 template<int M, int N, class T>
239 Matrix<M, N, T> operator*(Matrix<M, N, T> lhs, const T &rhs)
240 {
241  for(auto &data : lhs)
242  {
243  data*=rhs;
244  }
245  return lhs;
246 }
247 
248 template<int M, int N, class T>
249 Matrix<M, N, T> operator*(const T &lhs, Matrix<M, N, T> rhs)
250 {
251  for(auto &data : rhs)
252  {
253  data*=lhs;
254  }
255  return rhs;
256 }
257 
258 template<int M, int N, class T>
259 Matrix<M, N, T> operator/(Matrix<M, N, T> lhs, const T &rhs)
260 {
261  for(auto &data : lhs)
262  {
263  data/=rhs;
264  }
265  return lhs;
266 }
267 
268 template<int M, int N, class T>
269 bool operator==(const Matrix<M, N, T> &lhs, const Matrix<M, N, T> &rhs)
270 {
271  for(int i=0; i<M; ++i)
272  for(int j=0; j<N; ++j)
273  if(lhs[i][j]!=rhs[i][j])
274  return false;
275  return true;
276 }
277 
278 template<int M, int N, class T>
279 std::ostream& operator<<(std::ostream &os, const Matrix<M, N, T> &mat)
280 {
281  return os<<mat.toString();
282 }
283 
284 template<int Rows=2, class Type=double> class Vector : public Matrix<Rows, 1, Type>
285 {
286 public:
287  Vector<Rows, Type>() : Matrix<Rows, 1, Type>() {}
288  explicit Vector<Rows, Type>(const Matrix<Rows, 1, Type> &other) : Matrix<Rows, 1, Type>(other) {}
289 
290  Type& operator[](int col)
291  {
292  return this->data_[col];
293  }
294 
295  const Type& operator[](int col) const
296  {
297  return this->data_[col];
298  }
299 
300  virtual std::string toString() const
301  {
302  std::stringstream ss;
303  ss<<"[";
304  for(std::size_t i=0; i<this->data_.size()-1; ++i)
305  {
306  ss<<this->data_[i]<<" ";
307  }
308  ss<<this->data_[this->data_.size()-1]<<"]";
309  return ss.str();
310  }
311 };
312 
313 template<class Type=double> class Vector2 : public Vector<2, Type>
314 {
315 public:
316  Vector2<Type>() : Vector<2, Type>() {}
317 
318  Vector2<Type>(Type x, Type y)
319  {
320  this->data_[0]=x;
321  this->data_[1]=y;
322  }
323 
324  Vector2<Type>(const Matrix<2, 1, Type> &other) : Vector<2, Type>(other) {}
325 
326  Type& x()
327  {
328  return this->data_[0];
329  }
330 
331  const Type& x() const
332  {
333  return this->data_[0];
334  }
335 
336  Type& y()
337  {
338  return this->data_[1];
339  }
340 
341  const Type& y() const
342  {
343  return this->data_[1];
344  }
345 };
346 
347 typedef Vector2<double> Vector2d;
348 
349 namespace matrix
350 {
351 
352 template<int M, int N, class T> Matrix<N, M, T> transpose(const Matrix<M, N, T> &m)
353 {
354  Matrix<N, M, T> trans;
355  for(int i=0; i<M; ++i)
356  {
357  for(int j=0; j<N; ++j)
358  {
359  trans[j][i]=m[i][j];
360  }
361  }
362  return trans;
363 }
364 
365 template<int R, class T> T dot(const Matrix<R, 1, T> &m1, const Matrix<R, 1, T> &m2)
366 {
367  T sum=0;
368  for(int i=0; i<R; ++i)
369  {
370  sum += m1[i][0]*m2[i][0];
371  }
372  return sum;
373 }
374 
375 template<int M, int N, int P, int Q, class T>
376 Matrix<M, Q, T> multiply(const Matrix<M, N, T> &m1, const Matrix<P, Q, T> &m2)
377 {
378  if(N!=P)
379  {
380  throw std::runtime_error("Matrices don't have the right dimensions for multiplication");
381  }
382 
383  Matrix<M, Q, T> res;
384 
385  for(int i=0; i<M; ++i)
386  {
387  for(int j=0; j<Q; ++j)
388  {
389  res[i][j] = dot(transpose(m1.getRow(i)), m2.getCol(j));
390  }
391  }
392 
393  return res;
394 }
395 
396 } // matrix
397 
398 } // yage
399 
400 #endif
yage::Vector2
Definition: matrix.hpp:313
-
yage::detail::Row
Definition: matrix.hpp:32
-
yage::Vector
Definition: matrix.hpp:284
-
yage::Matrix
Definition: matrix.hpp:22
+Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
2  * matrix.hpp
3  *
4  * Copyright (c) 2017 Yann Herklotz Grave <ymherklotz@gmail.com> -- MIT License
5  * See file LICENSE for more details
6  * ----------------------------------------------------------------------------
7  */
8 
16 #ifndef YAGE_MATH_MATRIX_HPP
17 #define YAGE_MATH_MATRIX_HPP
18 
19 #include <algorithm>
20 #include <exception>
21 #include <iostream>
22 #include <sstream>
23 #include <string>
24 #include <vector>
25 
26 namespace yage
27 {
28 
29 template<int Rows, int Cols, class Type> class Matrix;
30 
31 // includes implementation details that should not be accessible to the user
32 namespace detail
33 {
34 
35 // Row class
36 //
37 // Used to implement the double square bracket operator and be able
38 // to return the value by reference of the array.
39 template<int Rows, int Cols, class Type> class Row
40 {
41 private:
42  Matrix<Rows, Cols, Type> *parent_;
43  int index_;
44 
45 public:
46  Row<Rows, Cols, Type>(Matrix<Rows, Cols, Type> *parent, int index) :
47  parent_(parent), index_(index)
48  {}
49 
50  Type& operator[](int col)
51  {
52  // the index is the y-position of the element in the matrix
53  return parent_->data_[index_*Cols+col];
54  }
55 
56  const Type& operator[](int col) const
57  {
58  return parent_->data_[index_*Cols+col];
59  }
60 };
61 
62 } // detail
63 
64 // Matrix class
65 //
66 // Implements the base Matrix class that is inherited by other classes to make them more
67 // specific.
68 template<int Rows=4, int Cols=4, class Type=double> class Matrix
69 {
70  // friended with the row class so that it can access protected member data
71  friend class detail::Row<Rows, Cols, Type>;
72 protected:
73  std::vector<Type> data_;
74 
75 public:
76  Matrix<Rows, Cols, Type>() : data_(Rows*Cols) {}
77 
78  int rowSize() const
79  {
80  return Rows;
81  }
82 
83  int colSize() const
84  {
85  return Cols;
86  }
87 
88  // returns the row in a row matrix
89  Matrix<1, Cols, Type> getRow(int row) const
90  {
91  Matrix<1, Cols, Type> rowMatrix;
92  for(int i=0; i<Cols; ++i)
93  {
94  rowMatrix[0][i]=data_[row][i];
95  }
96  return rowMatrix;
97  }
98 
99  // returns the column in a column matrix
100  Matrix<Rows, 1, Type> getCol(int col) const
101  {
102  Matrix<Rows, 1, Type> colMatrix;
103  for(int i=0; i<Rows; ++i)
104  {
105  colMatrix[i][0]=data_[i][col];
106  }
107  return colMatrix;
108  }
109 
110  // iterator support for begin
111  typename std::vector<Type>::iterator begin()
112  {
113  return data_.begin();
114  }
115 
116  // iterator support for end
117  typename std::vector<Type>::iterator end()
118  {
119  return data_.end();
120  }
121 
122  // prints out the matrix, but can also be implemented by other classes to print data
123  // differently
124  virtual std::string toString() const
125  {
126  std::stringstream ss;
127  ss<<'[';
128  for(int i=0; i<Rows-1; ++i)
129  {
130  ss<<'[';
131  for(int j=0; j<Cols-1; ++j)
132  {
133  ss<<data_[i*Cols+j]<<' ';
134  }
135  ss<<data_[(Rows-1)*Cols+Cols-1]<<"],";
136  }
137  ss<<'[';
138  for(int j=0; j<Cols-1; ++j)
139  {
140  ss<<data_[(Rows-1)*Cols+j]<<' ';
141  }
142  ss<<data_[(Rows-1)*Cols+Cols-1]<<"]]";
143  return ss.str();
144  }
145 
146  detail::Row<Rows, Cols, Type> operator[](int row)
147  {
148  return detail::Row<Rows, Cols, Type>(this, row);
149  }
150 
151  detail::Row<Rows, Cols, Type> operator[](int row) const
152  {
153  // TODO got to fix this
154  return detail::Row<Rows, Cols, Type>((Matrix<Rows, Cols, Type>*)this, row);
155  }
156 
157  Matrix<Rows, Cols, Type>& operator=(const Matrix<Rows, Cols, Type> &other)
158  {
159  if(this!=&other)
160  {
161  data_=other.data_;
162  }
163  return *this;
164  }
165 
166  Matrix<Rows, Cols, Type>& operator+=(const Matrix<Rows, Cols, Type> &rhs)
167  {
168  std::vector<Type> out;
169  out.reserve(data_.size());
170  std::transform(data_.begin(), data_.end(), rhs.data_.begin(), std::back_inserter(out),
171  [] (Type a, Type b) {
172  return a+b;
173  });
174  data_=std::move(out);
175  return *this;
176  }
177 
178  Matrix<Rows, Cols, Type>& operator-=(const Matrix<Rows, Cols, Type> &rhs)
179  {
180  std::vector<Type> out;
181  out.reserve(data_.size());
182  std::transform(data_.begin(), data_.end(), rhs.begin(), std::back_inserter(out),
183  [] (Type a, Type b) {
184  return a-b;
185  });
186  data_=std::move(out);
187  return *this;
188  }
189 };
190 
191 template<int M, int N, class T>
192 Matrix<M, N, T> operator+(Matrix<M, N, T> lhs, const Matrix<M, N, T> &rhs)
193 {
194  lhs+=rhs;
195  return lhs;
196 }
197 
198 template<int M, int N, class T>
199 Matrix<M, N, T> operator-(Matrix<M, N, T> lhs, const Matrix<M, N, T> &rhs)
200 {
201  lhs-=rhs;
202  return lhs;
203 }
204 
205 template<int M, int N, class T>
206 Matrix<M, N, T> operator+(Matrix<M, N, T> lhs, const T &rhs)
207 {
208  for(auto &data : lhs)
209  {
210  data+=rhs;
211  }
212  return lhs;
213 }
214 
215 template<int M, int N, class T>
216 Matrix<M, N, T> operator+(const T &lhs, Matrix<M, N, T> rhs)
217 {
218  for(auto &data : rhs)
219  {
220  data+=lhs;
221  }
222  return rhs;
223 }
224 
225 template<int M, int N, class T>
226 Matrix<M, N, T> operator-(Matrix<M, N, T> lhs, const T &rhs)
227 {
228  for(auto &data : lhs)
229  {
230  data-=rhs;
231  }
232  return lhs;
233 }
234 
235 template<int M, int N, class T>
236 Matrix<M, N, T> operator-(const T &lhs, Matrix<M, N, T> rhs)
237 {
238  for(auto &data : rhs)
239  {
240  data=lhs-data;
241  }
242  return rhs;
243 }
244 
245 template<int M, int N, class T>
246 Matrix<M, N, T> operator*(Matrix<M, N, T> lhs, const T &rhs)
247 {
248  for(auto &data : lhs)
249  {
250  data*=rhs;
251  }
252  return lhs;
253 }
254 
255 template<int M, int N, class T>
256 Matrix<M, N, T> operator*(const T &lhs, Matrix<M, N, T> rhs)
257 {
258  for(auto &data : rhs)
259  {
260  data*=lhs;
261  }
262  return rhs;
263 }
264 
265 template<int M, int N, class T>
266 Matrix<M, N, T> operator/(Matrix<M, N, T> lhs, const T &rhs)
267 {
268  for(auto &data : lhs)
269  {
270  data/=rhs;
271  }
272  return lhs;
273 }
274 
275 template<int M, int N, class T>
276 bool operator==(const Matrix<M, N, T> &lhs, const Matrix<M, N, T> &rhs)
277 {
278  for(int i=0; i<M; ++i)
279  for(int j=0; j<N; ++j)
280  if(lhs[i][j]!=rhs[i][j])
281  return false;
282  return true;
283 }
284 
285 template<int M, int N, class T>
286 std::ostream& operator<<(std::ostream &os, const Matrix<M, N, T> &mat)
287 {
288  return os<<mat.toString();
289 }
290 
291 template<int Rows=2, class Type=double> class Vector : public Matrix<Rows, 1, Type>
292 {
293 public:
294  Vector<Rows, Type>() : Matrix<Rows, 1, Type>() {}
295  explicit Vector<Rows, Type>(const Matrix<Rows, 1, Type> &other) : Matrix<Rows, 1, Type>(other) {}
296 
297  Type& operator[](int col)
298  {
299  return this->data_[col];
300  }
301 
302  const Type& operator[](int col) const
303  {
304  return this->data_[col];
305  }
306 
307  virtual std::string toString() const
308  {
309  std::stringstream ss;
310  ss<<"[";
311  for(std::size_t i=0; i<this->data_.size()-1; ++i)
312  {
313  ss<<this->data_[i]<<" ";
314  }
315  ss<<this->data_[this->data_.size()-1]<<"]";
316  return ss.str();
317  }
318 };
319 
320 template<class Type=double> class Vector2 : public Vector<2, Type>
321 {
322 public:
323  Vector2<Type>() : Vector<2, Type>() {}
324 
325  Vector2<Type>(Type x, Type y)
326  {
327  this->data_[0]=x;
328  this->data_[1]=y;
329  }
330 
331  Vector2<Type>(const Matrix<2, 1, Type> &other) : Vector<2, Type>(other) {}
332 
333  Type& x()
334  {
335  return this->data_[0];
336  }
337 
338  const Type& x() const
339  {
340  return this->data_[0];
341  }
342 
343  Type& y()
344  {
345  return this->data_[1];
346  }
347 
348  const Type& y() const
349  {
350  return this->data_[1];
351  }
352 };
353 
354 typedef Vector2<double> Vector2d;
355 
356 namespace matrix
357 {
358 
359 template<int M, int N, class T> Matrix<N, M, T> transpose(const Matrix<M, N, T> &m)
360 {
361  Matrix<N, M, T> trans;
362  for(int i=0; i<M; ++i)
363  {
364  for(int j=0; j<N; ++j)
365  {
366  trans[j][i]=m[i][j];
367  }
368  }
369  return trans;
370 }
371 
372 template<int R, class T> T dot(const Matrix<R, 1, T> &m1, const Matrix<R, 1, T> &m2)
373 {
374  T sum=0;
375  for(int i=0; i<R; ++i)
376  {
377  sum += m1[i][0]*m2[i][0];
378  }
379  return sum;
380 }
381 
382 template<int M, int N, int P, int Q, class T>
383 Matrix<M, Q, T> multiply(const Matrix<M, N, T> &m1, const Matrix<P, Q, T> &m2)
384 {
385  if(N!=P)
386  {
387  throw std::runtime_error("Matrices don't have the right dimensions for multiplication");
388  }
389 
390  Matrix<M, Q, T> res;
391 
392  for(int i=0; i<M; ++i)
393  {
394  for(int j=0; j<Q; ++j)
395  {
396  res[i][j] = dot(transpose(m1.getRow(i)), m2.getCol(j));
397  }
398  }
399 
400  return res;
401 }
402 
403 } // matrix
404 
405 } // yage
406 
407 #endif
yage::Vector2
Definition: matrix.hpp:320
+
yage::detail::Row
Definition: matrix.hpp:39
+
yage::Vector
Definition: matrix.hpp:291
+
yage::Matrix
Definition: matrix.hpp:29
yage
Definition: camera2d.hpp:17
-- cgit