simgear/math/SGMisc.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 SGMisc_H
  19 #define SGMisc_H
  20
  21 template<typename T>
  22 class SGMisc {
  23 public:
  24   static T pi() { return T(3.1415926535897932384626433832795029L); }
  25   static T twopi() { return 2*T(3.1415926535897932384626433832795029L); }
  26
  27   static T min(const T& a, const T& b)
  28   { return a < b ? a : b; }
  29   static T min(const T& a, const T& b, const T& c)
  30   { return min(min(a, b), c); }
  31   static T min(const T& a, const T& b, const T& c, const T& d)
  32   { return min(min(min(a, b), c), d); }
  33   static T max(const T& a, const T& b)
  34   { return a > b ? a : b; }
  35   static T max(const T& a, const T& b, const T& c)
  36   { return max(max(a, b), c); }
  37   static T max(const T& a, const T& b, const T& c, const T& d)
  38   { return max(max(max(a, b), c), d); }
  39
  40   // clip the value of a to be in the range between and including _min and _max
  41   static T clip(const T& a, const T& _min, const T& _max)
  42   { return max(_min, min(_max, a)); }
  43
  44   static int sign(const T& a)
  45   {
  46     if (a < -SGLimits<T>::min())
  47       return -1;
  48     else if (SGLimits<T>::min() < a)
  49       return 1;
  50     else
  51       return 0;
  52   }
  53
  54   static T rad2deg(const T& val)
  55   { return val*180/pi(); }
  56   static T deg2rad(const T& val)
  57   { return val*pi()/180; }
  58
  59   // normalize the value to be in a range between [min, max[
  60   static T
  61   normalizePeriodic(const T& min, const T& max, const T& value)
  62   {
  63     T range = max - min;
  64     if (range < SGLimits<T>::min())
  65       return min;
  66     T normalized = value - range*floor((value - min)/range);
  67     // two security checks that can only happen due to roundoff
  68     if (value <= min)
  69       return min;
  70     if (max <= normalized)
  71       return min;
  72     return normalized;
  73   }
  74
  75   // normalize the angle to be in a range between [-pi, pi[
  76   static T
  77   normalizeAngle(const T& angle)
  78   { return normalizePeriodic(-pi(), pi(), angle); }
  79
  80   // normalize the angle to be in a range between [0, 2pi[
  81   static T
  82   normalizeAngle2(const T& angle)
  83   { return normalizePeriodic(0, twopi(), angle); }
  84
  85   static T round(const T& v)
  86   { return floor(v + T(0.5)); }
  87   static int roundToInt(const T& v)
  88   { return int(round(v)); }
  89
  90 #ifndef NDEBUG
  91   /// Returns true if v is a NaN value
  92   /// Use with care: allways code that you do not need to use that!
  93   static bool isNaN(const T& v)
  94   {
  95 #ifdef HAVE_ISNAN
  96     return isnan(v);
  97 #elif defined HAVE_STD_ISNAN
  98     return std::isnan(v);
  99 #else
 100     // Use that every compare involving a NaN returns false
 101     // But be careful, some usual compiler switches like for example
 102     // -fast-math from gcc might optimize that expression to v != v which
 103     // behaves exactly like the opposite ...
 104     return !(v == v);
 105 #endif
 106   }
 107 #endif
 108 };
 109
 110 #endif