]> git.mxchange.org Git - simgear.git/blob - simgear/math/SGMatrix.hxx
Merge branch 'maint' into next
[simgear.git] / simgear / math / SGMatrix.hxx
1 // Copyright (C) 2006  Mathias Froehlich - Mathias.Froehlich@web.de
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Library General Public
5 // License as published by the Free Software Foundation; either
6 // version 2 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Library General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with this program; if not, write to the Free Software
15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
16 //
17
18 #ifndef SGMatrix_H
19 #define SGMatrix_H
20
21 /// Expression templates for poor programmers ... :)
22 template<typename T>
23 struct TransNegRef;
24
25 /// 3D Matrix Class
26 template<typename T>
27 class SGMatrix {
28 public:
29   enum { nCols = 4, nRows = 4, nEnts = 16 };
30   typedef T value_type;
31
32   /// Default constructor. Does not initialize at all.
33   /// If you need them zero initialized, use SGMatrix::zeros()
34   SGMatrix(void)
35   {
36     /// Initialize with nans in the debug build, that will guarantee to have
37     /// a fast uninitialized default constructor in the release but shows up
38     /// uninitialized values in the debug build very fast ...
39 #ifndef NDEBUG
40     for (unsigned i = 0; i < nEnts; ++i)
41       _data.flat[i] = SGLimits<T>::quiet_NaN();
42 #endif
43   }
44   /// Constructor. Initialize by the content of a plain array,
45   /// make sure it has at least 16 elements
46   explicit SGMatrix(const T* data)
47   { for (unsigned i = 0; i < nEnts; ++i) _data.flat[i] = data[i]; }
48
49   /// Constructor, build up a SGMatrix from given elements
50   SGMatrix(T m00, T m01, T m02, T m03,
51            T m10, T m11, T m12, T m13,
52            T m20, T m21, T m22, T m23,
53            T m30, T m31, T m32, T m33)
54   {
55     _data.flat[0] = m00; _data.flat[1] = m10;
56     _data.flat[2] = m20; _data.flat[3] = m30;
57     _data.flat[4] = m01; _data.flat[5] = m11;
58     _data.flat[6] = m21; _data.flat[7] = m31;
59     _data.flat[8] = m02; _data.flat[9] = m12;
60     _data.flat[10] = m22; _data.flat[11] = m32;
61     _data.flat[12] = m03; _data.flat[13] = m13;
62     _data.flat[14] = m23; _data.flat[15] = m33;
63   }
64
65   /// Constructor, build up a SGMatrix from a translation
66   template<typename S>
67   SGMatrix(const SGVec3<S>& trans)
68   { set(trans); }
69
70   /// Constructor, build up a SGMatrix from a rotation and a translation
71   template<typename S>
72   SGMatrix(const SGQuat<S>& quat)
73   { set(quat); }
74
75   /// Copy constructor for a transposed negated matrix
76   SGMatrix(const TransNegRef<T>& tm)
77   { set(tm); }
78
79   /// Set from a tranlation
80   template<typename S>
81   void set(const SGVec3<S>& trans)
82   {
83     _data.flat[0] = 1; _data.flat[4] = 0;
84     _data.flat[8] = 0; _data.flat[12] = T(trans(0));
85     _data.flat[1] = 0; _data.flat[5] = 1;
86     _data.flat[9] = 0; _data.flat[13] = T(trans(1));
87     _data.flat[2] = 0; _data.flat[6] = 0;
88     _data.flat[10] = 1; _data.flat[14] = T(trans(2));
89     _data.flat[3] = 0; _data.flat[7] = 0;
90     _data.flat[11] = 0; _data.flat[15] = 1;
91   }
92
93   /// Set from a scale/rotation and tranlation
94   template<typename S>
95   void set(const SGQuat<S>& quat)
96   {
97     T w = quat.w(); T x = quat.x(); T y = quat.y(); T z = quat.z();
98     T xx = x*x; T yy = y*y; T zz = z*z;
99     T wx = w*x; T wy = w*y; T wz = w*z;
100     T xy = x*y; T xz = x*z; T yz = y*z;
101     _data.flat[0] = 1-2*(yy+zz); _data.flat[1] = 2*(xy-wz);
102     _data.flat[2] = 2*(xz+wy); _data.flat[3] = 0;
103     _data.flat[4] = 2*(xy+wz); _data.flat[5] = 1-2*(xx+zz);
104     _data.flat[6] = 2*(yz-wx); _data.flat[7] = 0;
105     _data.flat[8] = 2*(xz-wy); _data.flat[9] = 2*(yz+wx);
106     _data.flat[10] = 1-2*(xx+yy); _data.flat[11] = 0;
107     _data.flat[12] = 0; _data.flat[13] = 0;
108     _data.flat[14] = 0; _data.flat[15] = 1;
109   }
110
111   /// set from a transposed negated matrix
112   void set(const TransNegRef<T>& tm)
113   {
114     const SGMatrix& m = tm.m;
115     _data.flat[0] = m(0,0);
116     _data.flat[1] = m(0,1);
117     _data.flat[2] = m(0,2);
118     _data.flat[3] = m(3,0);
119
120     _data.flat[4] = m(1,0);
121     _data.flat[5] = m(1,1);
122     _data.flat[6] = m(1,2);
123     _data.flat[7] = m(3,1);
124
125     _data.flat[8] = m(2,0);
126     _data.flat[9] = m(2,1);
127     _data.flat[10] = m(2,2);
128     _data.flat[11] = m(3,2);
129
130     // Well, this one is ugly here, as that xform method on the current
131     // object needs the above data to be already set ...
132     SGVec3<T> t = xformVec(SGVec3<T>(m(0,3), m(1,3), m(2,3)));
133     _data.flat[12] = -t(0);
134     _data.flat[13] = -t(1);
135     _data.flat[14] = -t(2);
136     _data.flat[15] = m(3,3);
137   }
138
139   /// Access by index, the index is unchecked
140   const T& operator()(unsigned i, unsigned j) const
141   { return _data.flat[i + 4*j]; }
142   /// Access by index, the index is unchecked
143   T& operator()(unsigned i, unsigned j)
144   { return _data.flat[i + 4*j]; }
145
146   /// Access raw data by index, the index is unchecked
147   const T& operator[](unsigned i) const
148   { return _data.flat[i]; }
149   /// Access by index, the index is unchecked
150   T& operator[](unsigned i)
151   { return _data.flat[i]; }
152
153   /// Get the data pointer
154   const T* data(void) const
155   { return _data.flat; }
156   /// Get the data pointer
157   T* data(void)
158   { return _data.flat; }
159
160   /// Readonly interface function to ssg's sgMat4/sgdMat4
161   const T (&sg(void) const)[4][4]
162   { return _data.carray; }
163   /// Interface function to ssg's sgMat4/sgdMat4
164   T (&sg(void))[4][4]
165   { return _data.carray; }
166
167   /// Inplace addition
168   SGMatrix& operator+=(const SGMatrix& m)
169   { for (unsigned i = 0; i < nEnts; ++i) _data.flat[i] += m._data.flat[i]; return *this; }
170   /// Inplace subtraction
171   SGMatrix& operator-=(const SGMatrix& m)
172   { for (unsigned i = 0; i < nEnts; ++i) _data.flat[i] -= m._data.flat[i]; return *this; }
173   /// Inplace scalar multiplication
174   template<typename S>
175   SGMatrix& operator*=(S s)
176   { for (unsigned i = 0; i < nEnts; ++i) _data.flat[i] *= s; return *this; }
177   /// Inplace scalar multiplication by 1/s
178   template<typename S>
179   SGMatrix& operator/=(S s)
180   { return operator*=(1/T(s)); }
181   /// Inplace matrix multiplication, post multiply
182   SGMatrix& operator*=(const SGMatrix<T>& m2);
183
184   template<typename S>
185   SGMatrix& preMultTranslate(const SGVec3<S>& t)
186   {
187     for (unsigned i = 0; i < SGMatrix<T>::nCols-1; ++i)
188       (*this)(i,3) += T(t(i));
189     return *this;
190   }
191   template<typename S>
192   SGMatrix& postMultTranslate(const SGVec3<S>& t)
193   {
194     SGVec4<T> col3((*this)(0,3), (*this)(1,3), (*this)(2,3), (*this)(3,3));
195     for (unsigned i = 0; i < SGMatrix<T>::nCols-1; ++i) {
196       SGVec4<T> tmp((*this)(0,3), (*this)(1,3), (*this)(2,3), (*this)(3,3));
197       col3 += T(t(i))*tmp;
198     }
199     (*this)(0,3) = col3(0); (*this)(1,3) = col3(1);
200     (*this)(2,3) = col3(2); (*this)(3,3) = col3(3);
201     return *this;
202   }
203
204   SGMatrix& preMultRotate(const SGQuat<T>& r)
205   {
206     for (unsigned i = 0; i < SGMatrix<T>::nCols; ++i) {
207       SGVec3<T> col((*this)(0,i), (*this)(1,i), (*this)(2,i));
208       col = r.transform(col);
209       (*this)(0,i) = col(0); (*this)(1,i) = col(1); (*this)(2,i) = col(2);
210     }
211     return *this;
212   }
213   SGMatrix& postMultRotate(const SGQuat<T>& r)
214   {
215     for (unsigned i = 0; i < SGMatrix<T>::nCols; ++i) {
216       SGVec3<T> col((*this)(i,0), (*this)(i,1), (*this)(i,2));
217       col = r.backTransform(col);
218       (*this)(i,0) = col(0); (*this)(i,1) = col(1); (*this)(i,2) = col(2);
219     }
220     return *this;
221   }
222
223   SGVec3<T> xformPt(const SGVec3<T>& pt) const
224   {
225     SGVec3<T> tpt;
226     tpt(0) = (*this)(0,3);
227     tpt(1) = (*this)(1,3);
228     tpt(2) = (*this)(2,3);
229     for (unsigned i = 0; i < SGMatrix<T>::nCols-1; ++i) {
230       T tmp = pt(i);
231       tpt(0) += tmp*(*this)(0,i);
232       tpt(1) += tmp*(*this)(1,i);
233       tpt(2) += tmp*(*this)(2,i);
234     }
235     return tpt;
236   }
237   SGVec3<T> xformVec(const SGVec3<T>& v) const
238   {
239     SGVec3<T> tv;
240     T tmp = v(0);
241     tv(0) = tmp*(*this)(0,0);
242     tv(1) = tmp*(*this)(1,0);
243     tv(2) = tmp*(*this)(2,0);
244     for (unsigned i = 1; i < SGMatrix<T>::nCols-1; ++i) {
245       T tmp = v(i);
246       tv(0) += tmp*(*this)(0,i);
247       tv(1) += tmp*(*this)(1,i);
248       tv(2) += tmp*(*this)(2,i);
249     }
250     return tv;
251   }
252
253   /// Return an all zero matrix
254   static SGMatrix zeros(void)
255   { return SGMatrix(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0); }
256
257   /// Return a unit matrix
258   static SGMatrix unit(void)
259   { return SGMatrix(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1); }
260
261 private:
262   /// Required to make that alias safe.
263   union Data {
264     T flat[16];
265     T carray[4][4];
266   };
267
268   /// The actual data, the matrix is stored in column major order,
269   /// that matches the storage format of OpenGL
270   Data _data;
271 };
272
273 /// Class to distinguish between a matrix and the matrix with a transposed
274 /// rotational part and a negated translational part
275 template<typename T>
276 struct TransNegRef {
277   TransNegRef(const SGMatrix<T>& _m) : m(_m) {}
278   const SGMatrix<T>& m;
279 };
280
281 /// Unary +, do nothing ...
282 template<typename T>
283 inline
284 const SGMatrix<T>&
285 operator+(const SGMatrix<T>& m)
286 { return m; }
287
288 /// Unary -, do nearly nothing
289 template<typename T>
290 inline
291 SGMatrix<T>
292 operator-(const SGMatrix<T>& m)
293 {
294   SGMatrix<T> ret;
295   for (unsigned i = 0; i < SGMatrix<T>::nEnts; ++i)
296     ret[i] = -m[i];
297   return ret;
298 }
299
300 /// Binary +
301 template<typename T>
302 inline
303 SGMatrix<T>
304 operator+(const SGMatrix<T>& m1, const SGMatrix<T>& m2)
305 {
306   SGMatrix<T> ret;
307   for (unsigned i = 0; i < SGMatrix<T>::nEnts; ++i)
308     ret[i] = m1[i] + m2[i];
309   return ret;
310 }
311
312 /// Binary -
313 template<typename T>
314 inline
315 SGMatrix<T>
316 operator-(const SGMatrix<T>& m1, const SGMatrix<T>& m2)
317 {
318   SGMatrix<T> ret;
319   for (unsigned i = 0; i < SGMatrix<T>::nEnts; ++i)
320     ret[i] = m1[i] - m2[i];
321   return ret;
322 }
323
324 /// Scalar multiplication
325 template<typename S, typename T>
326 inline
327 SGMatrix<T>
328 operator*(S s, const SGMatrix<T>& m)
329 {
330   SGMatrix<T> ret;
331   for (unsigned i = 0; i < SGMatrix<T>::nEnts; ++i)
332     ret[i] = s*m[i];
333   return ret;
334 }
335
336 /// Scalar multiplication
337 template<typename S, typename T>
338 inline
339 SGMatrix<T>
340 operator*(const SGMatrix<T>& m, S s)
341 {
342   SGMatrix<T> ret;
343   for (unsigned i = 0; i < SGMatrix<T>::nEnts; ++i)
344     ret[i] = s*m[i];
345   return ret;
346 }
347
348 /// Vector multiplication
349 template<typename T>
350 inline
351 SGVec4<T>
352 operator*(const SGMatrix<T>& m, const SGVec4<T>& v)
353 {
354   SGVec4<T> mv;
355   T tmp = v(0);
356   mv(0) = tmp*m(0,0);
357   mv(1) = tmp*m(1,0);
358   mv(2) = tmp*m(2,0);
359   mv(3) = tmp*m(3,0);
360   for (unsigned i = 1; i < SGMatrix<T>::nCols; ++i) {
361     T tmp = v(i);
362     mv(0) += tmp*m(0,i);
363     mv(1) += tmp*m(1,i);
364     mv(2) += tmp*m(2,i);
365     mv(3) += tmp*m(3,i);
366   }
367   return mv;
368 }
369
370 /// Vector multiplication
371 template<typename T>
372 inline
373 SGVec4<T>
374 operator*(const TransNegRef<T>& tm, const SGVec4<T>& v)
375 {
376   const SGMatrix<T>& m = tm.m;
377   SGVec4<T> mv;
378   SGVec3<T> v2;
379   T tmp = v(3);
380   mv(0) = v2(0) = -tmp*m(0,3);
381   mv(1) = v2(1) = -tmp*m(1,3);
382   mv(2) = v2(2) = -tmp*m(2,3);
383   mv(3) = tmp*m(3,3);
384   for (unsigned i = 0; i < SGMatrix<T>::nCols - 1; ++i) {
385     T tmp = v(i) + v2(i);
386     mv(0) += tmp*m(i,0);
387     mv(1) += tmp*m(i,1);
388     mv(2) += tmp*m(i,2);
389     mv(3) += tmp*m(3,i);
390   }
391   return mv;
392 }
393
394 /// Matrix multiplication
395 template<typename T>
396 inline
397 SGMatrix<T>
398 operator*(const SGMatrix<T>& m1, const SGMatrix<T>& m2)
399 {
400   SGMatrix<T> m;
401   for (unsigned j = 0; j < SGMatrix<T>::nCols; ++j) {
402     T tmp = m2(0,j);
403     m(0,j) = tmp*m1(0,0);
404     m(1,j) = tmp*m1(1,0);
405     m(2,j) = tmp*m1(2,0);
406     m(3,j) = tmp*m1(3,0);
407     for (unsigned i = 1; i < SGMatrix<T>::nCols; ++i) {
408       T tmp = m2(i,j);
409       m(0,j) += tmp*m1(0,i);
410       m(1,j) += tmp*m1(1,i);
411       m(2,j) += tmp*m1(2,i);
412       m(3,j) += tmp*m1(3,i);
413     }
414   }
415   return m;
416 }
417
418 /// Inplace matrix multiplication, post multiply
419 template<typename T>
420 inline
421 SGMatrix<T>&
422 SGMatrix<T>::operator*=(const SGMatrix<T>& m2)
423 { (*this) = operator*(*this, m2); return *this; }
424
425 /// Return a reference to the matrix typed to make sure we use the transposed
426 /// negated matrix
427 template<typename T>
428 inline
429 TransNegRef<T>
430 transNeg(const SGMatrix<T>& m)
431 { return TransNegRef<T>(m); }
432
433 /// Compute the inverse if the matrix src. Store the result in dst.
434 /// Return if the matrix is nonsingular. If it is singular dst contains
435 /// undefined values
436 template<typename T>
437 inline
438 bool
439 invert(SGMatrix<T>& dst, const SGMatrix<T>& src)
440 {
441   // Do a LU decomposition with row pivoting and solve into dst
442   SGMatrix<T> tmp = src;
443   dst = SGMatrix<T>::unit();
444
445   for (unsigned i = 0; i < 4; ++i) {
446     T val = tmp(i,i);
447     unsigned ind = i;
448
449     // Find the row with the maximum value in the i-th colum
450     for (unsigned j = i + 1; j < 4; ++j) {
451       if (fabs(tmp(j, i)) > fabs(val)) {
452         ind = j;
453         val = tmp(j, i);
454       }
455     }
456
457     // Do row pivoting
458     if (ind != i) {
459       for (unsigned j = 0; j < 4; ++j) {
460         T t;
461         t = dst(i,j); dst(i,j) = dst(ind,j); dst(ind,j) = t;
462         t = tmp(i,j); tmp(i,j) = tmp(ind,j); tmp(ind,j) = t;
463       }
464     }
465
466     // Check for singularity
467     if (fabs(val) <= SGLimits<T>::min())
468       return false;
469
470     T ival = 1/val;
471     for (unsigned j = 0; j < 4; ++j) {
472       tmp(i,j) *= ival;
473       dst(i,j) *= ival;
474     }
475
476     for (unsigned j = 0; j < 4; ++j) {
477       if (j == i)
478         continue;
479
480       val = tmp(j,i);
481       for (unsigned k = 0; k < 4; ++k) {
482         tmp(j,k) -= tmp(i,k) * val;
483         dst(j,k) -= dst(i,k) * val;
484       }
485     }
486   }
487   return true;
488 }
489
490 /// The 1-norm of the matrix, this is the largest column sum of
491 /// the absolute values of A.
492 template<typename T>
493 inline
494 T
495 norm1(const SGMatrix<T>& m)
496 {
497   T nrm = 0;
498   for (unsigned i = 0; i < SGMatrix<T>::nRows; ++i) {
499     T sum = fabs(m(i, 0)) + fabs(m(i, 1)) + fabs(m(i, 2)) + fabs(m(i, 3));
500     if (nrm < sum)
501       nrm = sum;
502   }
503   return nrm;
504 }
505
506 /// The inf-norm of the matrix, this is the largest row sum of
507 /// the absolute values of A.
508 template<typename T>
509 inline
510 T
511 normInf(const SGMatrix<T>& m)
512 {
513   T nrm = 0;
514   for (unsigned i = 0; i < SGMatrix<T>::nCols; ++i) {
515     T sum = fabs(m(0, i)) + fabs(m(1, i)) + fabs(m(2, i)) + fabs(m(3, i));
516     if (nrm < sum)
517       nrm = sum;
518   }
519   return nrm;
520 }
521
522 /// Return true if exactly the same
523 template<typename T>
524 inline
525 bool
526 operator==(const SGMatrix<T>& m1, const SGMatrix<T>& m2)
527 {
528   for (unsigned i = 0; i < SGMatrix<T>::nEnts; ++i)
529     if (m1[i] != m2[i])
530       return false;
531   return true;
532 }
533
534 /// Return true if not exactly the same
535 template<typename T>
536 inline
537 bool
538 operator!=(const SGMatrix<T>& m1, const SGMatrix<T>& m2)
539 { return ! (m1 == m2); }
540
541 /// Return true if equal to the relative tolerance tol
542 template<typename T>
543 inline
544 bool
545 equivalent(const SGMatrix<T>& m1, const SGMatrix<T>& m2, T rtol, T atol)
546 { return norm1(m1 - m2) < rtol*(norm1(m1) + norm1(m2)) + atol; }
547
548 /// Return true if equal to the relative tolerance tol
549 template<typename T>
550 inline
551 bool
552 equivalent(const SGMatrix<T>& m1, const SGMatrix<T>& m2, T rtol)
553 { return norm1(m1 - m2) < rtol*(norm1(m1) + norm1(m2)); }
554
555 /// Return true if about equal to roundoff of the underlying type
556 template<typename T>
557 inline
558 bool
559 equivalent(const SGMatrix<T>& m1, const SGMatrix<T>& m2)
560 {
561   T tol = 100*SGLimits<T>::epsilon();
562   return equivalent(m1, m2, tol, tol);
563 }
564
565 #ifndef NDEBUG
566 template<typename T>
567 inline
568 bool
569 isNaN(const SGMatrix<T>& m)
570 {
571   for (unsigned i = 0; i < SGMatrix<T>::nEnts; ++i) {
572     if (SGMisc<T>::isNaN(m[i]))
573       return true;
574   }
575   return false;
576 }
577 #endif
578
579 /// Output to an ostream
580 template<typename char_type, typename traits_type, typename T> 
581 inline
582 std::basic_ostream<char_type, traits_type>&
583 operator<<(std::basic_ostream<char_type, traits_type>& s, const SGMatrix<T>& m)
584 {
585   s << "[ " << m(0,0) << ", " << m(0,1) << ", " << m(0,2) << ", " << m(0,3) << "\n";
586   s << "  " << m(1,0) << ", " << m(1,1) << ", " << m(1,2) << ", " << m(1,3) << "\n";
587   s << "  " << m(2,0) << ", " << m(2,1) << ", " << m(2,2) << ", " << m(2,3) << "\n";
588   s << "  " << m(3,0) << ", " << m(3,1) << ", " << m(3,2) << ", " << m(3,3) << " ]";
589   return s;
590 }
591
592 inline
593 SGMatrixf
594 toMatrixf(const SGMatrixd& m)
595 {
596   return SGMatrixf((float)m(0,0), (float)m(0,1), (float)m(0,2), (float)m(0,3),
597                    (float)m(1,0), (float)m(1,1), (float)m(1,2), (float)m(1,3),
598                    (float)m(2,0), (float)m(2,1), (float)m(2,2), (float)m(2,3),
599                    (float)m(3,0), (float)m(3,1), (float)m(3,2), (float)m(3,3));
600 }
601
602 inline
603 SGMatrixd
604 toMatrixd(const SGMatrixf& m)
605 {
606   return SGMatrixd(m(0,0), m(0,1), m(0,2), m(0,3),
607                    m(1,0), m(1,1), m(1,2), m(1,3),
608                    m(2,0), m(2,1), m(2,2), m(2,3),
609                    m(3,0), m(3,1), m(3,2), m(3,3));
610 }
611
612 #endif