Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / smoke / intern / tnt / tnt_math_utils.h
1 /** \file \ingroup smoke
2  */
3 #ifndef MATH_UTILS_H
4 #define MATH_UTILS_H
5
6 /* needed for fabs, sqrt() below */
7 #include <cmath>
8
9 namespace TNT
10 {
11 /**
12         @returns hypotenuse of real (non-complex) scalars a and b by 
13         avoiding underflow/overflow
14         using (a * sqrt( 1 + (b/a) * (b/a))), rather than
15         sqrt(a*a + b*b).
16 */
17 template <class Real>
18 Real hypot(const Real &a, const Real &b)
19 {
20         
21         if (a== 0)
22                 return fabs(b);
23         else
24         {
25                 Real c = b/a;
26                 return fabs(a) * sqrt(1 + c*c);
27         }
28 }
29 } /* TNT namespace */
30
31
32
33 #endif
34 /* MATH_UTILS_H */