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