@openglobus/og 0.12.4 → 0.13.0

package/src/og/math.js

@@ -1,398 +1,397 @@
-/**
- * @module og/math
- */
-"use strict";
-
-/** @const */
-export const TWO_PI = 2.0 * Math.PI;
-
-/** @const */
-export const PI_TWO = Math.PI / 2.0;
-
-export const X = 0;
-export const Y = 1;
-export const Z = 2;
-export const W = 3;
-
-export const MAX_FLOAT = Number.MAX_VALUE || 1.7976931348623157e308;
-
-/** @const */
-export const LOG2 = Math.log(2);
-/** @const */
-export const MAX32 = 2147483647;
-/** @const */
-export const MAX = 549755748352;
-/** @const */
-export const MIN = -MAX;
-
-/** @const */
-export const RADIANS = Math.PI / 180.0;
-/** @const */
-export const DEGREES = 180.0 / Math.PI;
-
-/** @const */
-export const DEGREES_DOUBLE = 2.0 * DEGREES;
-/** @const */
-export const RADIANS_HALF = 0.5 * RADIANS;
-
-/** @const */
-export const ARCSECONDS_TO_RADIANS = 0.00000484813681109536;
-/** @const */
-export const RADIANS_TO_HOURS = 3.8197186342054880584532103209403;
-/** @const */
-export const HOURS_TO_RADIANS = 0.26179938779914943653855361527329;
-/** @const */
-export const HOURS_TO_DEGREES = 15.0;
-/** @const */
-export const DEGREES_TO_HOURS = 1.0 / 15.0;
-
-/** @const */
-export const SQRT_HALF = Math.sqrt(0.5);
-
-export const EPSILON1 = 0.1;
-export const EPSILON2 = 0.01;
-export const EPSILON3 = 0.001;
-export const EPSILON4 = 0.0001;
-export const EPSILON5 = 0.00001;
-export const EPSILON6 = 0.000001;
-export const EPSILON7 = 1e-7;
-export const EPSILON8 = 1e-8;
-export const EPSILON9 = 1e-9;
-export const EPSILON10 = 1e-10;
-export const EPSILON11 = 1e-11;
-export const EPSILON12 = 1e-12;
-export const EPSILON13 = 1e-13;
-export const EPSILON14 = 1e-14;
-export const EPSILON15 = 1e-15;
-export const EPSILON16 = 1e-16;
-export const EPSILON17 = 1e-17;
-export const EPSILON18 = 1e-18;
-export const EPSILON19 = 1e-19;
-export const EPSILON20 = 1e-20;
-
-/**
- * The log function returns the power to which the base value has to be raised to produce n.
- * @function
- * @param {number} n - Produce value.
- * @param {number} base - Base value.
- * @returns {number} -
- * @example
- * log(64, 2)
- * //returns 6
- */
-export function log(n, base) {
-    return Math.log(n) / Math.log(base);
-}
-
-/**
- * Clamp the number.
- * @function
- * @param {number} number - Input number.
- * @param {number} min - Minimal edge.
- * @param {number} max - Maximal edge.
- * @returns {number} -
- * @example
- * clamp(12, 1, 5)
- * //returns 5
- */
-export function clamp(number, min, max) {
-    return Math.max(min, Math.min(number, max));
-}
-
-/**
- * Converts degrees value to radians.
- * @function
- * @param {number} degrees - Degree value.
- * @returns {number} -
- */
-export function DEG2RAD(degrees) {
-    return degrees * RADIANS;
-}
-
-/**
- * Converts radians value to degrees.
- * @function
- * @param {number} angle - Degree value.
- * @returns {number} -
- */
-export function RAD2DEG(angle) {
-    return angle * DEGREES;
-}
-
-/**
- * Check the number is a power of two.
- * @function
- * @param {number} x - Input value.
- * @returns {boolean} -
- */
-export function isPowerOfTwo(x) {
-    return (x & (x - 1)) === 0;
-}
-
-/**
- * Returns next value that is power of two.
- * @function
- * @param {number} x - Input value.
- * @returns {number} -
- */
-export function nextHighestPowerOfTwo(x) {
-    --x;
-    for (var i = 1; i < 32; i <<= 1) {
-        x = x | (x >> i);
-    }
-    return x + 1;
-}
-
-/**
- * Returns random integer number within the bounds.
- * @function
- * @param {number} min - Minimal bound.
- * @param {number} max - Maximal bound.
- * @returns {number} -
- */
-export function randomi(min = 0, max = 1) {
-    return Math.floor(Math.random() * (max - min)) + min;
-}
-
-/**
- * Returns random number within the bounds.
- * @function
- * @param {number} [min=0] - Minimal bound.
- * @param {number} [max=1] - Maximal bound.
- * @returns {number} -
- */
-export function random(min = 0, max = 1) {
-    return Math.random() * (max - min) + min;
-}
-
-/**
- * Converts degrees value to decimal.
- * @function
- * @param {number} d - Degrees.
- * @param {number} m - Minutes.
- * @param {number} s - Seconds.
- * @param {boolean} [p] - Positive flag. False - default.
- * @returns {number} -
- **/
-export function degToDec(d, m, s, p) {
-    if (p) {
-        return d + m / 60.0 + s / 3600.0;
-    } else {
-        return -d - m / 60.0 - s / 3600.0;
-    }
-}
-
-/**
- * The modulo operation that also works for negative dividends.
- * @function
- * @param {number} m - The dividend.
- * @param {number} n - The divisor.
- * @returns {number} The remainder.
- */
-export function mod(m, n) {
-    return ((m % n) + n) % n;
-}
-
-/**
- * Returns an angle in the range 0 <= angle <= 2Pi which is equivalent to the provided angle.
- * @function
- * @param {number} a - Angle in radians
- * @returns {number} -
- */
-export function zeroTwoPI(a) {
-    var mod = mod(a, TWO_PI);
-    if (Math.abs(mod) < EPSILON14 && Math.abs(a) > EPSILON14) {
-        return TWO_PI;
-    }
-    return mod;
-}
-
-/**
- * Returns 0.0 if x is smaller then edge and otherwise 1.0.
- * @function
- * @param {number} edge -
- * @param {number} x - Value to edge.
- * @returns {number} -
- */
-export function step(edge, x) {
-    return x < edge ? 0.0 : 1.0;
-}
-
-/**
- * The fract function returns the fractional part of x, i.e. x minus floor(x).
- * @function
- * @param {number} x - Input value.
- * @returns {number} -
- */
-export function frac(x) {
-    return x - Math.floor(x);
-}
-
-/**
- * Returns Math.log(x) / Math.log(2)
- * @function
- * @param {number} x - Input value.
- * @returns {number} -
- */
-export function log2(x) {
-    return Math.log(x) / LOG2;
-}
-
-/**
- * Returns two power of n.
- * @function
- * @param {number} n - Power value.
- * @returns {number} -
- */
-export function exp2(n) {
-    return Math.pow(2, n);
-}
-
-/**
- * Returns two power of integer n.
- * @function
- * @param {number} n - Integer power value.
- * @returns {number} -
- */
-export function pow2i(n) {
-    return 2 << (n - 1);
-}
-
-/**
- * Returns a slice of linear interpolation t * (h1 - h0)
- * @param {number} t - A value that linearly interpolates between the h0 parameter and the h1 parameter.
- * @param {number} h1 - End value.
- * @param {number} h0 - Start value.
- * @returns {number} -
- */
-export function slice(t, h1, h0) {
-    return t * (h1 - h0);
-}
-
-/**
- * Performs a linear interpolation.
- * @function
- * @param {number} t - A value that linearly interpolates between the h0 parameter and the h1 parameter.
- * @param {number} h1 - End value.
- * @param {number} h0 - Start value.
- * @returns {number} -
- */
-export function lerp(t, h1, h0) {
-    return h0 + t * (h1 - h0);
-}
-
-export function cube(f) {
-    return f * f * f;
-}
-
-export function square(f) {
-    return f * f;
-}
-
-export function bezier1v(t, p0, p1, p2, p3) {
-    return (
-        cube(1 - t) * p0 + 3 * square(1 - t) * t * p1 + 3 * (1 - t) * square(t) * p2 + cube(t) * p3
-    );
-}
-
-/**
- * Performs a 3D bezier interpolation.
- * @function
- * @param {number} t - Interpolation value.
- * @param {Vec3} p0 - First control point.
- * @param {Vec3} p1 - Second control point.
- * @param {Vec3} p2 - Third control point.
- * @param {Vec3} p3 - Fourth control point.
- * @returns {Vec3} -
- */
-export function bezier3v(t, p0, p1, p2, p3) {
-    var u = 1 - t;
-    var tt = t * t;
-    var uu = u * u;
-    var uuu = uu * u;
-    var ttt = tt * t;
-
-    return p0
-        .scaleTo(uuu)
-        .addA(p1.scaleTo(3 * uu * t))
-        .addA(p2.scaleTo(3 * u * tt))
-        .addA(p3.scaleTo(ttt));
-}
-
-/**
- * Clamp angle value within 360.
- * @function
- * @param {number} x - Input angle.
- * @returns {number} -
- */
-export function rev(x) {
-    return x - Math.floor(x / 360.0) * 360.0;
-}
-
-/**
- * Clamp longitude within: -180 to +180 degrees.
- * @function
- * @param {number} lon - Longitude.
- * @returns {number} -
- */
-export function norm_lon(lon) {
-    return lon > 180 ? ((lon + 180) % 360) - 180 : lon < -180 ? ((lon - 180) % 360) + 180 : lon;
-}
-
-/**
- * Returns an angle in the range -Pi <= angle <= Pi which is equivalent to the provided angle.
- * @function
- * @param {number} a - Angle in radians.
- * @returns {number} -
- */
-export function negativePItoPI(a) {
-    return zeroTwoPI(a + Math.PI) - Math.PI;
-}
-
-/**
- * Solve using iteration method and a fixed number of steps.
- * @function
- * @param {equationCallback} f - Equation. Used in Euler's equation(see og.orbit) solving.
- * @param {number} x0 - First approximation.
- * @param {number} maxIter - Maximum iterations.
- * @returns {number} -
- */
-export function solve_iteration_fixed(f, x0, maxIter) {
-    var x = 0;
-    var x2 = x0;
-    for (var i = 0; i < maxIter; i++) {
-        x = x2;
-        x2 = f(x);
-    }
-    return x2;
-}
-
-/**
- * Solve using iteration; terminate when error is below err or the maximum
- * number of iterations is reached. Used in Euler's equation(see og.orbit) solving.
- * @function
- * @param {equationCallback} f - Equation.
- * @param {number} x0 - First approximation.
- * @param {number} err - Maximal accepted error value.
- * @param {number} maxIter - Maximum iterations.
- * @returns {number} -
- */
-export function solve_iteration(f, x0, err, maxIter) {
-    maxIter = maxIter || 50;
-    var x = 0;
-    var x2 = x0;
-    for (var i = 0; i < maxIter; i++) {
-        x = x2;
-        x2 = f(x);
-        if (Math.abs(x2 - x) < err) {
-            return x2;
-        }
-    }
-    return x2;
-}
-
-/**
- * Equation function.
- * @callback equationCallback
- * @param {number} x - Equation variable.
- */
+/**
+ * @module og/math
+ */
+"use strict";
+
+/** @const */
+export const TWO_PI = 2.0 * Math.PI;
+
+/** @const */
+export const PI_TWO = Math.PI / 2.0;
+
+export const X = 0;
+export const Y = 1;
+export const Z = 2;
+export const W = 3;
+
+export const MAX_FLOAT = Number.MAX_VALUE || 1.7976931348623157e308;
+
+/** @const */
+export const LOG2 = Math.log(2);
+/** @const */
+export const MAX32 = 2147483647;
+/** @const */
+export const MAX = 549755748352;
+/** @const */
+export const MIN = -MAX;
+
+/** @const */
+export const RADIANS = Math.PI / 180.0;
+/** @const */
+export const DEGREES = 180.0 / Math.PI;
+
+/** @const */
+export const DEGREES_DOUBLE = 2.0 * DEGREES;
+/** @const */
+export const RADIANS_HALF = 0.5 * RADIANS;
+
+/** @const */
+export const ARCSECONDS_TO_RADIANS = 0.00000484813681109536;
+/** @const */
+export const RADIANS_TO_HOURS = 3.8197186342054880584532103209403;
+/** @const */
+export const HOURS_TO_RADIANS = 0.26179938779914943653855361527329;
+/** @const */
+export const HOURS_TO_DEGREES = 15.0;
+/** @const */
+export const DEGREES_TO_HOURS = 1.0 / 15.0;
+
+/** @const */
+export const SQRT_HALF = Math.sqrt(0.5);
+
+export const EPSILON1 = 0.1;
+export const EPSILON2 = 0.01;
+export const EPSILON3 = 0.001;
+export const EPSILON4 = 0.0001;
+export const EPSILON5 = 0.00001;
+export const EPSILON6 = 0.000001;
+export const EPSILON7 = 1e-7;
+export const EPSILON8 = 1e-8;
+export const EPSILON9 = 1e-9;
+export const EPSILON10 = 1e-10;
+export const EPSILON11 = 1e-11;
+export const EPSILON12 = 1e-12;
+export const EPSILON13 = 1e-13;
+export const EPSILON14 = 1e-14;
+export const EPSILON15 = 1e-15;
+export const EPSILON16 = 1e-16;
+export const EPSILON17 = 1e-17;
+export const EPSILON18 = 1e-18;
+export const EPSILON19 = 1e-19;
+export const EPSILON20 = 1e-20;
+
+/**
+ * The log function returns the power to which the base value has to be raised to produce n.
+ * @function
+ * @param {number} n - Produce value.
+ * @param {number} base - Base value.
+ * @returns {number} -
+ * @example
+ * log(64, 2)
+ * //returns 6
+ */
+export function log(n, base) {
+    return Math.log(n) / Math.log(base);
+}
+
+/**
+ * Clamp the number.
+ * @function
+ * @param {number} number - Input number.
+ * @param {number} min - Minimal edge.
+ * @param {number} max - Maximal edge.
+ * @returns {number} -
+ * @example
+ * clamp(12, 1, 5)
+ * //returns 5
+ */
+export function clamp(number, min, max) {
+    return Math.max(min, Math.min(number, max));
+}
+
+/**
+ * Converts degrees value to radians.
+ * @function
+ * @param {number} degrees - Degree value.
+ * @returns {number} -
+ */
+export function DEG2RAD(degrees) {
+    return degrees * RADIANS;
+}
+
+/**
+ * Converts radians value to degrees.
+ * @function
+ * @param {number} angle - Degree value.
+ * @returns {number} -
+ */
+export function RAD2DEG(angle) {
+    return angle * DEGREES;
+}
+
+/**
+ * Check the number is a power of two.
+ * @function
+ * @param {number} x - Input value.
+ * @returns {boolean} -
+ */
+export function isPowerOfTwo(x) {
+    return (x & (x - 1)) === 0;
+}
+
+/**
+ * Returns next value that is power of two.
+ * @function
+ * @param {number} x - Input value.
+ * @returns {number} -
+ */
+export function nextHighestPowerOfTwo(x) {
+    --x;
+    for (var i = 1; i < 32; i <<= 1) {
+        x = x | (x >> i);
+    }
+    return x + 1;
+}
+
+/**
+ * Returns random integer number within the bounds.
+ * @function
+ * @param {number} min - Minimal bound.
+ * @param {number} max - Maximal bound.
+ * @returns {number} -
+ */
+export function randomi(min = 0, max = 1) {
+    return Math.floor(Math.random() * (max - min)) + min;
+}
+
+/**
+ * Returns random number within the bounds.
+ * @function
+ * @param {number} [min=0] - Minimal bound.
+ * @param {number} [max=1] - Maximal bound.
+ * @returns {number} -
+ */
+export function random(min = 0, max = 1) {
+    return Math.random() * (max - min) + min;
+}
+
+/**
+ * Converts degrees value to decimal.
+ * @function
+ * @param {number} d - Degrees.
+ * @param {number} m - Minutes.
+ * @param {number} s - Seconds.
+ * @param {boolean} [p] - Positive flag. False - default.
+ * @returns {number} -
+ **/
+export function degToDec(d, m, s, p) {
+    if (p) {
+        return d + m / 60.0 + s / 3600.0;
+    } else {
+        return -d - m / 60.0 - s / 3600.0;
+    }
+}
+
+/**
+ * The modulo operation that also works for negative dividends.
+ * @function
+ * @param {number} m - The dividend.
+ * @param {number} n - The divisor.
+ * @returns {number} The remainder.
+ */
+export function mod(m, n) {
+    return ((m % n) + n) % n;
+}
+
+/**
+ * Returns an angle in the range 0 <= angle <= 2Pi which is equivalent to the provided angle.
+ * @function
+ * @param {number} a - Angle in radians
+ * @returns {number} -
+ */
+export function zeroTwoPI(a) {
+    var mod = mod(a, TWO_PI);
+    if (Math.abs(mod) < EPSILON14 && Math.abs(a) > EPSILON14) {
+        return TWO_PI;
+    }
+    return mod;
+}
+
+/**
+ * Returns 0.0 if x is smaller then edge and otherwise 1.0.
+ * @function
+ * @param {number} edge -
+ * @param {number} x - Value to edge.
+ * @returns {number} -
+ */
+export function step(edge, x) {
+    return x < edge ? 0.0 : 1.0;
+}
+
+/**
+ * The fract function returns the fractional part of x, i.e. x minus floor(x).
+ * @function
+ * @param {number} x - Input value.
+ * @returns {number} -
+ */
+export function frac(x) {
+    return x - Math.floor(x);
+}
+
+/**
+ * Returns Math.log(x) / Math.log(2)
+ * @function
+ * @param {number} x - Input value.
+ * @returns {number} -
+ */
+export function log2(x) {
+    return Math.log(x) / LOG2;
+}
+
+/**
+ * Returns two power of n.
+ * @function
+ * @param {number} n - Power value.
+ * @returns {number} -
+ */
+export function exp2(n) {
+    return Math.pow(2, n);
+}
+
+/**
+ * Returns two power of integer n.
+ * @function
+ * @param {number} n - Integer power value.
+ * @returns {number} -
+ */
+export function pow2i(n) {
+    return 2 << (n - 1);
+}
+
+/**
+ * Returns a slice of linear interpolation t * (h1 - h0)
+ * @param {number} t - A value that linearly interpolates between the h0 parameter and the h1 parameter.
+ * @param {number} h1 - End value.
+ * @param {number} h0 - Start value.
+ * @returns {number} -
+ */
+export function slice(t, h1, h0) {
+    return t * (h1 - h0);
+}
+
+/**
+ * Performs a linear interpolation.
+ * @function
+ * @param {number} t - A value that linearly interpolates between the h0 parameter and the h1 parameter.
+ * @param {number} h1 - End value.
+ * @param {number} h0 - Start value.
+ * @returns {number} -
+ */
+export function lerp(t, h1, h0) {
+    return h0 + t * (h1 - h0);
+}
+
+export function cube(f) {
+    return f * f * f;
+}
+
+export function square(f) {
+    return f * f;
+}
+
+export function bezier1v(t, p0, p1, p2, p3) {
+    return (
+        cube(1 - t) * p0 + 3 * square(1 - t) * t * p1 + 3 * (1 - t) * square(t) * p2 + cube(t) * p3
+    );
+}
+
+/**
+ * Performs a 3D bezier interpolation.
+ * @function
+ * @param {number} t - Interpolation value.
+ * @param {Vec3} p0 - First control point.
+ * @param {Vec3} p1 - Second control point.
+ * @param {Vec3} p2 - Third control point.
+ * @param {Vec3} p3 - Fourth control point.
+ * @returns {Vec3} -
+ */
+export function bezier3v(t, p0, p1, p2, p3) {
+    var u = 1 - t;
+    var tt = t * t;
+    var uu = u * u;
+    var uuu = uu * u;
+    var ttt = tt * t;
+
+    return p0
+        .scaleTo(uuu)
+        .addA(p1.scaleTo(3 * uu * t))
+        .addA(p2.scaleTo(3 * u * tt))
+        .addA(p3.scaleTo(ttt));
+}
+
+/**
+ * Clamp angle value within 360.
+ * @function
+ * @param {number} x - Input angle.
+ * @returns {number} -
+ */
+export function rev(x) {
+    return x - Math.floor(x / 360.0) * 360.0;
+}
+
+/**
+ * Clamp longitude within: -180 to +180 degrees.
+ * @function
+ * @param {number} lon - Longitude.
+ * @returns {number} -
+ */
+export function norm_lon(lon) {
+    return lon > 180 ? ((lon + 180) % 360) - 180 : lon < -180 ? ((lon - 180) % 360) + 180 : lon;
+}
+
+/**
+ * Returns an angle in the range -Pi <= angle <= Pi which is equivalent to the provided angle.
+ * @function
+ * @param {number} a - Angle in radians.
+ * @returns {number} -
+ */
+export function negativePItoPI(a) {
+    return zeroTwoPI(a + Math.PI) - Math.PI;
+}
+
+/**
+ * Solve using iteration method and a fixed number of steps.
+ * @function
+ * @param {equationCallback} f - Equation. Used in Euler's equation(see og.orbit) solving.
+ * @param {number} x0 - First approximation.
+ * @param {number} maxIter - Maximum iterations.
+ * @returns {number} -
+ */
+export function solve_iteration_fixed(f, x0, maxIter) {
+    var x = 0;
+    var x2 = x0;
+    for (var i = 0; i < maxIter; i++) {
+        x = x2;
+        x2 = f(x);
+    }
+    return x2;
+}
+
+/**
+ * Solve using iteration; terminate when error is below err or the maximum
+ * number of iterations is reached. Used in Euler's equation(see og.orbit) solving.
+ * @function
+ * @param {equationCallback} f - Equation.
+ * @param {number} x0 - First approximation.
+ * @param {number} err - Maximal accepted error value.
+ * @param {number} maxIter - Maximum iterations.
+ * @returns {number} -
+ */
+export function solve_iteration(f, x0, err, maxIter = 50) {
+    var x = 0;
+    var x2 = x0;
+    for (var i = 0; i < maxIter; i++) {
+        x = x2;
+        x2 = f(x);
+        if (Math.abs(x2 - x) < err) {
+            return x2;
+        }
+    }
+    return x2;
+}
+
+/**
+ * Equation function.
+ * @callback equationCallback
+ * @param {number} x - Equation variable.
+ */