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