Math Lib: add iroundf function for: (int)floorf(a + 0.5f)
[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 /* A few small defines. Keep'em local! */
48 #define SMALL_NUMBER  1.e-8f
49
50 MINLINE float sqrt3f(float f)
51 {
52         if      (UNLIKELY(f == 0.0f)) return 0.0f;
53         else if (UNLIKELY(f <  0.0f)) return -(float)(exp(log(-f) / 3.0));
54         else                          return  (float)(exp(log( f) / 3.0));
55 }
56
57 MINLINE double sqrt3d(double d)
58 {
59         if      (UNLIKELY(d == 0.0)) return 0.0;
60         else if (UNLIKELY(d <  0.0)) return -exp(log(-d) / 3.0);
61         else                         return  exp(log( d) / 3.0);
62 }
63
64 MINLINE float sqrtf_signed(float f)
65 {
66         return (f >= 0.0f) ? sqrtf(f) : -sqrtf(-f);
67 }
68
69 MINLINE float saacos(float fac)
70 {
71         if      (UNLIKELY(fac <= -1.0f)) return (float)M_PI;
72         else if (UNLIKELY(fac >=  1.0f)) return 0.0f;
73         else                             return acosf(fac);
74 }
75
76 MINLINE float saasin(float fac)
77 {
78         if      (UNLIKELY(fac <= -1.0f)) return (float)-M_PI / 2.0f;
79         else if (UNLIKELY(fac >=  1.0f)) return (float) M_PI / 2.0f;
80         else                             return asinf(fac);
81 }
82
83 MINLINE float sasqrt(float fac)
84 {
85         if (UNLIKELY(fac <= 0.0f)) return 0.0f;
86         else                       return sqrtf(fac);
87 }
88
89 MINLINE float saacosf(float fac)
90 {
91         if      (UNLIKELY(fac <= -1.0f)) return (float)M_PI;
92         else if (UNLIKELY(fac >=  1.0f)) return 0.0f;
93         else                             return acosf(fac);
94 }
95
96 MINLINE float saasinf(float fac)
97 {
98         if      (UNLIKELY(fac <= -1.0f)) return (float)-M_PI / 2.0f;
99         else if (UNLIKELY(fac >=  1.0f)) return (float) M_PI / 2.0f;
100         else                             return asinf(fac);
101 }
102
103 MINLINE float sasqrtf(float fac)
104 {
105         if (UNLIKELY(fac <= 0.0f)) return 0.0f;
106         else                       return sqrtf(fac);
107 }
108
109 MINLINE float interpf(float target, float origin, float fac)
110 {
111         return (fac * target) + (1.0f - fac) * origin;
112 }
113
114 /* useful to calculate an even width shell, by taking the angle between 2 planes.
115  * The return value is a scale on the offset.
116  * no angle between planes is 1.0, as the angle between the 2 planes approaches 180d
117  * the distance gets very high, 180d would be inf, but this case isn't valid */
118 MINLINE float shell_angle_to_dist(const float angle)
119 {
120         return (UNLIKELY(angle < SMALL_NUMBER)) ? 1.0f : fabsf(1.0f / cosf(angle));
121 }
122
123 /* used for zoom values*/
124 MINLINE float power_of_2(float val)
125 {
126         return (float)pow(2.0, ceil(log((double)val) / M_LN2));
127 }
128
129 MINLINE int is_power_of_2_i(int n)
130 {
131         return (n & (n - 1)) == 0;
132 }
133
134 MINLINE int power_of_2_max_i(int n)
135 {
136         if (is_power_of_2_i(n))
137                 return n;
138
139         do {
140                 n = n & (n - 1);
141         } while (!is_power_of_2_i(n));
142
143         return n * 2;
144 }
145
146 MINLINE int power_of_2_min_i(int n)
147 {
148         while (!is_power_of_2_i(n))
149                 n = n & (n - 1);
150
151         return n;
152 }
153
154 MINLINE int iroundf(float a)
155 {
156         return (int)floorf(a + 0.5f);
157 }
158
159 /* integer division that rounds 0.5 up, particularly useful for color blending
160  * with integers, to avoid gradual darkening when rounding down */
161 MINLINE int divide_round_i(int a, int b)
162 {
163         return (2 * a + b) / (2 * b);
164 }
165
166 /**
167  * modulo that handles negative numbers, works the same as Python's.
168  */
169 MINLINE int mod_i(int i, int n)
170 {
171         return (i % n + n) % n;
172 }
173
174 MINLINE unsigned int highest_order_bit_i(unsigned int n)
175 {
176         n |= (n >>  1);
177         n |= (n >>  2);
178         n |= (n >>  4);
179         n |= (n >>  8);
180         n |= (n >> 16);
181         return n - (n >> 1);
182 }
183
184 MINLINE unsigned short highest_order_bit_s(unsigned short n)
185 {
186         n |= (n >>  1);
187         n |= (n >>  2);
188         n |= (n >>  4);
189         n |= (n >>  8);
190         return (unsigned short)(n - (n >> 1));
191 }
192
193 MINLINE float min_ff(float a, float b)
194 {
195         return (a < b) ? a : b;
196 }
197 MINLINE float max_ff(float a, float b)
198 {
199         return (a > b) ? a : b;
200 }
201
202 MINLINE int min_ii(int a, int b)
203 {
204         return (a < b) ? a : b;
205 }
206 MINLINE int max_ii(int a, int b)
207 {
208         return (b < a) ? a : b;
209 }
210
211 MINLINE float min_fff(float a, float b, float c)
212 {
213         return min_ff(min_ff(a, b), c);
214 }
215 MINLINE float max_fff(float a, float b, float c)
216 {
217         return max_ff(max_ff(a, b), c);
218 }
219
220 MINLINE int min_iii(int a, int b, int c)
221 {
222         return min_ii(min_ii(a, b), c);
223 }
224 MINLINE int max_iii(int a, int b, int c)
225 {
226         return max_ii(max_ii(a, b), c);
227 }
228
229 MINLINE float min_ffff(float a, float b, float c, float d)
230 {
231         return min_ff(min_fff(a, b, c), d);
232 }
233 MINLINE float max_ffff(float a, float b, float c, float d)
234 {
235         return max_ff(max_fff(a, b, c), d);
236 }
237
238 MINLINE int min_iiii(int a, int b, int c, int d)
239 {
240         return min_ii(min_iii(a, b, c), d);
241 }
242 MINLINE int max_iiii(int a, int b, int c, int d)
243 {
244         return max_ii(max_iii(a, b, c), d);
245 }
246
247 MINLINE float signf(float f)
248 {
249         return (f < 0.f) ? -1.f : 1.f;
250 }
251
252
253 #endif /* __MATH_BASE_INLINE_C__ */