Revert bug 19975, now that gcc 4.7 is required.
[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 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 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 #ifndef M_PI
47 const double piDouble = 3.14159265358979323846;
48 const float piFloat = 3.14159265358979323846f;
49 #else
50 const double piDouble = M_PI;
51 const float piFloat = static_cast<float>(M_PI);
52 #endif
53
54 #ifndef M_PI_2
55 const double piOverTwoDouble = 1.57079632679489661923;
56 const float piOverTwoFloat = 1.57079632679489661923f;
57 #else
58 const double piOverTwoDouble = M_PI_2;
59 const float piOverTwoFloat = static_cast<float>(M_PI_2);
60 #endif
61
62 #ifndef M_PI_4
63 const double piOverFourDouble = 0.785398163397448309616;
64 const float piOverFourFloat = 0.785398163397448309616f;
65 #else
66 const double piOverFourDouble = M_PI_4;
67 const float piOverFourFloat = static_cast<float>(M_PI_4);
68 #endif
69
70 #ifndef M_SQRT2
71 const double sqrtOfTwoDouble = 1.41421356237309504880;
72 const float sqrtOfTwoFloat = 1.41421356237309504880f;
73 #else
74 const double sqrtOfTwoDouble = M_SQRT2;
75 const float sqrtOfTwoFloat = static_cast<float>(M_SQRT2);
76 #endif
77
78 #if OS(DARWIN)
79
80 // Work around a bug in the Mac OS X libc where ceil(-0.1) return +0.
81 inline double wtf_ceil(double x) { return copysign(ceil(x), x); }
82
83 #define ceil(x) wtf_ceil(x)
84
85 #endif
86
87 #if OS(SOLARIS)
88
89 namespace std {
90
91 #ifndef isfinite
92 inline bool isfinite(double x) { return finite(x) && !isnand(x); }
93 #endif
94 #ifndef signbit
95 inline bool signbit(double x) { return copysign(1.0, x) < 0; }
96 #endif
97 #ifndef isinf
98 inline bool isinf(double x) { return !finite(x) && !isnand(x); }
99 #endif
100
101 } // namespace std
102
103 #endif
104
105 #if COMPILER(MSVC)
106
107 // Work around a bug in Win, where atan2(+-infinity, +-infinity) yields NaN instead of specific values.
108 extern "C" inline double wtf_atan2(double x, double y)
109 {
110     double posInf = std::numeric_limits<double>::infinity();
111     double negInf = -std::numeric_limits<double>::infinity();
112     double nan = std::numeric_limits<double>::quiet_NaN();
113
114     double result = nan;
115
116     if (x == posInf && y == posInf)
117         result = piOverFourDouble;
118     else if (x == posInf && y == negInf)
119         result = 3 * piOverFourDouble;
120     else if (x == negInf && y == posInf)
121         result = -piOverFourDouble;
122     else if (x == negInf && y == negInf)
123         result = -3 * piOverFourDouble;
124     else
125         result = ::atan2(x, y);
126
127     return result;
128 }
129
130 // Work around a bug in the Microsoft CRT, where fmod(x, +-infinity) yields NaN instead of x.
131 extern "C" inline double wtf_fmod(double x, double y) { return (!std::isinf(x) && std::isinf(y)) ? x : fmod(x, y); }
132
133 // Work around a bug in the Microsoft CRT, where pow(NaN, 0) yields NaN instead of 1.
134 extern "C" inline double wtf_pow(double x, double y) { return y == 0 ? 1 : pow(x, y); }
135
136 #define atan2(x, y) wtf_atan2(x, y)
137 #define fmod(x, y) wtf_fmod(x, y)
138 #define pow(x, y) wtf_pow(x, y)
139
140 #endif // COMPILER(MSVC)
141
142 inline double deg2rad(double d)  { return d * piDouble / 180.0; }
143 inline double rad2deg(double r)  { return r * 180.0 / piDouble; }
144 inline double deg2grad(double d) { return d * 400.0 / 360.0; }
145 inline double grad2deg(double g) { return g * 360.0 / 400.0; }
146 inline double turn2deg(double t) { return t * 360.0; }
147 inline double deg2turn(double d) { return d / 360.0; }
148 inline double rad2grad(double r) { return r * 200.0 / piDouble; }
149 inline double grad2rad(double g) { return g * piDouble / 200.0; }
150
151 inline float deg2rad(float d)  { return d * piFloat / 180.0f; }
152 inline float rad2deg(float r)  { return r * 180.0f / piFloat; }
153 inline float deg2grad(float d) { return d * 400.0f / 360.0f; }
154 inline float grad2deg(float g) { return g * 360.0f / 400.0f; }
155 inline float turn2deg(float t) { return t * 360.0f; }
156 inline float deg2turn(float d) { return d / 360.0f; }
157 inline float rad2grad(float r) { return r * 200.0f / piFloat; }
158 inline float grad2rad(float g) { return g * piFloat / 200.0f; }
159
160 // std::numeric_limits<T>::min() returns the smallest positive value for floating point types
161 template<typename T> inline T defaultMinimumForClamp() { return std::numeric_limits<T>::min(); }
162 template<> inline float defaultMinimumForClamp() { return -std::numeric_limits<float>::max(); }
163 template<> inline double defaultMinimumForClamp() { return -std::numeric_limits<double>::max(); }
164 template<typename T> inline T defaultMaximumForClamp() { return std::numeric_limits<T>::max(); }
165
166 template<typename T> inline T clampTo(double value, T min = defaultMinimumForClamp<T>(), T max = defaultMaximumForClamp<T>())
167 {
168     if (value >= static_cast<double>(max))
169         return max;
170     if (value <= static_cast<double>(min))
171         return min;
172     return static_cast<T>(value);
173 }
174 template<> inline long long int clampTo(double, long long int, long long int); // clampTo does not support long long ints.
175
176 inline int clampToInteger(double value)
177 {
178     return clampTo<int>(value);
179 }
180
181 inline unsigned clampToUnsigned(double value)
182 {
183     return clampTo<unsigned>(value);
184 }
185
186 inline float clampToFloat(double value)
187 {
188     return clampTo<float>(value);
189 }
190
191 inline int clampToPositiveInteger(double value)
192 {
193     return clampTo<int>(value, 0);
194 }
195
196 inline int clampToInteger(float value)
197 {
198     return clampTo<int>(value);
199 }
200
201 inline int clampToInteger(unsigned x)
202 {
203     const unsigned intMax = static_cast<unsigned>(std::numeric_limits<int>::max());
204
205     if (x >= intMax)
206         return std::numeric_limits<int>::max();
207     return static_cast<int>(x);
208 }
209
210 inline bool isWithinIntRange(float x)
211 {
212     return x > static_cast<float>(std::numeric_limits<int>::min()) && x < static_cast<float>(std::numeric_limits<int>::max());
213 }
214
215 template<typename T> inline bool hasOneBitSet(T value)
216 {
217     return !((value - 1) & value) && value;
218 }
219
220 template<typename T> inline bool hasZeroOrOneBitsSet(T value)
221 {
222     return !((value - 1) & value);
223 }
224
225 template<typename T> inline bool hasTwoOrMoreBitsSet(T value)
226 {
227     return !hasZeroOrOneBitsSet(value);
228 }
229
230 template <typename T> inline unsigned getLSBSet(T value)
231 {
232     unsigned result = 0;
233
234     while (value >>= 1)
235         ++result;
236
237     return result;
238 }
239
240 template<typename T> inline T divideRoundedUp(T a, T b)
241 {
242     return (a + b - 1) / b;
243 }
244
245 template<typename T> inline T timesThreePlusOneDividedByTwo(T value)
246 {
247     // Mathematically equivalent to:
248     //   (value * 3 + 1) / 2;
249     // or:
250     //   (unsigned)ceil(value * 1.5));
251     // This form is not prone to internal overflow.
252     return value + (value >> 1) + (value & 1);
253 }
254
255 template<typename T> inline bool isNotZeroAndOrdered(T value)
256 {
257     return value > 0.0 || value < 0.0;
258 }
259
260 template<typename T> inline bool isZeroOrUnordered(T value)
261 {
262     return !isNotZeroAndOrdered(value);
263 }
264
265 template<typename T> inline bool isGreaterThanNonZeroPowerOfTwo(T value, unsigned power)
266 {
267     // The crazy way of testing of index >= 2 ** power
268     // (where I use ** to denote pow()).
269     return !!((value >> 1) >> (power - 1));
270 }
271
272 #ifndef UINT64_C
273 #if COMPILER(MSVC)
274 #define UINT64_C(c) c ## ui64
275 #else
276 #define UINT64_C(c) c ## ull
277 #endif
278 #endif
279
280 #if COMPILER(MINGW64) && (!defined(__MINGW64_VERSION_RC) || __MINGW64_VERSION_RC < 1)
281 inline double wtf_pow(double x, double y)
282 {
283     // MinGW-w64 has a custom implementation for pow.
284     // This handles certain special cases that are different.
285     if ((x == 0.0 || std::isinf(x)) && std::isfinite(y)) {
286         double f;
287         if (modf(y, &f) != 0.0)
288             return ((x == 0.0) ^ (y > 0.0)) ? std::numeric_limits<double>::infinity() : 0.0;
289     }
290
291     if (x == 2.0) {
292         int yInt = static_cast<int>(y);
293         if (y == yInt)
294             return ldexp(1.0, yInt);
295     }
296
297     return pow(x, y);
298 }
299 #define pow(x, y) wtf_pow(x, y)
300 #endif // COMPILER(MINGW64) && (!defined(__MINGW64_VERSION_RC) || __MINGW64_VERSION_RC < 1)
301
302
303 // decompose 'number' to its sign, exponent, and mantissa components.
304 // The result is interpreted as:
305 //     (sign ? -1 : 1) * pow(2, exponent) * (mantissa / (1 << 52))
306 inline void decomposeDouble(double number, bool& sign, int32_t& exponent, uint64_t& mantissa)
307 {
308     ASSERT(std::isfinite(number));
309
310     sign = std::signbit(number);
311
312     uint64_t bits = WTF::bitwise_cast<uint64_t>(number);
313     exponent = (static_cast<int32_t>(bits >> 52) & 0x7ff) - 0x3ff;
314     mantissa = bits & 0xFFFFFFFFFFFFFull;
315
316     // Check for zero/denormal values; if so, adjust the exponent,
317     // if not insert the implicit, omitted leading 1 bit.
318     if (exponent == -0x3ff)
319         exponent = mantissa ? -0x3fe : 0;
320     else
321         mantissa |= 0x10000000000000ull;
322 }
323
324 // Calculate d % 2^{64}.
325 inline void doubleToInteger(double d, unsigned long long& value)
326 {
327     if (std::isnan(d) || std::isinf(d))
328         value = 0;
329     else {
330         // -2^{64} < fmodValue < 2^{64}.
331         double fmodValue = fmod(trunc(d), std::numeric_limits<unsigned long long>::max() + 1.0);
332         if (fmodValue >= 0) {
333             // 0 <= fmodValue < 2^{64}.
334             // 0 <= value < 2^{64}. This cast causes no loss.
335             value = static_cast<unsigned long long>(fmodValue);
336         } else {
337             // -2^{64} < fmodValue < 0.
338             // 0 < fmodValueInUnsignedLongLong < 2^{64}. This cast causes no loss.
339             unsigned long long fmodValueInUnsignedLongLong = static_cast<unsigned long long>(-fmodValue);
340             // -1 < (std::numeric_limits<unsigned long long>::max() - fmodValueInUnsignedLongLong) < 2^{64} - 1.
341             // 0 < value < 2^{64}.
342             value = std::numeric_limits<unsigned long long>::max() - fmodValueInUnsignedLongLong + 1;
343         }
344     }
345 }
346
347 namespace WTF {
348
349 // From http://graphics.stanford.edu/~seander/bithacks.html#RoundUpPowerOf2
350 inline uint32_t roundUpToPowerOfTwo(uint32_t v)
351 {
352     v--;
353     v |= v >> 1;
354     v |= v >> 2;
355     v |= v >> 4;
356     v |= v >> 8;
357     v |= v >> 16;
358     v++;
359     return v;
360 }
361
362 inline unsigned fastLog2(unsigned i)
363 {
364     unsigned log2 = 0;
365     if (i & (i - 1))
366         log2 += 1;
367     if (i >> 16)
368         log2 += 16, i >>= 16;
369     if (i >> 8)
370         log2 += 8, i >>= 8;
371     if (i >> 4)
372         log2 += 4, i >>= 4;
373     if (i >> 2)
374         log2 += 2, i >>= 2;
375     if (i >> 1)
376         log2 += 1;
377     return log2;
378 }
379
380 template <typename T>
381 inline typename std::enable_if<std::is_floating_point<T>::value, T>::type safeFPDivision(T u, T v)
382 {
383     // Protect against overflow / underflow.
384     if (v < 1 && u > v * std::numeric_limits<T>::max())
385         return std::numeric_limits<T>::max();
386     if (v > 1 && u < v * std::numeric_limits<T>::min())
387         return 0;
388     return u / v;
389 }
390
391 // Floating point numbers comparison:
392 // u is "essentially equal" [1][2] to v if: | u - v | / |u| <= e and | u - v | / |v| <= e
393 //
394 // [1] Knuth, D. E. "Accuracy of Floating Point Arithmetic." The Art of Computer Programming. 3rd ed. Vol. 2.
395 //     Boston: Addison-Wesley, 1998. 229-45.
396 // [2] http://www.boost.org/doc/libs/1_34_0/libs/test/doc/components/test_tools/floating_point_comparison.html
397 template <typename T>
398 inline typename std::enable_if<std::is_floating_point<T>::value, bool>::type areEssentiallyEqual(T u, T v, T epsilon = std::numeric_limits<T>::epsilon())
399 {
400     if (u == v)
401         return true;
402
403     const T delta = std::abs(u - v);
404     return safeFPDivision(delta, std::abs(u)) <= epsilon && safeFPDivision(delta, std::abs(v)) <= epsilon;
405 }
406
407 inline bool isIntegral(float value)
408 {
409     return static_cast<int>(value) == value;
410 }
411
412 } // namespace WTF
413
414 #endif // #ifndef WTF_MathExtras_h