Avoid calling powf with integer exponent in more places
[blender-staging.git] / source / blender / blenlib / BLI_math_base.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: some of this file.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  * */
25
26 #ifndef __BLI_MATH_BASE_H__
27 #define __BLI_MATH_BASE_H__
28
29 /** \file BLI_math_base.h
30  *  \ingroup bli
31  */
32
33 #ifdef _MSC_VER
34 #  define _USE_MATH_DEFINES
35 #endif
36
37 #include <math.h>
38 #include "BLI_math_inline.h"
39
40 #ifdef __sun__
41 #include <ieeefp.h> /* for finite() */
42 #endif
43
44 #ifndef M_PI
45 #define M_PI        3.14159265358979323846
46 #endif
47 #ifndef M_PI_2
48 #define M_PI_2      1.57079632679489661923
49 #endif
50 #ifndef M_SQRT2
51 #define M_SQRT2     1.41421356237309504880
52 #endif
53 #ifndef M_SQRT1_2
54 #define M_SQRT1_2   0.70710678118654752440
55 #endif
56 #ifndef M_SQRT3
57 #define M_SQRT3   1.7320508075688772
58 #endif
59 #ifndef M_1_PI
60 #define M_1_PI      0.318309886183790671538
61 #endif
62 #ifndef M_E
63 #define M_E             2.7182818284590452354
64 #endif
65 #ifndef M_LOG2E
66 #define M_LOG2E         1.4426950408889634074
67 #endif
68 #ifndef M_LOG10E
69 #define M_LOG10E        0.43429448190325182765
70 #endif
71 #ifndef M_LN2
72 #define M_LN2           0.69314718055994530942
73 #endif
74 #ifndef M_LN10
75 #define M_LN10          2.30258509299404568402
76 #endif
77
78 #if defined(__GNUC__)
79 #  define NAN_FLT __builtin_nanf("")
80 #else
81 /* evil quiet NaN definition */
82 static const int NAN_INT = 0x7FC00000;
83 #  define NAN_FLT  (*((float *)(&NAN_INT)))
84 #endif
85
86 /* do not redefine functions from C99, POSIX.1-2001 or MSVC12 (partial C99) */
87 #if !(defined(_ISOC99_SOURCE) || (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 200112L) || (defined(_MSC_VER) && _MSC_VER >= 1800))
88
89 #ifndef sqrtf
90 #define sqrtf(a) ((float)sqrt(a))
91 #endif
92 #ifndef powf
93 #define powf(a, b) ((float)pow(a, b))
94 #endif
95 #ifndef cosf
96 #define cosf(a) ((float)cos(a))
97 #endif
98 #ifndef sinf
99 #define sinf(a) ((float)sin(a))
100 #endif
101 #ifndef acosf
102 #define acosf(a) ((float)acos(a))
103 #endif
104 #ifndef asinf
105 #define asinf(a) ((float)asin(a))
106 #endif
107 #ifndef atan2f
108 #define atan2f(a, b) ((float)atan2(a, b))
109 #endif
110 #ifndef tanf
111 #define tanf(a) ((float)tan(a))
112 #endif
113 #ifndef atanf
114 #define atanf(a) ((float)atan(a))
115 #endif
116 #ifndef floorf
117 #define floorf(a) ((float)floor(a))
118 #endif
119 #ifndef ceilf
120 #define ceilf(a) ((float)ceil(a))
121 #endif
122 #ifndef fabsf
123 #define fabsf(a) ((float)fabs(a))
124 #endif
125 #ifndef logf
126 #define logf(a) ((float)log(a))
127 #endif
128 #ifndef expf
129 #define expf(a) ((float)exp(a))
130 #endif
131 #ifndef fmodf
132 #define fmodf(a, b) ((float)fmod(a, b))
133 #endif
134 #ifndef hypotf
135 #define hypotf(a, b) ((float)hypot(a, b))
136 #endif
137 #ifndef copysignf
138 #define copysignf(a, b) ((float)copysign(a, b))
139 #endif
140
141 #endif  /* C99, POSIX.1-2001 or MSVC12 (partial C99) */
142
143 #ifdef WIN32
144 #  if defined(_MSC_VER)
145 #    define finite(n) _finite(n)
146 #  endif
147 #endif
148
149 #if BLI_MATH_DO_INLINE
150 #include "intern/math_base_inline.c"
151 #endif
152
153 #ifdef BLI_MATH_GCC_WARN_PRAGMA
154 #  pragma GCC diagnostic push
155 #  pragma GCC diagnostic ignored "-Wredundant-decls"
156 #endif
157
158 /******************************* Float ******************************/
159
160 MINLINE float pow2f(float x);
161 MINLINE float pow3f(float x);
162 MINLINE float pow4f(float x);
163 MINLINE float pow7f(float x);
164
165 MINLINE float sqrt3f(float f);
166 MINLINE double sqrt3d(double d);
167
168 MINLINE float sqrtf_signed(float f);
169
170 MINLINE float saacosf(float f);
171 MINLINE float saasinf(float f);
172 MINLINE float sasqrtf(float f);
173 MINLINE float saacos(float fac);
174 MINLINE float saasin(float fac);
175 MINLINE float sasqrt(float fac);
176
177 MINLINE float interpf(float a, float b, float t);
178
179 MINLINE float min_ff(float a, float b);
180 MINLINE float max_ff(float a, float b);
181 MINLINE float min_fff(float a, float b, float c);
182 MINLINE float max_fff(float a, float b, float c);
183 MINLINE float min_ffff(float a, float b, float c, float d);
184 MINLINE float max_ffff(float a, float b, float c, float d);
185
186 MINLINE int min_ii(int a, int b);
187 MINLINE int max_ii(int a, int b);
188 MINLINE int min_iii(int a, int b, int c);
189 MINLINE int max_iii(int a, int b, int c);
190 MINLINE int min_iiii(int a, int b, int c, int d);
191 MINLINE int max_iiii(int a, int b, int c, int d);
192
193 MINLINE float signf(float f);
194
195 MINLINE float power_of_2(float f);
196
197 /* these don't really fit anywhere but were being copied about a lot */
198 MINLINE int is_power_of_2_i(int n);
199 MINLINE int power_of_2_max_i(int n);
200 MINLINE int power_of_2_min_i(int n);
201
202 MINLINE unsigned int power_of_2_max_u(unsigned int x);
203 MINLINE unsigned int power_of_2_min_u(unsigned int x);
204
205 MINLINE int iroundf(float a);
206 MINLINE int divide_round_i(int a, int b);
207 MINLINE int mod_i(int i, int n);
208
209 MINLINE unsigned int highest_order_bit_i(unsigned int n);
210 MINLINE unsigned short highest_order_bit_s(unsigned short n);
211
212 double double_round(double x, int ndigits);
213
214 #ifdef BLI_MATH_GCC_WARN_PRAGMA
215 #  pragma GCC diagnostic pop
216 #endif
217
218 /* asserts, some math functions expect normalized inputs
219  * check the vector is unit length, or zero length (which can't be helped in some cases).
220  */
221 #ifndef NDEBUG
222 /* note: 0.0001 is too small becaues normals may be converted from short's: see [#34322] */
223 #  define BLI_ASSERT_UNIT_EPSILON 0.0002f
224 #  define BLI_ASSERT_UNIT_V3(v)  {                                            \
225         const float _test_unit = len_squared_v3(v);                               \
226         BLI_assert((fabsf(_test_unit - 1.0f) < BLI_ASSERT_UNIT_EPSILON) ||        \
227                    (fabsf(_test_unit)        < BLI_ASSERT_UNIT_EPSILON));         \
228 } (void)0
229
230 #  define BLI_ASSERT_UNIT_V2(v)  {                                            \
231         const float _test_unit = len_squared_v2(v);                               \
232         BLI_assert((fabsf(_test_unit - 1.0f) < BLI_ASSERT_UNIT_EPSILON) ||        \
233                    (fabsf(_test_unit)        < BLI_ASSERT_UNIT_EPSILON));         \
234 } (void)0
235
236 #  define BLI_ASSERT_UNIT_QUAT(q)  {                                          \
237         const float _test_unit = dot_qtqt(q, q);                                  \
238         BLI_assert((fabsf(_test_unit - 1.0f) < BLI_ASSERT_UNIT_EPSILON * 10) ||   \
239                    (fabsf(_test_unit)        < BLI_ASSERT_UNIT_EPSILON * 10));    \
240 } (void)0
241
242 #  define BLI_ASSERT_ZERO_M3(m)  {                                            \
243         BLI_assert(dot_vn_vn((const float *)m, (const float *)m, 9) != 0.0);      \
244 } (void)0
245
246 #  define BLI_ASSERT_ZERO_M4(m)  {                                            \
247         BLI_assert(dot_vn_vn((const float *)m, (const float *)m, 16) != 0.0);     \
248 } (void)0
249 #  define BLI_ASSERT_UNIT_M3(m)  {                                            \
250         BLI_ASSERT_UNIT_V3((m)[0]);                                               \
251         BLI_ASSERT_UNIT_V3((m)[1]);                                               \
252         BLI_ASSERT_UNIT_V3((m)[2]);                                               \
253 } (void)0
254 #else
255 #  define BLI_ASSERT_UNIT_V2(v) (void)(v)
256 #  define BLI_ASSERT_UNIT_V3(v) (void)(v)
257 #  define BLI_ASSERT_UNIT_QUAT(v) (void)(v)
258 #  define BLI_ASSERT_ZERO_M3(m) (void)(m)
259 #  define BLI_ASSERT_ZERO_M4(m) (void)(m)
260 #  define BLI_ASSERT_UNIT_M3(m) (void)(m)
261 #endif
262
263 #endif /* __BLI_MATH_BASE_H__ */