Math utils: Add clamping functions
[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 #if BLI_MATH_DO_INLINE
89 #include "intern/math_base_inline.c"
90 #endif
91
92 #ifdef BLI_MATH_GCC_WARN_PRAGMA
93 #  pragma GCC diagnostic push
94 #  pragma GCC diagnostic ignored "-Wredundant-decls"
95 #endif
96
97 /******************************* Float ******************************/
98
99 MINLINE float pow2f(float x);
100 MINLINE float pow3f(float x);
101 MINLINE float pow4f(float x);
102 MINLINE float pow7f(float x);
103
104 MINLINE float sqrt3f(float f);
105 MINLINE double sqrt3d(double d);
106
107 MINLINE float sqrtf_signed(float f);
108
109 MINLINE float saacosf(float f);
110 MINLINE float saasinf(float f);
111 MINLINE float sasqrtf(float f);
112 MINLINE float saacos(float fac);
113 MINLINE float saasin(float fac);
114 MINLINE float sasqrt(float fac);
115
116 MINLINE float interpf(float a, float b, float t);
117
118 MINLINE float min_ff(float a, float b);
119 MINLINE float max_ff(float a, float b);
120 MINLINE float min_fff(float a, float b, float c);
121 MINLINE float max_fff(float a, float b, float c);
122 MINLINE float min_ffff(float a, float b, float c, float d);
123 MINLINE float max_ffff(float a, float b, float c, float d);
124
125 MINLINE int min_ii(int a, int b);
126 MINLINE int max_ii(int a, int b);
127 MINLINE int min_iii(int a, int b, int c);
128 MINLINE int max_iii(int a, int b, int c);
129 MINLINE int min_iiii(int a, int b, int c, int d);
130 MINLINE int max_iiii(int a, int b, int c, int d);
131
132 MINLINE size_t min_zz(size_t a, size_t b);
133 MINLINE size_t max_zz(size_t a, size_t b);
134
135 MINLINE int clamp_i(int value, int min, int max);
136 MINLINE float clamp_f(float value, float min, float max);
137 MINLINE size_t clamp_z(size_t value, size_t min, size_t max);
138
139 MINLINE int compare_ff(float a, float b, const float max_diff);
140 MINLINE int compare_ff_relative(float a, float b, const float max_diff, const int max_ulps);
141
142 MINLINE float signf(float f);
143 MINLINE int signum_i_ex(float a, float eps);
144 MINLINE int signum_i(float a);
145
146 MINLINE float power_of_2(float f);
147
148 MINLINE int integer_digits_f(const float f);
149 MINLINE int integer_digits_d(const double d);
150 MINLINE int integer_digits_i(const int i);
151
152 /* these don't really fit anywhere but were being copied about a lot */
153 MINLINE int is_power_of_2_i(int n);
154 MINLINE int power_of_2_max_i(int n);
155 MINLINE int power_of_2_min_i(int n);
156
157 MINLINE unsigned int power_of_2_max_u(unsigned int x);
158 MINLINE unsigned int power_of_2_min_u(unsigned int x);
159
160 MINLINE int divide_round_i(int a, int b);
161 MINLINE int mod_i(int i, int n);
162
163 MINLINE signed char    round_fl_to_char(float a);
164 MINLINE unsigned char  round_fl_to_uchar(float a);
165 MINLINE short          round_fl_to_short(float a);
166 MINLINE unsigned short round_fl_to_ushort(float a);
167 MINLINE int            round_fl_to_int(float a);
168 MINLINE unsigned int   round_fl_to_uint(float a);
169
170 MINLINE signed char    round_db_to_char(double a);
171 MINLINE unsigned char  round_db_to_uchar(double a);
172 MINLINE short          round_db_to_short(double a);
173 MINLINE unsigned short round_db_to_ushort(double a);
174 MINLINE int            round_db_to_int(double a);
175 MINLINE unsigned int   round_db_to_uint(double a);
176
177 MINLINE signed char    round_fl_to_char_clamp(float a);
178 MINLINE unsigned char  round_fl_to_uchar_clamp(float a);
179 MINLINE short          round_fl_to_short_clamp(float a);
180 MINLINE unsigned short round_fl_to_ushort_clamp(float a);
181 MINLINE int            round_fl_to_int_clamp(float a);
182 MINLINE unsigned int   round_fl_to_uint_clamp(float a);
183
184 MINLINE signed char    round_db_to_char_clamp(double a);
185 MINLINE unsigned char  round_db_to_uchar_clamp(double a);
186 MINLINE short          round_db_to_short_clamp(double a);
187 MINLINE unsigned short round_db_to_ushort_clamp(double a);
188 MINLINE int            round_db_to_int_clamp(double a);
189 MINLINE unsigned int   round_db_to_uint_clamp(double a);
190
191 int pow_i(int base, int exp);
192 double double_round(double x, int ndigits);
193
194 #ifdef BLI_MATH_GCC_WARN_PRAGMA
195 #  pragma GCC diagnostic pop
196 #endif
197
198 /* asserts, some math functions expect normalized inputs
199  * check the vector is unit length, or zero length (which can't be helped in some cases).
200  */
201 #ifndef NDEBUG
202 /* note: 0.0001 is too small becaues normals may be converted from short's: see [#34322] */
203 #  define BLI_ASSERT_UNIT_EPSILON 0.0002f
204 #  define BLI_ASSERT_UNIT_V3(v)  {                                            \
205         const float _test_unit = len_squared_v3(v);                               \
206         BLI_assert((fabsf(_test_unit - 1.0f) < BLI_ASSERT_UNIT_EPSILON) ||        \
207                    (fabsf(_test_unit)        < BLI_ASSERT_UNIT_EPSILON));         \
208 } (void)0
209
210 #  define BLI_ASSERT_UNIT_V2(v)  {                                            \
211         const float _test_unit = len_squared_v2(v);                               \
212         BLI_assert((fabsf(_test_unit - 1.0f) < BLI_ASSERT_UNIT_EPSILON) ||        \
213                    (fabsf(_test_unit)        < BLI_ASSERT_UNIT_EPSILON));         \
214 } (void)0
215
216 #  define BLI_ASSERT_UNIT_QUAT(q)  {                                          \
217         const float _test_unit = dot_qtqt(q, q);                                  \
218         BLI_assert((fabsf(_test_unit - 1.0f) < BLI_ASSERT_UNIT_EPSILON * 10) ||   \
219                    (fabsf(_test_unit)        < BLI_ASSERT_UNIT_EPSILON * 10));    \
220 } (void)0
221
222 #  define BLI_ASSERT_ZERO_M3(m)  {                                            \
223         BLI_assert(dot_vn_vn((const float *)m, (const float *)m, 9) != 0.0);      \
224 } (void)0
225
226 #  define BLI_ASSERT_ZERO_M4(m)  {                                            \
227         BLI_assert(dot_vn_vn((const float *)m, (const float *)m, 16) != 0.0);     \
228 } (void)0
229 #  define BLI_ASSERT_UNIT_M3(m)  {                                            \
230         BLI_ASSERT_UNIT_V3((m)[0]);                                               \
231         BLI_ASSERT_UNIT_V3((m)[1]);                                               \
232         BLI_ASSERT_UNIT_V3((m)[2]);                                               \
233 } (void)0
234 #else
235 #  define BLI_ASSERT_UNIT_V2(v) (void)(v)
236 #  define BLI_ASSERT_UNIT_V3(v) (void)(v)
237 #  define BLI_ASSERT_UNIT_QUAT(v) (void)(v)
238 #  define BLI_ASSERT_ZERO_M3(m) (void)(m)
239 #  define BLI_ASSERT_ZERO_M4(m) (void)(m)
240 #  define BLI_ASSERT_UNIT_M3(m) (void)(m)
241 #endif
242
243 #endif /* __BLI_MATH_BASE_H__ */