simgear/math/fastmath.hxx

   1 /*
   2  * \file fastmath.hxx
   3  * fast mathematics routines.
   4  *
   5  * Refferences:
   6  *
   7  * A Fast, Compact Approximation of the Exponential Function
   8  * Nicol N. Schraudolph
   9  * IDSIA, Lugano, Switzerland
  10  * http://www.inf.ethz.ch/~schraudo/pubs/exp.pdf
  11  *
  12  * Fast log() Function, by Laurent de Soras:
  13  * http://www.flipcode.com/cgi-bin/msg.cgi?showThread=Tip-Fastlogfunction&forum=totd&id=-1
  14  *
  15  */
  16
  17 /*
  18  * $Id$
  19  */
  20
  21 #ifndef _SG_FMATH_HXX
  22 #define _SG_FMATH_HXX 1
  23
  24 #ifndef __cplusplus
  25 # error This library requires C++
  26 #endif
  27
  28 #include <math.h>
  29
  30
  31 double fast_exp(double val);
  32 double fast_exp2(const double val);
  33
  34 float fast_pow(const float val1, const float val2);
  35 float fast_log2(const float cal);
  36 float fast_root(const float f, const int n);
  37
  38 float _fast_pow2(const float cal);
  39 float _fast_log2(const float val);
  40
  41 float fast_sin(const float val);
  42 float fast_cos(const float val);
  43 float fast_tan(const float val);
  44 float fast_asin(const float val);
  45 float fast_acos(const float val);
  46 float fast_atan(const float val);
  47
  48 void fast_BSL(float &x, register unsigned long shiftAmount);
  49 void fast_BSR(float &x, register unsigned long shiftAmount);
  50
  51
  52 inline float fast_log2 (float val)
  53 {
  54     int * const  exp_ptr = reinterpret_cast <int *> (&val);
  55     int          x = *exp_ptr;
  56     const int    log_2 = ((x >> 23) & 255) - 128;
  57     x &= ~(255 << 23);
  58     x += 127 << 23;
  59     *exp_ptr = x;
  60
  61     val = ((-1.0f/3) * val + 2) * val - 2.0f/3;   // (1)
  62
  63     return (val + log_2);
  64 }
  65
  66
  67 /**
  68  * This function is about 3 times faster than the system log() function
  69  * and has an error of about 0.01%
  70  */
  71 inline float fast_log (const float &val)
  72 {
  73    return (fast_log2 (val) * 0.69314718f);
  74 }
  75
  76 inline float fast_log10 (const float &val)
  77 {
  78    return (fast_log2(val) / 3.321928095f);
  79 }
  80
  81
  82 /**
  83  * This function is about twice as fast as the system pow(x,y) function
  84  */
  85 inline float fast_pow(const float val1, const float val2)
  86 {
  87    return _fast_pow2(val2 * _fast_log2(val1));
  88 }
  89
  90
  91 /*
  92  * Haven't seen this elsewhere, probably because it is too obvious?
  93  * Anyway, these functions are intended for 32-bit floating point numbers
  94  * only and should work a bit faster than the regular ones.
  95  */
  96 inline float fast_abs(float f)
  97 {
  98     int i=((*(int*)&f)&0x7fffffff);
  99     return (*(float*)&i);
 100 }
 101
 102 inline float fast_neg(float f)
 103 {
 104     int i=((*(int*)&f)^0x80000000);
 105     return (*(float*)&i);
 106 }
 107
 108 inline int fast_sgn(float f)
 109 {
 110     return 1+(((*(int*)&f)>>31)<<1);
 111 }
 112
 113 #endif // !_SG_FMATH_HXX
 114