C99/C++11: replace deprecated finite() by isfinite().
[blender.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 #ifndef M_PI
41 #define M_PI        3.14159265358979323846  /* pi */
42 #endif
43 #ifndef M_PI_2
44 #define M_PI_2      1.57079632679489661923  /* pi/2 */
45 #endif
46 #ifndef M_PI_4
47 #define M_PI_4      0.78539816339744830962  /* pi/4 */
48 #endif
49 #ifndef M_SQRT2
50 #define M_SQRT2     1.41421356237309504880  /* sqrt(2) */
51 #endif
52 #ifndef M_SQRT1_2
53 #define M_SQRT1_2   0.70710678118654752440  /* 1/sqrt(2) */
54 #endif
55 #ifndef M_SQRT3
56 #define M_SQRT3     1.73205080756887729352  /* sqrt(3) */
57 #endif
58 #ifndef M_SQRT1_3
59 #define M_SQRT1_3   0.57735026918962576450  /* 1/sqrt(3) */
60 #endif
61 #ifndef M_1_PI
62 #define M_1_PI      0.318309886183790671538  /* 1/pi */
63 #endif
64 #ifndef M_E
65 #define M_E         2.7182818284590452354  /* e */
66 #endif
67 #ifndef M_LOG2E
68 #define M_LOG2E     1.4426950408889634074  /* log_2 e */
69 #endif
70 #ifndef M_LOG10E
71 #define M_LOG10E    0.43429448190325182765  /* log_10 e */
72 #endif
73 #ifndef M_LN2
74 #define M_LN2       0.69314718055994530942  /* log_e 2 */
75 #endif
76 #ifndef M_LN10
77 #define M_LN10      2.30258509299404568402  /* log_e 10 */
78 #endif
79
80 #if defined(__GNUC__)
81 #  define NAN_FLT __builtin_nanf("")
82 #else
83 /* evil quiet NaN definition */
84 static const int NAN_INT = 0x7FC00000;
85 #  define NAN_FLT  (*((float *)(&NAN_INT)))
86 #endif
87
88 /* do not redefine functions from C99, POSIX.1-2001 or MSVC12 (partial C99) */
89 #if !(defined(_ISOC99_SOURCE) || (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 200112L) || defined(_MSC_VER))
90
91 #ifndef sqrtf
92 #define sqrtf(a) ((float)sqrt(a))
93 #endif
94 #ifndef powf
95 #define powf(a, b) ((float)pow(a, b))
96 #endif
97 #ifndef cosf
98 #define cosf(a) ((float)cos(a))
99 #endif
100 #ifndef sinf
101 #define sinf(a) ((float)sin(a))
102 #endif
103 #ifndef acosf
104 #define acosf(a) ((float)acos(a))
105 #endif
106 #ifndef asinf
107 #define asinf(a) ((float)asin(a))
108 #endif
109 #ifndef atan2f
110 #define atan2f(a, b) ((float)atan2(a, b))
111 #endif
112 #ifndef tanf
113 #define tanf(a) ((float)tan(a))
114 #endif
115 #ifndef atanf
116 #define atanf(a) ((float)atan(a))
117 #endif
118 #ifndef floorf
119 #define floorf(a) ((float)floor(a))
120 #endif
121 #ifndef ceilf
122 #define ceilf(a) ((float)ceil(a))
123 #endif
124 #ifndef fabsf
125 #define fabsf(a) ((float)fabs(a))
126 #endif
127 #ifndef logf
128 #define logf(a) ((float)log(a))
129 #endif
130 #ifndef expf
131 #define expf(a) ((float)exp(a))
132 #endif
133 #ifndef fmodf
134 #define fmodf(a, b) ((float)fmod(a, b))
135 #endif
136 #ifndef hypotf
137 #define hypotf(a, b) ((float)hypot(a, b))
138 #endif
139 #ifndef copysignf
140 #define copysignf(a, b) ((float)copysign(a, b))
141 #endif
142
143 #endif  /* C99, POSIX.1-2001 or MSVC12 (partial C99) */
144
145 #if BLI_MATH_DO_INLINE
146 #include "intern/math_base_inline.c"
147 #endif
148
149 #ifdef BLI_MATH_GCC_WARN_PRAGMA
150 #  pragma GCC diagnostic push
151 #  pragma GCC diagnostic ignored "-Wredundant-decls"
152 #endif
153
154 /******************************* Float ******************************/
155
156 MINLINE float pow2f(float x);
157 MINLINE float pow3f(float x);
158 MINLINE float pow4f(float x);
159 MINLINE float pow7f(float x);
160
161 MINLINE float sqrt3f(float f);
162 MINLINE double sqrt3d(double d);
163
164 MINLINE float sqrtf_signed(float f);
165
166 MINLINE float saacosf(float f);
167 MINLINE float saasinf(float f);
168 MINLINE float sasqrtf(float f);
169 MINLINE float saacos(float fac);
170 MINLINE float saasin(float fac);
171 MINLINE float sasqrt(float fac);
172
173 MINLINE float interpf(float a, float b, float t);
174
175 MINLINE float min_ff(float a, float b);
176 MINLINE float max_ff(float a, float b);
177 MINLINE float min_fff(float a, float b, float c);
178 MINLINE float max_fff(float a, float b, float c);
179 MINLINE float min_ffff(float a, float b, float c, float d);
180 MINLINE float max_ffff(float a, float b, float c, float d);
181
182 MINLINE int min_ii(int a, int b);
183 MINLINE int max_ii(int a, int b);
184 MINLINE int min_iii(int a, int b, int c);
185 MINLINE int max_iii(int a, int b, int c);
186 MINLINE int min_iiii(int a, int b, int c, int d);
187 MINLINE int max_iiii(int a, int b, int c, int d);
188
189 MINLINE int compare_ff(float a, float b, const float max_diff);
190 MINLINE int compare_ff_relative(float a, float b, const float max_diff, const int max_ulps);
191
192 MINLINE float signf(float f);
193 MINLINE int signum_i_ex(float a, float eps);
194 MINLINE int signum_i(float a);
195
196 MINLINE float power_of_2(float f);
197
198 /* these don't really fit anywhere but were being copied about a lot */
199 MINLINE int is_power_of_2_i(int n);
200 MINLINE int power_of_2_max_i(int n);
201 MINLINE int power_of_2_min_i(int n);
202
203 MINLINE unsigned int power_of_2_max_u(unsigned int x);
204 MINLINE unsigned int power_of_2_min_u(unsigned int x);
205
206 MINLINE int iroundf(float a);
207 MINLINE int divide_round_i(int a, int b);
208 MINLINE int mod_i(int i, int n);
209
210 int pow_i(int base, int exp);
211 double double_round(double x, int ndigits);
212
213 #ifdef BLI_MATH_GCC_WARN_PRAGMA
214 #  pragma GCC diagnostic pop
215 #endif
216
217 /* asserts, some math functions expect normalized inputs
218  * check the vector is unit length, or zero length (which can't be helped in some cases).
219  */
220 #ifndef NDEBUG
221 /* note: 0.0001 is too small becaues normals may be converted from short's: see [#34322] */
222 #  define BLI_ASSERT_UNIT_EPSILON 0.0002f
223 #  define BLI_ASSERT_UNIT_V3(v)  {                                            \
224         const float _test_unit = len_squared_v3(v);                               \
225         BLI_assert((fabsf(_test_unit - 1.0f) < BLI_ASSERT_UNIT_EPSILON) ||        \
226                    (fabsf(_test_unit)        < BLI_ASSERT_UNIT_EPSILON));         \
227 } (void)0
228
229 #  define BLI_ASSERT_UNIT_V2(v)  {                                            \
230         const float _test_unit = len_squared_v2(v);                               \
231         BLI_assert((fabsf(_test_unit - 1.0f) < BLI_ASSERT_UNIT_EPSILON) ||        \
232                    (fabsf(_test_unit)        < BLI_ASSERT_UNIT_EPSILON));         \
233 } (void)0
234
235 #  define BLI_ASSERT_UNIT_QUAT(q)  {                                          \
236         const float _test_unit = dot_qtqt(q, q);                                  \
237         BLI_assert((fabsf(_test_unit - 1.0f) < BLI_ASSERT_UNIT_EPSILON * 10) ||   \
238                    (fabsf(_test_unit)        < BLI_ASSERT_UNIT_EPSILON * 10));    \
239 } (void)0
240
241 #  define BLI_ASSERT_ZERO_M3(m)  {                                            \
242         BLI_assert(dot_vn_vn((const float *)m, (const float *)m, 9) != 0.0);      \
243 } (void)0
244
245 #  define BLI_ASSERT_ZERO_M4(m)  {                                            \
246         BLI_assert(dot_vn_vn((const float *)m, (const float *)m, 16) != 0.0);     \
247 } (void)0
248 #  define BLI_ASSERT_UNIT_M3(m)  {                                            \
249         BLI_ASSERT_UNIT_V3((m)[0]);                                               \
250         BLI_ASSERT_UNIT_V3((m)[1]);                                               \
251         BLI_ASSERT_UNIT_V3((m)[2]);                                               \
252 } (void)0
253 #else
254 #  define BLI_ASSERT_UNIT_V2(v) (void)(v)
255 #  define BLI_ASSERT_UNIT_V3(v) (void)(v)
256 #  define BLI_ASSERT_UNIT_QUAT(v) (void)(v)
257 #  define BLI_ASSERT_ZERO_M3(m) (void)(m)
258 #  define BLI_ASSERT_ZERO_M4(m) (void)(m)
259 #  define BLI_ASSERT_UNIT_M3(m) (void)(m)
260 #endif
261
262 #endif /* __BLI_MATH_BASE_H__ */