From 41b27388646a8159de3830dc21dcf3ac2519bd8e Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Mon, 21 Aug 2017 20:54:29 +0100 Subject: Updating docs --- matrix_8hpp_source.html | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) (limited to 'matrix_8hpp_source.html') diff --git a/matrix_8hpp_source.html b/matrix_8hpp_source.html index 3cacf5e6..2d51d501 100644 --- a/matrix_8hpp_source.html +++ b/matrix_8hpp_source.html @@ -68,20 +68,23 @@ $(function() {
matrix.hpp
-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 
19 #ifndef YAGE_MATH_MATRIX_HPP
20 #define YAGE_MATH_MATRIX_HPP
21 
22 #include <algorithm>
23 #include <exception>
24 #include <iostream>
25 #include <sstream>
26 #include <string>
27 #include <vector>
28 
29 namespace yage {
30 
31 template <int Rows, int Cols, class Type>
32 class Matrix;
33 
41 namespace detail {
42 
51 template <int Rows, int Cols, class Type>
52 class Row {
53 private:
54  Matrix<Rows, Cols, Type>* parent_;
55  int index_;
56 
57 public:
58  Row<Rows, Cols, Type>(Matrix<Rows, Cols, Type>* parent, int index)
59  : parent_(parent), index_(index) {}
60 
61  Type& operator[](int col) {
62  // the index is the y-position of the element in the matrix
63  return parent_->data_[index_ * Cols + col];
64  }
65 
66  const Type& operator[](int col) const {
67  return parent_->data_[index_ * Cols + col];
68  }
69 };
70 
71 } // detail
72 
81 template <int Rows = 4, int Cols = 4, class Type = double>
82 class Matrix {
83  // friended with the row class so that it can access protected member data
84  friend class detail::Row<Rows, Cols, Type>;
85 
86 protected:
88  std::vector<Type> data_;
89 
90 public:
92  Matrix<Rows, Cols, Type>() : data_(Rows * Cols) {}
93  Matrix<Rows, Cols, Type>(const std::vector<Type>& data) : data_(data) {}
94 
96  int rowSize() const { return Rows; }
97 
99  int colSize() const { return Cols; }
100 
107  Matrix<1, Cols, Type> getRow(int row) const {
108  Matrix<1, Cols, Type> rowMatrix;
109  for (int i = 0; i < Cols; ++i) {
110  rowMatrix[0][i] = data_[row][i];
111  }
112  return rowMatrix;
113  }
114 
115  // returns the column in a column matrix
116  Matrix<Rows, 1, Type> getCol(int col) const {
117  Matrix<Rows, 1, Type> colMatrix;
118  for (int i = 0; i < Rows; ++i) {
119  colMatrix[i][0] = data_[i][col];
120  }
121  return colMatrix;
122  }
123 
124  // iterator support for begin
125  typename std::vector<Type>::iterator begin() { return data_.begin(); }
126 
127  // iterator support for end
128  typename std::vector<Type>::iterator end() { return data_.end(); }
129 
130  // prints out the matrix, but can also be implemented by other classes to
131  // print data differently
132  virtual std::string toString() const {
133  std::stringstream ss;
134  ss << '[';
135  for (int i = 0; i < Rows - 1; ++i) {
136  ss << '[';
137  for (int j = 0; j < Cols - 1; ++j) {
138  ss << data_[i * Cols + j] << ' ';
139  }
140  ss << data_[(Rows - 1) * Cols + Cols - 1] << "],";
141  }
142  ss << '[';
143  for (int j = 0; j < Cols - 1; ++j) {
144  ss << data_[(Rows - 1) * Cols + j] << ' ';
145  }
146  ss << data_[(Rows - 1) * Cols + Cols - 1] << "]]";
147  return ss.str();
148  }
149 
150  detail::Row<Rows, Cols, Type> operator[](int row) {
151  return detail::Row<Rows, Cols, Type>(this, row);
152  }
153 
154  detail::Row<Rows, Cols, Type> operator[](int row) const {
155  // TODO got to fix this
156  return detail::Row<Rows, Cols, Type>((Matrix<Rows, Cols, Type>*)this,
157  row);
158  }
159 
160  Matrix<Rows, Cols, Type>& operator+=(const Matrix<Rows, Cols, Type>& rhs) {
161  std::vector<Type> out;
162  out.reserve(data_.size());
163  std::transform(data_.begin(), data_.end(), rhs.data_.begin(),
164  std::back_inserter(out),
165  [](Type a, Type b) { return a + b; });
166  data_ = std::move(out);
167  return *this;
168  }
169 
170  Matrix<Rows, Cols, Type>& operator-=(const Matrix<Rows, Cols, Type>& rhs) {
171  std::vector<Type> out;
172  out.reserve(data_.size());
173  std::transform(data_.begin(), data_.end(), rhs.begin(),
174  std::back_inserter(out),
175  [](Type a, Type b) { return a - b; });
176  data_ = std::move(out);
177  return *this;
178  }
179 };
180 
181 template <int M, int N, class T>
182 Matrix<M, N, T> operator+(Matrix<M, N, T> lhs, const Matrix<M, N, T>& rhs) {
183  lhs += rhs;
184  return lhs;
185 }
186 
187 template <int M, int N, class T>
188 Matrix<M, N, T> operator-(Matrix<M, N, T> lhs, const Matrix<M, N, T>& rhs) {
189  lhs -= rhs;
190  return lhs;
191 }
192 
193 template <int M, int N, class T>
194 Matrix<M, N, T> operator+(Matrix<M, N, T> lhs, const T& rhs) {
195  for (auto& data : lhs) {
196  data += rhs;
197  }
198  return lhs;
199 }
200 
201 template <int M, int N, class T>
202 Matrix<M, N, T> operator+(const T& lhs, Matrix<M, N, T> rhs) {
203  for (auto& data : rhs) {
204  data += lhs;
205  }
206  return rhs;
207 }
208 
209 template <int M, int N, class T>
210 Matrix<M, N, T> operator-(Matrix<M, N, T> lhs, const T& rhs) {
211  for (auto& data : lhs) {
212  data -= rhs;
213  }
214  return lhs;
215 }
216 
217 template <int M, int N, class T>
218 Matrix<M, N, T> operator-(const T& lhs, Matrix<M, N, T> rhs) {
219  for (auto& data : rhs) {
220  data = lhs - data;
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  for (auto& data : lhs) {
228  data *= rhs;
229  }
230  return lhs;
231 }
232 
233 template <int M, int N, class T>
234 Matrix<M, N, T> operator*(const T& lhs, Matrix<M, N, T> rhs) {
235  for (auto& data : rhs) {
236  data *= lhs;
237  }
238  return rhs;
239 }
240 
241 template <int M, int N, class T>
242 Matrix<M, N, T> operator/(Matrix<M, N, T> lhs, const T& rhs) {
243  for (auto& data : lhs) {
244  data /= rhs;
245  }
246  return lhs;
247 }
248 
249 template <int M, int N, class T>
250 bool operator==(const Matrix<M, N, T>& lhs, const Matrix<M, N, T>& rhs) {
251  for (int i = 0; i < M; ++i)
252  for (int j = 0; j < N; ++j)
253  if (lhs[i][j] != rhs[i][j]) return false;
254  return true;
255 }
256 
257 template <int M, int N, class T>
258 std::ostream& operator<<(std::ostream& os, const Matrix<M, N, T>& mat) {
259  return os << mat.toString();
260 }
261 
262 template <int Rows = 2, class Type = double>
263 class Vector : public Matrix<Rows, 1, Type> {
264 public:
265  Vector<Rows, Type>() : Matrix<Rows, 1, Type>() {}
266  Vector<Rows, Type>(const Matrix<Rows, 1, Type>& other)
267  : Matrix<Rows, 1, Type>(other) {}
268  Vector<Rows, Type>(const std::vector<Type>& data)
269  : Matrix<Rows, 1, Type>(data) {}
270 
271  Type& operator[](int col) { return this->data_[col]; }
272 
273  const Type& operator[](int col) const { return this->data_[col]; }
274 
275  virtual std::string toString() const {
276  std::stringstream ss;
277  ss << "[";
278  for (std::size_t i = 0; i < this->data_.size() - 1; ++i) {
279  ss << this->data_[i] << " ";
280  }
281  ss << this->data_[this->data_.size() - 1] << "]";
282  return ss.str();
283  }
284 };
285 
290 template <class Type = double>
291 class Vector2 : public Vector<2, Type> {
292 public:
293  Vector2<Type>() : Vector<2, Type>() {}
294  Vector2<Type>(const std::vector<Type>& data) : Vector<2, Type>(data) {}
295 
296  Vector2<Type>(Type x, Type y) {
297  this->data_[0] = x;
298  this->data_[1] = y;
299  }
300 
301  Vector2<Type>(const Matrix<2, 1, Type>& other) : Vector<2, Type>(other) {}
302 
303  Type& x() { return this->data_[0]; }
304 
305  const Type& x() const { return this->data_[0]; }
306 
307  Type& y() { return this->data_[1]; }
308 
309  const Type& y() const { return this->data_[1]; }
310 };
311 
313 typedef Vector2<double> Vector2d;
314 
316 namespace matrix {
317 
322 template <int M, int N, class T>
323 Matrix<N, M, T> transpose(const Matrix<M, N, T>& m) {
324  Matrix<N, M, T> trans;
325  for (int i = 0; i < M; ++i) {
326  for (int j = 0; j < N; ++j) {
327  trans[j][i] = m[i][j];
328  }
329  }
330  return trans;
331 }
332 
337 template <int R, class T>
338 T dot(const Matrix<R, 1, T>& m1, const Matrix<R, 1, T>& m2) {
339  T sum = 0;
340  for (int i = 0; i < R; ++i) {
341  sum += m1[i][0] * m2[i][0];
342  }
343  return sum;
344 }
345 
352 template <int M, int N, int P, int Q, class T>
353 Matrix<M, Q, T> multiply(const Matrix<M, N, T>& m1, const Matrix<P, Q, T>& m2) {
354  if (N != P) {
355  throw std::runtime_error(
356  "Matrices don't have the right dimensions for multiplication");
357  }
358 
359  Matrix<M, Q, T> res;
360 
361  for (int i = 0; i < M; ++i) {
362  for (int j = 0; j < Q; ++j) {
363  res[i][j] = dot(transpose(m1.getRow(i)), m2.getCol(j));
364  }
365  }
366 
367  return res;
368 }
369 
370 } // matrix
371 
372 } // yage
373 
374 #endif
yage::Matrix::rowSize
int rowSize() const
Returns the row size of the Matrix.
Definition: matrix.hpp:96
+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 
19 #ifndef YAGE_MATH_MATRIX_HPP
20 #define YAGE_MATH_MATRIX_HPP
21 
22 #include <algorithm>
23 #include <exception>
24 #include <iostream>
25 #include <sstream>
26 #include <string>
27 #include <vector>
28 
29 namespace yage {
30 
31 template <int Rows, int Cols, class Type>
32 class Matrix;
33 
41 namespace detail {
42 
51 template <int Rows, int Cols, class Type>
52 class Row {
53 private:
54  Matrix<Rows, Cols, Type>* parent_;
55  int index_;
56 
57 public:
58  Row<Rows, Cols, Type>(Matrix<Rows, Cols, Type>* parent, int index)
59  : parent_(parent), index_(index) {}
60 
61  Type& operator[](int col) {
62  // the index is the y-position of the element in the matrix
63  return parent_->data_[index_ * Cols + col];
64  }
65 
66  const Type& operator[](int col) const {
67  return parent_->data_[index_ * Cols + col];
68  }
69 };
70 
71 } // detail
72 
81 template <int Rows = 4, int Cols = 4, class Type = double>
82 class Matrix {
83  // friended with the row class so that it can access protected member data
84  friend class detail::Row<Rows, Cols, Type>;
85 
86 protected:
88  std::vector<Type> data_;
89 
90 public:
92  Matrix<Rows, Cols, Type>() : data_(Rows * Cols) {}
93  Matrix<Rows, Cols, Type>(const std::vector<Type>& data) : data_(data) {}
94 
96  int rowSize() const { return Rows; }
97 
99  int colSize() const { return Cols; }
100 
107  Matrix<1, Cols, Type> getRow(int row) const {
108  Matrix<1, Cols, Type> rowMatrix;
109  for (int i = 0; i < Cols; ++i) {
110  rowMatrix[0][i] = data_[row][i];
111  }
112  return rowMatrix;
113  }
114 
115  // returns the column in a column matrix
116  Matrix<Rows, 1, Type> getCol(int col) const {
117  Matrix<Rows, 1, Type> colMatrix;
118  for (int i = 0; i < Rows; ++i) {
119  colMatrix[i][0] = data_[i][col];
120  }
121  return colMatrix;
122  }
123 
125  typename std::vector<Type>::iterator begin() { return data_.begin(); }
126 
128  typename std::vector<Type>::iterator end() { return data_.end(); }
129 
133  virtual std::string toString() const {
134  std::stringstream ss;
135  ss << '[';
136  for (int i = 0; i < Rows - 1; ++i) {
137  ss << '[';
138  for (int j = 0; j < Cols - 1; ++j) {
139  ss << data_[i * Cols + j] << ' ';
140  }
141  ss << data_[(Rows - 1) * Cols + Cols - 1] << "],";
142  }
143  ss << '[';
144  for (int j = 0; j < Cols - 1; ++j) {
145  ss << data_[(Rows - 1) * Cols + j] << ' ';
146  }
147  ss << data_[(Rows - 1) * Cols + Cols - 1] << "]]";
148  return ss.str();
149  }
150 
151  detail::Row<Rows, Cols, Type> operator[](int row) {
152  return detail::Row<Rows, Cols, Type>(this, row);
153  }
154 
155  detail::Row<Rows, Cols, Type> operator[](int row) const {
156  // TODO got to fix this
157  return detail::Row<Rows, Cols, Type>((Matrix<Rows, Cols, Type>*)this,
158  row);
159  }
160 
161  Matrix<Rows, Cols, Type>& operator+=(const Matrix<Rows, Cols, Type>& rhs) {
162  std::vector<Type> out;
163  out.reserve(data_.size());
164  std::transform(data_.begin(), data_.end(), rhs.data_.begin(),
165  std::back_inserter(out),
166  [](Type a, Type b) { return a + b; });
167  data_ = std::move(out);
168  return *this;
169  }
170 
171  Matrix<Rows, Cols, Type>& operator-=(const Matrix<Rows, Cols, Type>& rhs) {
172  std::vector<Type> out;
173  out.reserve(data_.size());
174  std::transform(data_.begin(), data_.end(), rhs.begin(),
175  std::back_inserter(out),
176  [](Type a, Type b) { return a - b; });
177  data_ = std::move(out);
178  return *this;
179  }
180 };
181 
182 template <int M, int N, class T>
183 Matrix<M, N, T> operator+(Matrix<M, N, T> lhs, const Matrix<M, N, T>& rhs) {
184  lhs += rhs;
185  return lhs;
186 }
187 
188 template <int M, int N, class T>
189 Matrix<M, N, T> operator-(Matrix<M, N, T> lhs, const Matrix<M, N, T>& rhs) {
190  lhs -= rhs;
191  return lhs;
192 }
193 
194 template <int M, int N, class T>
195 Matrix<M, N, T> operator+(Matrix<M, N, T> lhs, const T& rhs) {
196  for (auto& data : lhs) {
197  data += rhs;
198  }
199  return lhs;
200 }
201 
202 template <int M, int N, class T>
203 Matrix<M, N, T> operator+(const T& lhs, Matrix<M, N, T> rhs) {
204  for (auto& data : rhs) {
205  data += lhs;
206  }
207  return rhs;
208 }
209 
210 template <int M, int N, class T>
211 Matrix<M, N, T> operator-(Matrix<M, N, T> lhs, const T& rhs) {
212  for (auto& data : lhs) {
213  data -= rhs;
214  }
215  return lhs;
216 }
217 
218 template <int M, int N, class T>
219 Matrix<M, N, T> operator-(const T& lhs, Matrix<M, N, T> rhs) {
220  for (auto& data : rhs) {
221  data = lhs - data;
222  }
223  return rhs;
224 }
225 
226 template <int M, int N, class T>
227 Matrix<M, N, T> operator*(Matrix<M, N, T> lhs, const T& rhs) {
228  for (auto& data : lhs) {
229  data *= rhs;
230  }
231  return lhs;
232 }
233 
234 template <int M, int N, class T>
235 Matrix<M, N, T> operator*(const T& lhs, Matrix<M, N, T> rhs) {
236  for (auto& data : rhs) {
237  data *= lhs;
238  }
239  return rhs;
240 }
241 
242 template <int M, int N, class T>
243 Matrix<M, N, T> operator/(Matrix<M, N, T> lhs, const T& rhs) {
244  for (auto& data : lhs) {
245  data /= rhs;
246  }
247  return lhs;
248 }
249 
250 template <int M, int N, class T>
251 bool operator==(const Matrix<M, N, T>& lhs, const Matrix<M, N, T>& rhs) {
252  for (int i = 0; i < M; ++i)
253  for (int j = 0; j < N; ++j)
254  if (lhs[i][j] != rhs[i][j]) return false;
255  return true;
256 }
257 
258 template <int M, int N, class T>
259 std::ostream& operator<<(std::ostream& os, const Matrix<M, N, T>& mat) {
260  return os << mat.toString();
261 }
262 
263 template <int Rows = 2, class Type = double>
264 class Vector : public Matrix<Rows, 1, Type> {
265 public:
266  Vector<Rows, Type>() : Matrix<Rows, 1, Type>() {}
267  Vector<Rows, Type>(const Matrix<Rows, 1, Type>& other)
268  : Matrix<Rows, 1, Type>(other) {}
269  Vector<Rows, Type>(const std::vector<Type>& data)
270  : Matrix<Rows, 1, Type>(data) {}
271 
272  Type& operator[](int col) { return this->data_[col]; }
273 
274  const Type& operator[](int col) const { return this->data_[col]; }
275 
276  virtual std::string toString() const {
277  std::stringstream ss;
278  ss << "[";
279  for (std::size_t i = 0; i < this->data_.size() - 1; ++i) {
280  ss << this->data_[i] << " ";
281  }
282  ss << this->data_[this->data_.size() - 1] << "]";
283  return ss.str();
284  }
285 };
286 
291 template <class Type = double>
292 class Vector2 : public Vector<2, Type> {
293 public:
294  Vector2<Type>() : Vector<2, Type>() {}
295  Vector2<Type>(const std::vector<Type>& data) : Vector<2, Type>(data) {}
296 
297  Vector2<Type>(Type x, Type y) {
298  this->data_[0] = x;
299  this->data_[1] = y;
300  }
301 
302  Vector2<Type>(const Matrix<2, 1, Type>& other) : Vector<2, Type>(other) {}
303 
304  Type& x() { return this->data_[0]; }
305 
306  const Type& x() const { return this->data_[0]; }
307 
308  Type& y() { return this->data_[1]; }
309 
310  const Type& y() const { return this->data_[1]; }
311 };
312 
314 typedef Vector2<double> Vector2d;
315 
317 namespace matrix {
318 
323 template <int M, int N, class T>
324 Matrix<N, M, T> transpose(const Matrix<M, N, T>& m) {
325  Matrix<N, M, T> trans;
326  for (int i = 0; i < M; ++i) {
327  for (int j = 0; j < N; ++j) {
328  trans[j][i] = m[i][j];
329  }
330  }
331  return trans;
332 }
333 
338 template <int R, class T>
339 T dot(const Matrix<R, 1, T>& m1, const Matrix<R, 1, T>& m2) {
340  T sum = 0;
341  for (int i = 0; i < R; ++i) {
342  sum += m1[i][0] * m2[i][0];
343  }
344  return sum;
345 }
346 
353 template <int M, int N, int P, int Q, class T>
354 Matrix<M, Q, T> multiply(const Matrix<M, N, T>& m1, const Matrix<P, Q, T>& m2) {
355  if (N != P) {
356  throw std::runtime_error(
357  "Matrices don't have the right dimensions for multiplication");
358  }
359 
360  Matrix<M, Q, T> res;
361 
362  for (int i = 0; i < M; ++i) {
363  for (int j = 0; j < Q; ++j) {
364  res[i][j] = dot(transpose(m1.getRow(i)), m2.getCol(j));
365  }
366  }
367 
368  return res;
369 }
370 
371 } // matrix
372 
373 } // yage
374 
375 #endif
yage::Matrix::rowSize
int rowSize() const
Returns the row size of the Matrix.
Definition: matrix.hpp:96
yage::Matrix::colSize
int colSize() const
Returns the column size of the Matrixxs.
Definition: matrix.hpp:99
-
yage::Vector2
2D Vector class.
Definition: matrix.hpp:291
+
yage::Vector2
2D Vector class.
Definition: matrix.hpp:292
+
yage::Matrix::end
std::vector< Type >::iterator end()
iterator support for end
Definition: matrix.hpp:128
yage::Matrix::data_
std::vector< Type > data_
Vector containing the data of the matrix.
Definition: matrix.hpp:88
-
yage::matrix::multiply
Matrix< M, Q, T > multiply(const Matrix< M, N, T > &m1, const Matrix< P, Q, T > &m2)
Multiplies two matrices together.
Definition: matrix.hpp:353
-
yage::matrix::transpose
Matrix< N, M, T > transpose(const Matrix< M, N, T > &m)
Transposes a matrix and returns the result.
Definition: matrix.hpp:323
+
yage::matrix::multiply
Matrix< M, Q, T > multiply(const Matrix< M, N, T > &m1, const Matrix< P, Q, T > &m2)
Multiplies two matrices together.
Definition: matrix.hpp:354
+
yage::matrix::transpose
Matrix< N, M, T > transpose(const Matrix< M, N, T > &m)
Transposes a matrix and returns the result.
Definition: matrix.hpp:324
yage::Matrix
Base Matrix class used by other similar classes.
Definition: matrix.hpp:32
-
yage::matrix::dot
T dot(const Matrix< R, 1, T > &m1, const Matrix< R, 1, T > &m2)
Returns the dot product between two vectors.
Definition: matrix.hpp:338
+
yage::Matrix::toString
virtual std::string toString() const
prints out the matrix, but can also be implemented by other classes to print data differently ...
Definition: matrix.hpp:133
+
yage::matrix::dot
T dot(const Matrix< R, 1, T > &m1, const Matrix< R, 1, T > &m2)
Returns the dot product between two vectors.
Definition: matrix.hpp:339
yage::Matrix::getRow
Matrix< 1, Cols, Type > getRow(int row) const
Return the row specified row as a Matrix with only one row.
Definition: matrix.hpp:107
yage
Definition: camera2d.hpp:17
+
yage::Matrix::begin
std::vector< Type >::iterator begin()
iterator support for begin
Definition: matrix.hpp:125
-Generated on Sun Aug 13 2017 17:48:31 for YAGE by   +Generated on Mon Aug 21 2017 20:54:26 for YAGE by   doxygen 1.8.13
-- cgit