Cleanup: comments (long lines) in blenlib
[blender.git] / source / blender / blenlib / BLI_math_base.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  *
19  * The Original Code is: some of this file.
20  *
21  * */
22
23 #ifndef __BLI_MATH_BASE_H__
24 #define __BLI_MATH_BASE_H__
25
26 /** \file
27  * \ingroup bli
28  */
29
30 #ifdef _MSC_VER
31 #  define _USE_MATH_DEFINES
32 #endif
33
34 #include <math.h>
35 #include "BLI_assert.h"
36 #include "BLI_math_inline.h"
37
38 #ifndef M_PI
39 #  define M_PI 3.14159265358979323846 /* pi */
40 #endif
41 #ifndef M_PI_2
42 #  define M_PI_2 1.57079632679489661923 /* pi/2 */
43 #endif
44 #ifndef M_PI_4
45 #  define M_PI_4 0.78539816339744830962 /* pi/4 */
46 #endif
47 #ifndef M_SQRT2
48 #  define M_SQRT2 1.41421356237309504880 /* sqrt(2) */
49 #endif
50 #ifndef M_SQRT1_2
51 #  define M_SQRT1_2 0.70710678118654752440 /* 1/sqrt(2) */
52 #endif
53 #ifndef M_SQRT3
54 #  define M_SQRT3 1.73205080756887729352 /* sqrt(3) */
55 #endif
56 #ifndef M_SQRT1_3
57 #  define M_SQRT1_3 0.57735026918962576450 /* 1/sqrt(3) */
58 #endif
59 #ifndef M_1_PI
60 #  define M_1_PI 0.318309886183790671538 /* 1/pi */
61 #endif
62 #ifndef M_E
63 #  define M_E 2.7182818284590452354 /* e */
64 #endif
65 #ifndef M_LOG2E
66 #  define M_LOG2E 1.4426950408889634074 /* log_2 e */
67 #endif
68 #ifndef M_LOG10E
69 #  define M_LOG10E 0.43429448190325182765 /* log_10 e */
70 #endif
71 #ifndef M_LN2
72 #  define M_LN2 0.69314718055994530942 /* log_e 2 */
73 #endif
74 #ifndef M_LN10
75 #  define M_LN10 2.30258509299404568402 /* log_e 10 */
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 #if BLI_MATH_DO_INLINE
87 #  include "intern/math_base_inline.c"
88 #endif
89
90 #ifdef BLI_MATH_GCC_WARN_PRAGMA
91 #  pragma GCC diagnostic push
92 #  pragma GCC diagnostic ignored "-Wredundant-decls"
93 #endif
94
95 /******************************* Float ******************************/
96
97 MINLINE float pow2f(float x);
98 MINLINE float pow3f(float x);
99 MINLINE float pow4f(float x);
100 MINLINE float pow7f(float x);
101
102 MINLINE float sqrt3f(float f);
103 MINLINE double sqrt3d(double d);
104
105 MINLINE float sqrtf_signed(float f);
106
107 MINLINE float saacosf(float f);
108 MINLINE float saasinf(float f);
109 MINLINE float sasqrtf(float f);
110 MINLINE float saacos(float fac);
111 MINLINE float saasin(float fac);
112 MINLINE float sasqrt(float fac);
113
114 MINLINE float interpf(float a, float b, float t);
115
116 MINLINE float min_ff(float a, float b);
117 MINLINE float max_ff(float a, float b);
118 MINLINE float min_fff(float a, float b, float c);
119 MINLINE float max_fff(float a, float b, float c);
120 MINLINE float min_ffff(float a, float b, float c, float d);
121 MINLINE float max_ffff(float a, float b, float c, float d);
122
123 MINLINE int min_ii(int a, int b);
124 MINLINE int max_ii(int a, int b);
125 MINLINE int min_iii(int a, int b, int c);
126 MINLINE int max_iii(int a, int b, int c);
127 MINLINE int min_iiii(int a, int b, int c, int d);
128 MINLINE int max_iiii(int a, int b, int c, int d);
129
130 MINLINE size_t min_zz(size_t a, size_t b);
131 MINLINE size_t max_zz(size_t a, size_t b);
132
133 MINLINE int clamp_i(int value, int min, int max);
134 MINLINE float clamp_f(float value, float min, float max);
135 MINLINE size_t clamp_z(size_t value, size_t min, size_t max);
136
137 MINLINE int compare_ff(float a, float b, const float max_diff);
138 MINLINE int compare_ff_relative(float a, float b, const float max_diff, const int max_ulps);
139
140 MINLINE float signf(float f);
141 MINLINE int signum_i_ex(float a, float eps);
142 MINLINE int signum_i(float a);
143
144 MINLINE float power_of_2(float f);
145
146 MINLINE int integer_digits_f(const float f);
147 MINLINE int integer_digits_d(const double d);
148 MINLINE int integer_digits_i(const int i);
149
150 /* these don't really fit anywhere but were being copied about a lot */
151 MINLINE int is_power_of_2_i(int n);
152 MINLINE int power_of_2_max_i(int n);
153 MINLINE int power_of_2_min_i(int n);
154
155 MINLINE unsigned int power_of_2_max_u(unsigned int x);
156 MINLINE unsigned int power_of_2_min_u(unsigned int x);
157
158 MINLINE int divide_round_i(int a, int b);
159 MINLINE int mod_i(int i, int n);
160
161 MINLINE signed char round_fl_to_char(float a);
162 MINLINE unsigned char round_fl_to_uchar(float a);
163 MINLINE short round_fl_to_short(float a);
164 MINLINE unsigned short round_fl_to_ushort(float a);
165 MINLINE int round_fl_to_int(float a);
166 MINLINE unsigned int round_fl_to_uint(float a);
167
168 MINLINE signed char round_db_to_char(double a);
169 MINLINE unsigned char round_db_to_uchar(double a);
170 MINLINE short round_db_to_short(double a);
171 MINLINE unsigned short round_db_to_ushort(double a);
172 MINLINE int round_db_to_int(double a);
173 MINLINE unsigned int round_db_to_uint(double a);
174
175 MINLINE signed char round_fl_to_char_clamp(float a);
176 MINLINE unsigned char round_fl_to_uchar_clamp(float a);
177 MINLINE short round_fl_to_short_clamp(float a);
178 MINLINE unsigned short round_fl_to_ushort_clamp(float a);
179 MINLINE int round_fl_to_int_clamp(float a);
180 MINLINE unsigned int round_fl_to_uint_clamp(float a);
181
182 MINLINE signed char round_db_to_char_clamp(double a);
183 MINLINE unsigned char round_db_to_uchar_clamp(double a);
184 MINLINE short round_db_to_short_clamp(double a);
185 MINLINE unsigned short round_db_to_ushort_clamp(double a);
186 MINLINE int round_db_to_int_clamp(double a);
187 MINLINE unsigned int round_db_to_uint_clamp(double a);
188
189 int pow_i(int base, int exp);
190 double double_round(double x, int ndigits);
191
192 #ifdef BLI_MATH_GCC_WARN_PRAGMA
193 #  pragma GCC diagnostic pop
194 #endif
195
196 /* asserts, some math functions expect normalized inputs
197  * check the vector is unit length, or zero length (which can't be helped in some cases).
198  */
199 #ifndef NDEBUG
200 /** \note 0.0001 is too small becaues normals may be converted from short's: see T34322. */
201 #  define BLI_ASSERT_UNIT_EPSILON 0.0002f
202 /**
203  * \note Checks are flipped so NAN doesn't assert.
204  * This is done because we're making sure the value was normalized and in the case we
205  * don't want NAN to be raising asserts since there is nothing to be done in that case.
206  */
207 #  define BLI_ASSERT_UNIT_V3(v) \
208     { \
209       const float _test_unit = len_squared_v3(v); \
210       BLI_assert(!(fabsf(_test_unit - 1.0f) >= BLI_ASSERT_UNIT_EPSILON) || \
211                  !(fabsf(_test_unit) >= BLI_ASSERT_UNIT_EPSILON)); \
212     } \
213     (void)0
214
215 #  define BLI_ASSERT_UNIT_V2(v) \
216     { \
217       const float _test_unit = len_squared_v2(v); \
218       BLI_assert(!(fabsf(_test_unit - 1.0f) >= BLI_ASSERT_UNIT_EPSILON) || \
219                  !(fabsf(_test_unit) >= BLI_ASSERT_UNIT_EPSILON)); \
220     } \
221     (void)0
222
223 #  define BLI_ASSERT_UNIT_QUAT(q) \
224     { \
225       const float _test_unit = dot_qtqt(q, q); \
226       BLI_assert(!(fabsf(_test_unit - 1.0f) >= BLI_ASSERT_UNIT_EPSILON * 10) || \
227                  !(fabsf(_test_unit) >= BLI_ASSERT_UNIT_EPSILON * 10)); \
228     } \
229     (void)0
230
231 #  define BLI_ASSERT_ZERO_M3(m) \
232     { \
233       BLI_assert(dot_vn_vn((const float *)m, (const float *)m, 9) != 0.0); \
234     } \
235     (void)0
236
237 #  define BLI_ASSERT_ZERO_M4(m) \
238     { \
239       BLI_assert(dot_vn_vn((const float *)m, (const float *)m, 16) != 0.0); \
240     } \
241     (void)0
242 #  define BLI_ASSERT_UNIT_M3(m) \
243     { \
244       BLI_ASSERT_UNIT_V3((m)[0]); \
245       BLI_ASSERT_UNIT_V3((m)[1]); \
246       BLI_ASSERT_UNIT_V3((m)[2]); \
247     } \
248     (void)0
249 #else
250 #  define BLI_ASSERT_UNIT_V2(v) (void)(v)
251 #  define BLI_ASSERT_UNIT_V3(v) (void)(v)
252 #  define BLI_ASSERT_UNIT_QUAT(v) (void)(v)
253 #  define BLI_ASSERT_ZERO_M3(m) (void)(m)
254 #  define BLI_ASSERT_ZERO_M4(m) (void)(m)
255 #  define BLI_ASSERT_UNIT_M3(m) (void)(m)
256 #endif
257
258 #endif /* __BLI_MATH_BASE_H__ */