fourthTier: Landing the initial FTL logic in a single commit to avoid spurious
[WebKit-https.git] / Source / WTF / wtf / MathExtras.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009, 2010, 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef WTF_MathExtras_h
27 #define WTF_MathExtras_h
28
29 #include <algorithm>
30 #include <cmath>
31 #include <float.h>
32 #include <limits>
33 #include <stdint.h>
34 #include <stdlib.h>
35 #include <wtf/StdLibExtras.h>
36
37 #if OS(SOLARIS)
38 #include <ieeefp.h>
39 #endif
40
41 #if OS(OPENBSD)
42 #include <sys/types.h>
43 #include <machine/ieee.h>
44 #endif
45
46 #if OS(QNX)
47 // FIXME: Look into a way to have cmath import its functions into both the standard and global
48 // namespace. For now, we include math.h since the QNX cmath header only imports its functions
49 // into the standard namespace.
50 #include <math.h>
51 // These macros from math.h conflict with the real functions in the std namespace.
52 #undef signbit
53 #undef isnan
54 #undef isinf
55 #undef isfinite
56 #endif
57
58 #ifndef M_PI
59 const double piDouble = 3.14159265358979323846;
60 const float piFloat = 3.14159265358979323846f;
61 #else
62 const double piDouble = M_PI;
63 const float piFloat = static_cast<float>(M_PI);
64 #endif
65
66 #ifndef M_PI_2
67 const double piOverTwoDouble = 1.57079632679489661923;
68 const float piOverTwoFloat = 1.57079632679489661923f;
69 #else
70 const double piOverTwoDouble = M_PI_2;
71 const float piOverTwoFloat = static_cast<float>(M_PI_2);
72 #endif
73
74 #ifndef M_PI_4
75 const double piOverFourDouble = 0.785398163397448309616;
76 const float piOverFourFloat = 0.785398163397448309616f;
77 #else
78 const double piOverFourDouble = M_PI_4;
79 const float piOverFourFloat = static_cast<float>(M_PI_4);
80 #endif
81
82 #if OS(DARWIN)
83
84 // Work around a bug in the Mac OS X libc where ceil(-0.1) return +0.
85 inline double wtf_ceil(double x) { return copysign(ceil(x), x); }
86
87 #define ceil(x) wtf_ceil(x)
88
89 #endif
90
91 #if OS(SOLARIS)
92
93 namespace std {
94
95 #ifndef isfinite
96 inline bool isfinite(double x) { return finite(x) && !isnand(x); }
97 #endif
98 #ifndef signbit
99 inline bool signbit(double x) { return copysign(1.0, x) < 0; }
100 #endif
101 #ifndef isinf
102 inline bool isinf(double x) { return !finite(x) && !isnand(x); }
103 #endif
104
105 } // namespace std
106
107 #endif
108
109 #if OS(OPENBSD)
110
111 namespace std {
112
113 #ifndef isfinite
114 inline bool isfinite(double x) { return finite(x); }
115 #endif
116 #ifndef signbit
117 inline bool signbit(double x) { struct ieee_double *p = (struct ieee_double *)&x; return p->dbl_sign; }
118 #endif
119
120 } // namespace std
121
122 #endif
123
124 #if COMPILER(MSVC)
125
126 // We must not do 'num + 0.5' or 'num - 0.5' because they can cause precision loss.
127 static double round(double num)
128 {
129     double integer = ceil(num);
130     if (num > 0)
131         return integer - num > 0.5 ? integer - 1.0 : integer;
132     return integer - num >= 0.5 ? integer - 1.0 : integer;
133 }
134 static float roundf(float num)
135 {
136     float integer = ceilf(num);
137     if (num > 0)
138         return integer - num > 0.5f ? integer - 1.0f : integer;
139     return integer - num >= 0.5f ? integer - 1.0f : integer;
140 }
141 inline long long llround(double num) { return static_cast<long long>(round(num)); }
142 inline long long llroundf(float num) { return static_cast<long long>(roundf(num)); }
143 inline long lround(double num) { return static_cast<long>(round(num)); }
144 inline long lroundf(float num) { return static_cast<long>(roundf(num)); }
145 inline double trunc(double num) { return num > 0 ? floor(num) : ceil(num); }
146
147 #endif
148
149 #if COMPILER(GCC) && OS(QNX)
150 // The stdlib on QNX doesn't contain long abs(long). See PR #104666.
151 inline long long abs(long num) { return labs(num); }
152 #endif
153
154 #if COMPILER(MSVC)
155 // MSVC's math.h does not currently supply log2 or log2f.
156 inline double log2(double num)
157 {
158     // This constant is roughly M_LN2, which is not provided by default on Windows.
159     return log(num) / 0.693147180559945309417232121458176568;
160 }
161
162 inline float log2f(float num)
163 {
164     // This constant is roughly M_LN2, which is not provided by default on Windows.
165     return logf(num) / 0.693147180559945309417232121458176568f;
166 }
167 #endif
168
169 #if COMPILER(MSVC)
170 // The 64bit version of abs() is already defined in stdlib.h which comes with VC10
171 #if COMPILER(MSVC9_OR_LOWER)
172 inline long long abs(long long num) { return _abs64(num); }
173 #endif
174
175 namespace std {
176
177 inline bool isinf(double num) { return !_finite(num) && !_isnan(num); }
178 inline bool isnan(double num) { return !!_isnan(num); }
179 inline bool isfinite(double x) { return _finite(x); }
180 inline bool signbit(double num) { return _copysign(1.0, num) < 0; }
181
182 } // namespace std
183
184 inline double nextafter(double x, double y) { return _nextafter(x, y); }
185 inline float nextafterf(float x, float y) { return x > y ? x - FLT_EPSILON : x + FLT_EPSILON; }
186
187 inline double copysign(double x, double y) { return _copysign(x, y); }
188
189 // Work around a bug in Win, where atan2(+-infinity, +-infinity) yields NaN instead of specific values.
190 extern "C" inline double wtf_atan2(double x, double y)
191 {
192     double posInf = std::numeric_limits<double>::infinity();
193     double negInf = -std::numeric_limits<double>::infinity();
194     double nan = std::numeric_limits<double>::quiet_NaN();
195
196     double result = nan;
197
198     if (x == posInf && y == posInf)
199         result = piOverFourDouble;
200     else if (x == posInf && y == negInf)
201         result = 3 * piOverFourDouble;
202     else if (x == negInf && y == posInf)
203         result = -piOverFourDouble;
204     else if (x == negInf && y == negInf)
205         result = -3 * piOverFourDouble;
206     else
207         result = ::atan2(x, y);
208
209     return result;
210 }
211
212 // Work around a bug in the Microsoft CRT, where fmod(x, +-infinity) yields NaN instead of x.
213 extern "C" inline double wtf_fmod(double x, double y) { return (!std::isinf(x) && std::isinf(y)) ? x : fmod(x, y); }
214
215 // Work around a bug in the Microsoft CRT, where pow(NaN, 0) yields NaN instead of 1.
216 extern "C" inline double wtf_pow(double x, double y) { return y == 0 ? 1 : pow(x, y); }
217
218 #define atan2(x, y) wtf_atan2(x, y)
219 #define fmod(x, y) wtf_fmod(x, y)
220 #define pow(x, y) wtf_pow(x, y)
221
222 // MSVC's math functions do not bring lrint.
223 inline long int lrint(double flt)
224 {
225     int64_t intgr;
226 #if CPU(X86)
227     __asm {
228         fld flt
229         fistp intgr
230     };
231 #else
232     ASSERT(std::isfinite(flt));
233     double rounded = round(flt);
234     intgr = static_cast<int64_t>(rounded);
235     // If the fractional part is exactly 0.5, we need to check whether
236     // the rounded result is even. If it is not we need to add 1 to
237     // negative values and subtract one from positive values.
238     if ((fabs(intgr - flt) == 0.5) & intgr)
239         intgr -= ((intgr >> 62) | 1); // 1 with the sign of result, i.e. -1 or 1.
240 #endif
241     return static_cast<long int>(intgr);
242 }
243
244 #endif // COMPILER(MSVC)
245
246 inline double deg2rad(double d)  { return d * piDouble / 180.0; }
247 inline double rad2deg(double r)  { return r * 180.0 / piDouble; }
248 inline double deg2grad(double d) { return d * 400.0 / 360.0; }
249 inline double grad2deg(double g) { return g * 360.0 / 400.0; }
250 inline double turn2deg(double t) { return t * 360.0; }
251 inline double deg2turn(double d) { return d / 360.0; }
252 inline double rad2grad(double r) { return r * 200.0 / piDouble; }
253 inline double grad2rad(double g) { return g * piDouble / 200.0; }
254
255 inline float deg2rad(float d)  { return d * piFloat / 180.0f; }
256 inline float rad2deg(float r)  { return r * 180.0f / piFloat; }
257 inline float deg2grad(float d) { return d * 400.0f / 360.0f; }
258 inline float grad2deg(float g) { return g * 360.0f / 400.0f; }
259 inline float turn2deg(float t) { return t * 360.0f; }
260 inline float deg2turn(float d) { return d / 360.0f; }
261 inline float rad2grad(float r) { return r * 200.0f / piFloat; }
262 inline float grad2rad(float g) { return g * piFloat / 200.0f; }
263
264 // std::numeric_limits<T>::min() returns the smallest positive value for floating point types
265 template<typename T> inline T defaultMinimumForClamp() { return std::numeric_limits<T>::min(); }
266 template<> inline float defaultMinimumForClamp() { return -std::numeric_limits<float>::max(); }
267 template<> inline double defaultMinimumForClamp() { return -std::numeric_limits<double>::max(); }
268 template<typename T> inline T defaultMaximumForClamp() { return std::numeric_limits<T>::max(); }
269
270 template<typename T> inline T clampTo(double value, T min = defaultMinimumForClamp<T>(), T max = defaultMaximumForClamp<T>())
271 {
272     if (value >= static_cast<double>(max))
273         return max;
274     if (value <= static_cast<double>(min))
275         return min;
276     return static_cast<T>(value);
277 }
278 template<> inline long long int clampTo(double, long long int, long long int); // clampTo does not support long long ints.
279
280 inline int clampToInteger(double value)
281 {
282     return clampTo<int>(value);
283 }
284
285 inline float clampToFloat(double value)
286 {
287     return clampTo<float>(value);
288 }
289
290 inline int clampToPositiveInteger(double value)
291 {
292     return clampTo<int>(value, 0);
293 }
294
295 inline int clampToInteger(float value)
296 {
297     return clampTo<int>(value);
298 }
299
300 inline int clampToInteger(unsigned x)
301 {
302     const unsigned intMax = static_cast<unsigned>(std::numeric_limits<int>::max());
303
304     if (x >= intMax)
305         return std::numeric_limits<int>::max();
306     return static_cast<int>(x);
307 }
308
309 inline bool isWithinIntRange(float x)
310 {
311     return x > static_cast<float>(std::numeric_limits<int>::min()) && x < static_cast<float>(std::numeric_limits<int>::max());
312 }
313
314 template<typename T> inline bool hasOneBitSet(T value)
315 {
316     return !((value - 1) & value) && value;
317 }
318
319 template<typename T> inline bool hasZeroOrOneBitsSet(T value)
320 {
321     return !((value - 1) & value);
322 }
323
324 template<typename T> inline bool hasTwoOrMoreBitsSet(T value)
325 {
326     return !hasZeroOrOneBitsSet(value);
327 }
328
329 template <typename T> inline unsigned getLSBSet(T value)
330 {
331     unsigned result = 0;
332
333     while (value >>= 1)
334         ++result;
335
336     return result;
337 }
338
339 template<typename T> inline T timesThreePlusOneDividedByTwo(T value)
340 {
341     // Mathematically equivalent to:
342     //   (value * 3 + 1) / 2;
343     // or:
344     //   (unsigned)ceil(value * 1.5));
345     // This form is not prone to internal overflow.
346     return value + (value >> 1) + (value & 1);
347 }
348
349 template<typename T> inline bool isNotZeroAndOrdered(T value)
350 {
351     return value > 0.0 || value < 0.0;
352 }
353
354 template<typename T> inline bool isZeroOrUnordered(T value)
355 {
356     return !isNotZeroAndOrdered(value);
357 }
358
359 template<typename T> inline bool isGreaterThanNonZeroPowerOfTwo(T value, unsigned power)
360 {
361     // The crazy way of testing of index >= 2 ** power
362     // (where I use ** to denote pow()).
363     return !!((value >> 1) >> (power - 1));
364 }
365
366 #ifndef UINT64_C
367 #if COMPILER(MSVC)
368 #define UINT64_C(c) c ## ui64
369 #else
370 #define UINT64_C(c) c ## ull
371 #endif
372 #endif
373
374 #if COMPILER(MINGW64) && (!defined(__MINGW64_VERSION_RC) || __MINGW64_VERSION_RC < 1)
375 inline double wtf_pow(double x, double y)
376 {
377     // MinGW-w64 has a custom implementation for pow.
378     // This handles certain special cases that are different.
379     if ((x == 0.0 || std::isinf(x)) && std::isfinite(y)) {
380         double f;
381         if (modf(y, &f) != 0.0)
382             return ((x == 0.0) ^ (y > 0.0)) ? std::numeric_limits<double>::infinity() : 0.0;
383     }
384
385     if (x == 2.0) {
386         int yInt = static_cast<int>(y);
387         if (y == yInt)
388             return ldexp(1.0, yInt);
389     }
390
391     return pow(x, y);
392 }
393 #define pow(x, y) wtf_pow(x, y)
394 #endif // COMPILER(MINGW64) && (!defined(__MINGW64_VERSION_RC) || __MINGW64_VERSION_RC < 1)
395
396
397 // decompose 'number' to its sign, exponent, and mantissa components.
398 // The result is interpreted as:
399 //     (sign ? -1 : 1) * pow(2, exponent) * (mantissa / (1 << 52))
400 inline void decomposeDouble(double number, bool& sign, int32_t& exponent, uint64_t& mantissa)
401 {
402     ASSERT(std::isfinite(number));
403
404     sign = std::signbit(number);
405
406     uint64_t bits = WTF::bitwise_cast<uint64_t>(number);
407     exponent = (static_cast<int32_t>(bits >> 52) & 0x7ff) - 0x3ff;
408     mantissa = bits & 0xFFFFFFFFFFFFFull;
409
410     // Check for zero/denormal values; if so, adjust the exponent,
411     // if not insert the implicit, omitted leading 1 bit.
412     if (exponent == -0x3ff)
413         exponent = mantissa ? -0x3fe : 0;
414     else
415         mantissa |= 0x10000000000000ull;
416 }
417
418 // Calculate d % 2^{64}.
419 inline void doubleToInteger(double d, unsigned long long& value)
420 {
421     if (std::isnan(d) || std::isinf(d))
422         value = 0;
423     else {
424         // -2^{64} < fmodValue < 2^{64}.
425         double fmodValue = fmod(trunc(d), std::numeric_limits<unsigned long long>::max() + 1.0);
426         if (fmodValue >= 0) {
427             // 0 <= fmodValue < 2^{64}.
428             // 0 <= value < 2^{64}. This cast causes no loss.
429             value = static_cast<unsigned long long>(fmodValue);
430         } else {
431             // -2^{64} < fmodValue < 0.
432             // 0 < fmodValueInUnsignedLongLong < 2^{64}. This cast causes no loss.
433             unsigned long long fmodValueInUnsignedLongLong = static_cast<unsigned long long>(-fmodValue);
434             // -1 < (std::numeric_limits<unsigned long long>::max() - fmodValueInUnsignedLongLong) < 2^{64} - 1.
435             // 0 < value < 2^{64}.
436             value = std::numeric_limits<unsigned long long>::max() - fmodValueInUnsignedLongLong + 1;
437         }
438     }
439 }
440
441 namespace WTF {
442
443 // From http://graphics.stanford.edu/~seander/bithacks.html#RoundUpPowerOf2
444 inline uint32_t roundUpToPowerOfTwo(uint32_t v)
445 {
446     v--;
447     v |= v >> 1;
448     v |= v >> 2;
449     v |= v >> 4;
450     v |= v >> 8;
451     v |= v >> 16;
452     v++;
453     return v;
454 }
455
456 inline unsigned fastLog2(unsigned i)
457 {
458     unsigned log2 = 0;
459     if (i & (i - 1))
460         log2 += 1;
461     if (i >> 16)
462         log2 += 16, i >>= 16;
463     if (i >> 8)
464         log2 += 8, i >>= 8;
465     if (i >> 4)
466         log2 += 4, i >>= 4;
467     if (i >> 2)
468         log2 += 2, i >>= 2;
469     if (i >> 1)
470         log2 += 1;
471     return log2;
472 }
473
474 } // namespace WTF
475
476 #endif // #ifndef WTF_MathExtras_h