Math Lib: handling bits handling into own file
[blender.git] / source / blender / blenlib / intern / math_base_inline.c
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 /** \file blender/blenlib/intern/math_base_inline.c
27  *  \ingroup bli
28  */
29
30 #ifndef __MATH_BASE_INLINE_C__
31 #define __MATH_BASE_INLINE_C__
32
33 #include <float.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37
38 #include "BLI_math_base.h"
39
40 /* copied from BLI_utildefines.h */
41 #ifdef __GNUC__
42 #  define UNLIKELY(x)     __builtin_expect(!!(x), 0)
43 #else
44 #  define UNLIKELY(x)     (x)
45 #endif
46
47 /* powf is really slow for raising to integer powers. */
48 MINLINE float pow2f(float x)
49 {
50         return x * x;
51 }
52 MINLINE float pow3f(float x)
53 {
54         return pow2f(x) * x;
55 }
56 MINLINE float pow4f(float x)
57 {
58         return pow2f(pow2f(x));
59 }
60 MINLINE float pow7f(float x)
61 {
62         return pow2f(pow3f(x)) * x;
63 }
64
65 MINLINE float sqrt3f(float f)
66 {
67         if      (UNLIKELY(f == 0.0f)) return 0.0f;
68         else if (UNLIKELY(f <  0.0f)) return -(float)(exp(log(-f) / 3.0));
69         else                          return  (float)(exp(log( f) / 3.0));
70 }
71
72 MINLINE double sqrt3d(double d)
73 {
74         if      (UNLIKELY(d == 0.0)) return 0.0;
75         else if (UNLIKELY(d <  0.0)) return -exp(log(-d) / 3.0);
76         else                         return  exp(log( d) / 3.0);
77 }
78
79 MINLINE float sqrtf_signed(float f)
80 {
81         return (f >= 0.0f) ? sqrtf(f) : -sqrtf(-f);
82 }
83
84 MINLINE float saacos(float fac)
85 {
86         if      (UNLIKELY(fac <= -1.0f)) return (float)M_PI;
87         else if (UNLIKELY(fac >=  1.0f)) return 0.0f;
88         else                             return acosf(fac);
89 }
90
91 MINLINE float saasin(float fac)
92 {
93         if      (UNLIKELY(fac <= -1.0f)) return (float)-M_PI / 2.0f;
94         else if (UNLIKELY(fac >=  1.0f)) return (float) M_PI / 2.0f;
95         else                             return asinf(fac);
96 }
97
98 MINLINE float sasqrt(float fac)
99 {
100         if (UNLIKELY(fac <= 0.0f)) return 0.0f;
101         else                       return sqrtf(fac);
102 }
103
104 MINLINE float saacosf(float fac)
105 {
106         if      (UNLIKELY(fac <= -1.0f)) return (float)M_PI;
107         else if (UNLIKELY(fac >=  1.0f)) return 0.0f;
108         else                             return acosf(fac);
109 }
110
111 MINLINE float saasinf(float fac)
112 {
113         if      (UNLIKELY(fac <= -1.0f)) return (float)-M_PI / 2.0f;
114         else if (UNLIKELY(fac >=  1.0f)) return (float) M_PI / 2.0f;
115         else                             return asinf(fac);
116 }
117
118 MINLINE float sasqrtf(float fac)
119 {
120         if (UNLIKELY(fac <= 0.0f)) return 0.0f;
121         else                       return sqrtf(fac);
122 }
123
124 MINLINE float interpf(float target, float origin, float fac)
125 {
126         return (fac * target) + (1.0f - fac) * origin;
127 }
128
129 /* used for zoom values*/
130 MINLINE float power_of_2(float val)
131 {
132         return (float)pow(2.0, ceil(log((double)val) / M_LN2));
133 }
134
135 MINLINE int is_power_of_2_i(int n)
136 {
137         return (n & (n - 1)) == 0;
138 }
139
140 MINLINE int power_of_2_max_i(int n)
141 {
142         if (is_power_of_2_i(n))
143                 return n;
144
145         do {
146                 n = n & (n - 1);
147         } while (!is_power_of_2_i(n));
148
149         return n * 2;
150 }
151
152 MINLINE int power_of_2_min_i(int n)
153 {
154         while (!is_power_of_2_i(n))
155                 n = n & (n - 1);
156
157         return n;
158 }
159
160 MINLINE unsigned int power_of_2_max_u(unsigned int x)
161 {
162         x -= 1;
163         x |= (x >>  1);
164         x |= (x >>  2);
165         x |= (x >>  4);
166         x |= (x >>  8);
167         x |= (x >> 16);
168         return x + 1;
169 }
170
171 MINLINE unsigned power_of_2_min_u(unsigned x)
172 {
173         x |= (x >>  1);
174         x |= (x >>  2);
175         x |= (x >>  4);
176         x |= (x >>  8);
177         x |= (x >> 16);
178         return x - (x >> 1);
179 }
180
181 MINLINE int iroundf(float a)
182 {
183         return (int)floorf(a + 0.5f);
184 }
185
186 /* integer division that rounds 0.5 up, particularly useful for color blending
187  * with integers, to avoid gradual darkening when rounding down */
188 MINLINE int divide_round_i(int a, int b)
189 {
190         return (2 * a + b) / (2 * b);
191 }
192
193 /**
194  * modulo that handles negative numbers, works the same as Python's.
195  */
196 MINLINE int mod_i(int i, int n)
197 {
198         return (i % n + n) % n;
199 }
200
201 MINLINE float min_ff(float a, float b)
202 {
203         return (a < b) ? a : b;
204 }
205 MINLINE float max_ff(float a, float b)
206 {
207         return (a > b) ? a : b;
208 }
209
210 MINLINE int min_ii(int a, int b)
211 {
212         return (a < b) ? a : b;
213 }
214 MINLINE int max_ii(int a, int b)
215 {
216         return (b < a) ? a : b;
217 }
218
219 MINLINE float min_fff(float a, float b, float c)
220 {
221         return min_ff(min_ff(a, b), c);
222 }
223 MINLINE float max_fff(float a, float b, float c)
224 {
225         return max_ff(max_ff(a, b), c);
226 }
227
228 MINLINE int min_iii(int a, int b, int c)
229 {
230         return min_ii(min_ii(a, b), c);
231 }
232 MINLINE int max_iii(int a, int b, int c)
233 {
234         return max_ii(max_ii(a, b), c);
235 }
236
237 MINLINE float min_ffff(float a, float b, float c, float d)
238 {
239         return min_ff(min_fff(a, b, c), d);
240 }
241 MINLINE float max_ffff(float a, float b, float c, float d)
242 {
243         return max_ff(max_fff(a, b, c), d);
244 }
245
246 MINLINE int min_iiii(int a, int b, int c, int d)
247 {
248         return min_ii(min_iii(a, b, c), d);
249 }
250 MINLINE int max_iiii(int a, int b, int c, int d)
251 {
252         return max_ii(max_iii(a, b, c), d);
253 }
254
255 MINLINE float signf(float f)
256 {
257         return (f < 0.f) ? -1.f : 1.f;
258 }
259
260 MINLINE int signum_i_ex(float a, float eps)
261 {
262         if (a >  eps) return  1;
263         if (a < -eps) return -1;
264         else          return  0;
265 }
266
267 MINLINE int signum_i(float a)
268 {
269         if (a > 0.0f) return  1;
270         if (a < 0.0f) return -1;
271         else          return  0;
272 }
273
274 #endif /* __MATH_BASE_INLINE_C__ */