simgear/math/SGVec4.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 SGVec4_H
  19 #define SGVec4_H
  20
  21 #include <osg/Vec4f>
  22 #include <osg/Vec4d>
  23
  24 template<typename T>
  25 struct SGVec4Storage {
  26   /// Readonly raw storage interface
  27   const T (&data(void) const)[4]
  28   { return _data; }
  29   /// Readonly raw storage interface
  30   T (&data(void))[4]
  31   { return _data; }
  32
  33   void osg() const
  34   { }
  35
  36 private:
  37   T _data[4];
  38 };
  39
  40 template<>
  41 struct SGVec4Storage<float> : public osg::Vec4f {
  42   /// Access raw data by index, the index is unchecked
  43   const float (&data(void) const)[4]
  44   { return osg::Vec4f::_v; }
  45   /// Access raw data by index, the index is unchecked
  46   float (&data(void))[4]
  47   { return osg::Vec4f::_v; }
  48
  49   const osg::Vec4f& osg() const
  50   { return *this; }
  51   osg::Vec4f& osg()
  52   { return *this; }
  53 };
  54
  55 template<>
  56 struct SGVec4Storage<double> : public osg::Vec4d {
  57   /// Access raw data by index, the index is unchecked
  58   const double (&data(void) const)[4]
  59   { return osg::Vec4d::_v; }
  60   /// Access raw data by index, the index is unchecked
  61   double (&data(void))[4]
  62   { return osg::Vec4d::_v; }
  63
  64   const osg::Vec4d& osg() const
  65   { return *this; }
  66   osg::Vec4d& osg()
  67   { return *this; }
  68 };
  69
  70 /// 4D Vector Class
  71 template<typename T>
  72 class SGVec4 : protected SGVec4Storage<T> {
  73 public:
  74   typedef T value_type;
  75
  76   /// Default constructor. Does not initialize at all.
  77   /// If you need them zero initialized, use SGVec4::zeros()
  78   SGVec4(void)
  79   {
  80     /// Initialize with nans in the debug build, that will guarantee to have
  81     /// a fast uninitialized default constructor in the release but shows up
  82     /// uninitialized values in the debug build very fast ...
  83 #ifndef NDEBUG
  84     for (unsigned i = 0; i < 4; ++i)
  85       data()[i] = SGLimits<T>::quiet_NaN();
  86 #endif
  87   }
  88   /// Constructor. Initialize by the given values
  89   SGVec4(T x, T y, T z, T w)
  90   { data()[0] = x; data()[1] = y; data()[2] = z; data()[3] = w; }
  91   /// Constructor. Initialize by the content of a plain array,
  92   /// make sure it has at least 3 elements
  93   explicit SGVec4(const T* d)
  94   { data()[0] = d[0]; data()[1] = d[1]; data()[2] = d[2]; data()[3] = d[3]; }
  95   explicit SGVec4(const osg::Vec4f& d)
  96   { data()[0] = d[0]; data()[1] = d[1]; data()[2] = d[2]; data()[3] = d[3]; }
  97   explicit SGVec4(const osg::Vec4d& d)
  98   { data()[0] = d[0]; data()[1] = d[1]; data()[2] = d[2]; data()[3] = d[3]; }
  99   explicit SGVec4(const SGVec3<T>& v3, const T& v4 = 0)
 100   { data()[0] = v3[0]; data()[1] = v3[1]; data()[2] = v3[2]; data()[3] = v4; }
 101
 102
 103   /// Access by index, the index is unchecked
 104   const T& operator()(unsigned i) const
 105   { return data()[i]; }
 106   /// Access by index, the index is unchecked
 107   T& operator()(unsigned i)
 108   { return data()[i]; }
 109
 110   /// Access raw data by index, the index is unchecked
 111   const T& operator[](unsigned i) const
 112   { return data()[i]; }
 113   /// Access raw data by index, the index is unchecked
 114   T& operator[](unsigned i)
 115   { return data()[i]; }
 116
 117   /// Access the x component
 118   const T& x(void) const
 119   { return data()[0]; }
 120   /// Access the x component
 121   T& x(void)
 122   { return data()[0]; }
 123   /// Access the y component
 124   const T& y(void) const
 125   { return data()[1]; }
 126   /// Access the y component
 127   T& y(void)
 128   { return data()[1]; }
 129   /// Access the z component
 130   const T& z(void) const
 131   { return data()[2]; }
 132   /// Access the z component
 133   T& z(void)
 134   { return data()[2]; }
 135   /// Access the x component
 136   const T& w(void) const
 137   { return data()[3]; }
 138   /// Access the x component
 139   T& w(void)
 140   { return data()[3]; }
 141
 142   /// Get the data pointer
 143   using SGVec4Storage<T>::data;
 144
 145   /// Readonly interface function to ssg's sgVec4/sgdVec4
 146   const T (&sg(void) const)[4]
 147   { return data(); }
 148   /// Interface function to ssg's sgVec4/sgdVec4
 149   T (&sg(void))[4]
 150   { return data(); }
 151
 152   /// Interface function to osg's Vec4*
 153   using SGVec4Storage<T>::osg;
 154
 155   /// Inplace addition
 156   SGVec4& operator+=(const SGVec4& v)
 157   { data()[0]+=v(0);data()[1]+=v(1);data()[2]+=v(2);data()[3]+=v(3);return *this; }
 158   /// Inplace subtraction
 159   SGVec4& operator-=(const SGVec4& v)
 160   { data()[0]-=v(0);data()[1]-=v(1);data()[2]-=v(2);data()[3]-=v(3);return *this; }
 161   /// Inplace scalar multiplication
 162   template<typename S>
 163   SGVec4& operator*=(S s)
 164   { data()[0] *= s; data()[1] *= s; data()[2] *= s; data()[3] *= s; return *this; }
 165   /// Inplace scalar multiplication by 1/s
 166   template<typename S>
 167   SGVec4& operator/=(S s)
 168   { return operator*=(1/T(s)); }
 169
 170   /// Return an all zero vector
 171   static SGVec4 zeros(void)
 172   { return SGVec4(0, 0, 0, 0); }
 173   /// Return unit vectors
 174   static SGVec4 e1(void)
 175   { return SGVec4(1, 0, 0, 0); }
 176   static SGVec4 e2(void)
 177   { return SGVec4(0, 1, 0, 0); }
 178   static SGVec4 e3(void)
 179   { return SGVec4(0, 0, 1, 0); }
 180   static SGVec4 e4(void)
 181   { return SGVec4(0, 0, 0, 1); }
 182 };
 183
 184 /// Unary +, do nothing ...
 185 template<typename T>
 186 inline
 187 const SGVec4<T>&
 188 operator+(const SGVec4<T>& v)
 189 { return v; }
 190
 191 /// Unary -, do nearly nothing
 192 template<typename T>
 193 inline
 194 SGVec4<T>
 195 operator-(const SGVec4<T>& v)
 196 { return SGVec4<T>(-v(0), -v(1), -v(2), -v(3)); }
 197
 198 /// Binary +
 199 template<typename T>
 200 inline
 201 SGVec4<T>
 202 operator+(const SGVec4<T>& v1, const SGVec4<T>& v2)
 203 { return SGVec4<T>(v1(0)+v2(0), v1(1)+v2(1), v1(2)+v2(2), v1(3)+v2(3)); }
 204
 205 /// Binary -
 206 template<typename T>
 207 inline
 208 SGVec4<T>
 209 operator-(const SGVec4<T>& v1, const SGVec4<T>& v2)
 210 { return SGVec4<T>(v1(0)-v2(0), v1(1)-v2(1), v1(2)-v2(2), v1(3)-v2(3)); }
 211
 212 /// Scalar multiplication
 213 template<typename S, typename T>
 214 inline
 215 SGVec4<T>
 216 operator*(S s, const SGVec4<T>& v)
 217 { return SGVec4<T>(s*v(0), s*v(1), s*v(2), s*v(3)); }
 218
 219 /// Scalar multiplication
 220 template<typename S, typename T>
 221 inline
 222 SGVec4<T>
 223 operator*(const SGVec4<T>& v, S s)
 224 { return SGVec4<T>(s*v(0), s*v(1), s*v(2), s*v(3)); }
 225
 226 /// multiplication as a multiplicator, that is assume that the first vector
 227 /// represents a 4x4 diagonal matrix with the diagonal elements in the vector.
 228 /// Then the result is the product of that matrix times the second vector.
 229 template<typename T>
 230 inline
 231 SGVec4<T>
 232 mult(const SGVec4<T>& v1, const SGVec4<T>& v2)
 233 { return SGVec4<T>(v1(0)*v2(0), v1(1)*v2(1), v1(2)*v2(2), v1(3)*v2(3)); }
 234
 235 /// component wise min
 236 template<typename T>
 237 inline
 238 SGVec4<T>
 239 min(const SGVec4<T>& v1, const SGVec4<T>& v2)
 240 {
 241   return SGVec4<T>(SGMisc<T>::min(v1(0), v2(0)),
 242                    SGMisc<T>::min(v1(1), v2(1)),
 243                    SGMisc<T>::min(v1(2), v2(2)),
 244                    SGMisc<T>::min(v1(3), v2(3)));
 245 }
 246 template<typename S, typename T>
 247 inline
 248 SGVec4<T>
 249 min(const SGVec4<T>& v, S s)
 250 {
 251   return SGVec4<T>(SGMisc<T>::min(s, v(0)),
 252                    SGMisc<T>::min(s, v(1)),
 253                    SGMisc<T>::min(s, v(2)),
 254                    SGMisc<T>::min(s, v(3)));
 255 }
 256 template<typename S, typename T>
 257 inline
 258 SGVec4<T>
 259 min(S s, const SGVec4<T>& v)
 260 {
 261   return SGVec4<T>(SGMisc<T>::min(s, v(0)),
 262                    SGMisc<T>::min(s, v(1)),
 263                    SGMisc<T>::min(s, v(2)),
 264                    SGMisc<T>::min(s, v(3)));
 265 }
 266
 267 /// component wise max
 268 template<typename T>
 269 inline
 270 SGVec4<T>
 271 max(const SGVec4<T>& v1, const SGVec4<T>& v2)
 272 {
 273   return SGVec4<T>(SGMisc<T>::max(v1(0), v2(0)),
 274                    SGMisc<T>::max(v1(1), v2(1)),
 275                    SGMisc<T>::max(v1(2), v2(2)),
 276                    SGMisc<T>::max(v1(3), v2(3)));
 277 }
 278 template<typename S, typename T>
 279 inline
 280 SGVec4<T>
 281 max(const SGVec4<T>& v, S s)
 282 {
 283   return SGVec4<T>(SGMisc<T>::max(s, v(0)),
 284                    SGMisc<T>::max(s, v(1)),
 285                    SGMisc<T>::max(s, v(2)),
 286                    SGMisc<T>::max(s, v(3)));
 287 }
 288 template<typename S, typename T>
 289 inline
 290 SGVec4<T>
 291 max(S s, const SGVec4<T>& v)
 292 {
 293   return SGVec4<T>(SGMisc<T>::max(s, v(0)),
 294                    SGMisc<T>::max(s, v(1)),
 295                    SGMisc<T>::max(s, v(2)),
 296                    SGMisc<T>::max(s, v(3)));
 297 }
 298
 299 /// Scalar dot product
 300 template<typename T>
 301 inline
 302 T
 303 dot(const SGVec4<T>& v1, const SGVec4<T>& v2)
 304 { return v1(0)*v2(0) + v1(1)*v2(1) + v1(2)*v2(2) + v1(3)*v2(3); }
 305
 306 /// The euclidean norm of the vector, that is what most people call length
 307 template<typename T>
 308 inline
 309 T
 310 norm(const SGVec4<T>& v)
 311 { return sqrt(dot(v, v)); }
 312
 313 /// The euclidean norm of the vector, that is what most people call length
 314 template<typename T>
 315 inline
 316 T
 317 length(const SGVec4<T>& v)
 318 { return sqrt(dot(v, v)); }
 319
 320 /// The 1-norm of the vector, this one is the fastest length function we
 321 /// can implement on modern cpu's
 322 template<typename T>
 323 inline
 324 T
 325 norm1(const SGVec4<T>& v)
 326 { return fabs(v(0)) + fabs(v(1)) + fabs(v(2)) + fabs(v(3)); }
 327
 328 /// The inf-norm of the vector
 329 template<typename T>
 330 inline
 331 T
 332 normI(const SGVec4<T>& v)
 333 { return SGMisc<T>::max(fabs(v(0)), fabs(v(1)), fabs(v(2)), fabs(v(2))); }
 334
 335 /// The euclidean norm of the vector, that is what most people call length
 336 template<typename T>
 337 inline
 338 SGVec4<T>
 339 normalize(const SGVec4<T>& v)
 340 { return (1/norm(v))*v; }
 341
 342 /// Return true if exactly the same
 343 template<typename T>
 344 inline
 345 bool
 346 operator==(const SGVec4<T>& v1, const SGVec4<T>& v2)
 347 { return v1(0)==v2(0) && v1(1)==v2(1) && v1(2)==v2(2) && v1(3)==v2(3); }
 348
 349 /// Return true if not exactly the same
 350 template<typename T>
 351 inline
 352 bool
 353 operator!=(const SGVec4<T>& v1, const SGVec4<T>& v2)
 354 { return ! (v1 == v2); }
 355
 356 /// Return true if smaller, good for putting that into a std::map
 357 template<typename T>
 358 inline
 359 bool
 360 operator<(const SGVec4<T>& v1, const SGVec4<T>& v2)
 361 {
 362   if (v1(0) < v2(0)) return true;
 363   else if (v2(0) < v1(0)) return false;
 364   else if (v1(1) < v2(1)) return true;
 365   else if (v2(1) < v1(1)) return false;
 366   else if (v1(2) < v2(2)) return true;
 367   else if (v2(2) < v1(2)) return false;
 368   else return (v1(3) < v2(3));
 369 }
 370
 371 template<typename T>
 372 inline
 373 bool
 374 operator<=(const SGVec4<T>& v1, const SGVec4<T>& v2)
 375 {
 376   if (v1(0) < v2(0)) return true;
 377   else if (v2(0) < v1(0)) return false;
 378   else if (v1(1) < v2(1)) return true;
 379   else if (v2(1) < v1(1)) return false;
 380   else if (v1(2) < v2(2)) return true;
 381   else if (v2(2) < v1(2)) return false;
 382   else return (v1(3) <= v2(3));
 383 }
 384
 385 template<typename T>
 386 inline
 387 bool
 388 operator>(const SGVec4<T>& v1, const SGVec4<T>& v2)
 389 { return operator<(v2, v1); }
 390
 391 template<typename T>
 392 inline
 393 bool
 394 operator>=(const SGVec4<T>& v1, const SGVec4<T>& v2)
 395 { return operator<=(v2, v1); }
 396
 397 /// Return true if equal to the relative tolerance tol
 398 template<typename T>
 399 inline
 400 bool
 401 equivalent(const SGVec4<T>& v1, const SGVec4<T>& v2, T rtol, T atol)
 402 { return norm1(v1 - v2) < rtol*(norm1(v1) + norm1(v2)) + atol; }
 403
 404 /// Return true if equal to the relative tolerance tol
 405 template<typename T>
 406 inline
 407 bool
 408 equivalent(const SGVec4<T>& v1, const SGVec4<T>& v2, T rtol)
 409 { return norm1(v1 - v2) < rtol*(norm1(v1) + norm1(v2)); }
 410
 411 /// Return true if about equal to roundoff of the underlying type
 412 template<typename T>
 413 inline
 414 bool
 415 equivalent(const SGVec4<T>& v1, const SGVec4<T>& v2)
 416 {
 417   T tol = 100*SGLimits<T>::epsilon();
 418   return equivalent(v1, v2, tol, tol);
 419 }
 420
 421 /// The euclidean distance of the two vectors
 422 template<typename T>
 423 inline
 424 T
 425 dist(const SGVec4<T>& v1, const SGVec4<T>& v2)
 426 { return norm(v1 - v2); }
 427
 428 /// The squared euclidean distance of the two vectors
 429 template<typename T>
 430 inline
 431 T
 432 distSqr(const SGVec4<T>& v1, const SGVec4<T>& v2)
 433 { SGVec4<T> tmp = v1 - v2; return dot(tmp, tmp); }
 434
 435 #ifndef NDEBUG
 436 template<typename T>
 437 inline
 438 bool
 439 isNaN(const SGVec4<T>& v)
 440 {
 441   return SGMisc<T>::isNaN(v(0)) || SGMisc<T>::isNaN(v(1))
 442     || SGMisc<T>::isNaN(v(2)) || SGMisc<T>::isNaN(v(3));
 443 }
 444 #endif
 445
 446 /// Output to an ostream
 447 template<typename char_type, typename traits_type, typename T>
 448 inline
 449 std::basic_ostream<char_type, traits_type>&
 450 operator<<(std::basic_ostream<char_type, traits_type>& s, const SGVec4<T>& v)
 451 { return s << "[ " << v(0) << ", " << v(1) << ", " << v(2) << ", " << v(3) << " ]"; }
 452
 453 inline
 454 SGVec4f
 455 toVec4f(const SGVec4d& v)
 456 { return SGVec4f((float)v(0), (float)v(1), (float)v(2), (float)v(3)); }
 457
 458 inline
 459 SGVec4d
 460 toVec4d(const SGVec4f& v)
 461 { return SGVec4d(v(0), v(1), v(2), v(3)); }
 462
 463 #endif