toosoon-utils 1.1.0 → 1.3.0

package/lib/maths.d.ts

@@ -30,10 +30,10 @@ export declare function toPowerOf2(value: number, mode?: 'floor' | 'ceil' | 'rou
 /**
  * Return the sign (positive or negative) of a number
  *
- * @param {number} number Value to check
+ * @param {number} value Value to check
  * @returns {number} 1 if the given number is positive, -1 if it is negative, otherwise 0
  */
-export declare function sign(number: number): number;
+export declare function sign(value: number): number;
 /**
  * Clamp a value between two bounds
  *
@@ -65,12 +65,14 @@ export declare function triLerp(value: number, min: number, max: number, target:
 /**
  * Exponential interpolation between two values
  *
- * @param {number} value Normalized value to interpolate
- * @param {number} min   Minimum value
- * @param {number} max   Maximum value
+ * @param {number} value      Value to interpolate
+ * @param {number} currentMin Lower bound of the value's current range
+ * @param {number} currentMax Upper bound of the value's current range
+ * @param {number} targetMin  Lower bound of the value's target range
+ * @param {number} targetMax  Upper bound of the value's target range
  * @returns {number} Interpolated value
  */
-export declare function expLerp(value: number, min: number, max: number): number;
+export declare function expLerp(value: number, currentMin: number, currentMax: number, targetMin: number, targetMax: number): number;
 /**
  * Normalize a value between two bounds
  *
@@ -95,7 +97,7 @@ export declare function map(value: number, currentMin: number, currentMax: numbe
  * Round a number up to a nearest multiple
  *
  * @param {number} value        Value to round
- * @param {number} [multiple=1] Multiple
+ * @param {number} [multiple=1] Multiple to round to
  * @returns {number} Closest multiple
  */
 export declare function roundTo(value: number, multiple?: number): number;
@@ -136,14 +138,14 @@ export declare function parabola(x: number, power?: number): number;
 /**
  * Return the sum of numbers
  *
- * @param {number[]} array Array of number
+ * @param {number[]} array Array of numbers
  * @returns {number} Total sum
  */
 export declare function sum(array: number[]): number;
 /**
  * Return the average of numbers
  *
- * @param {number[]} array Array of number
+ * @param {number[]} array Array of numbers
  * @returns {number} Total average
  */
 export declare function average(array: number[]): number;

package/lib/maths.js

@@ -1,36 +1,30 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.damp = exports.average = exports.sum = exports.parabola = exports.smoothstep = exports.pingPong = exports.modAbs = exports.roundTo = exports.map = exports.normalize = exports.expLerp = exports.triLerp = exports.lerp = exports.clamp = exports.sign = exports.toPowerOf2 = exports.isPowerOf2 = exports.isOdd = exports.isEven = void 0;
 /**
  * Check if a number is even
  *
  * @param {number} value Value to check
  * @returns {boolean} True if the given number is even, false otherwise
  */
-function isEven(value) {
+export function isEven(value) {
     return !(value & 1);
 }
-exports.isEven = isEven;
 /**
  * Check if a number is odd
  *
  * @param {number} value Value to check
  * @returns {boolean} True if the given number is odd, false otherwise
  */
-function isOdd(value) {
+export function isOdd(value) {
     return !!(value & 1);
 }
-exports.isOdd = isOdd;
 /**
  * Check if a number is a power of 2
  *
  * @param {number} value Value to check
  * @returns {boolean} True if the given number is a power of 2, false otherwise
  */
-function isPowerOf2(value) {
+export function isPowerOf2(value) {
     return (value & (value - 1)) === 0;
 }
-exports.isPowerOf2 = isPowerOf2;
 /**
  * Find closest power of 2 that fits a number
  *
@@ -38,25 +32,23 @@ exports.isPowerOf2 = isPowerOf2;
  * @param {string} [mode='ceil'] Can be 'floor' | 'ceil' | 'round'
  * @returns {number} Power of 2
  */
-function toPowerOf2(value, mode) {
+export function toPowerOf2(value, mode) {
     if (mode === void 0) { mode = 'ceil'; }
     return Math.pow(2, Math[mode](Math.log(value) / Math.log(2)));
 }
-exports.toPowerOf2 = toPowerOf2;
 /**
  * Return the sign (positive or negative) of a number
  *
- * @param {number} number Value to check
+ * @param {number} value Value to check
  * @returns {number} 1 if the given number is positive, -1 if it is negative, otherwise 0
  */
-function sign(number) {
-    if (number > 0)
+export function sign(value) {
+    if (value > 0)
         return 1;
-    else if (number < 0)
+    else if (value < 0)
         return -1;
     return 0;
 }
-exports.sign = sign;
 /**
  * Clamp a value between two bounds
  *
@@ -65,12 +57,11 @@ exports.sign = sign;
  * @param {number} [max=1] Maximum boundary
  * @returns {number} Clamped value
  */
-function clamp(value, min, max) {
+export function clamp(value, min, max) {
     if (min === void 0) { min = 0; }
     if (max === void 0) { max = 1; }
     return Math.min(max, Math.max(min, value));
 }
-exports.clamp = clamp;
 /**
  * Linear interpolation between two values (lerping)
  *
@@ -79,10 +70,9 @@ exports.clamp = clamp;
  * @param {number} max   Maximum value
  * @returns {number} Lerped value
  */
-function lerp(value, min, max) {
+export function lerp(value, min, max) {
     return min + (max - min) * value;
 }
-exports.lerp = lerp;
 /**
  * Triangular interpolation between two values
  *
@@ -92,23 +82,24 @@ exports.lerp = lerp;
  * @param {number} target Triangle target value
  * @returns {number} Interpolated value
  */
-function triLerp(value, min, max, target) {
+export function triLerp(value, min, max, target) {
     var x = Math.pow(1 + Math.abs(target - max) / Math.abs(target - min), -1);
     return value <= x ? min - (min - target) * (value / x) : target - (target - max) * ((value - x) / (1 - x));
 }
-exports.triLerp = triLerp;
 /**
  * Exponential interpolation between two values
  *
- * @param {number} value Normalized value to interpolate
- * @param {number} min   Minimum value
- * @param {number} max   Maximum value
+ * @param {number} value      Value to interpolate
+ * @param {number} currentMin Lower bound of the value's current range
+ * @param {number} currentMax Upper bound of the value's current range
+ * @param {number} targetMin  Lower bound of the value's target range
+ * @param {number} targetMax  Upper bound of the value's target range
  * @returns {number} Interpolated value
  */
-function expLerp(value, min, max) {
-    return Math.pow(min, 1 - value) * Math.pow(max, value);
+export function expLerp(value, currentMin, currentMax, targetMin, targetMax) {
+    return (targetMin *
+        Math.pow(targetMax / targetMin, (clamp(value, currentMin, currentMax) - currentMin) / (currentMax - currentMin)));
 }
-exports.expLerp = expLerp;
 /**
  * Normalize a value between two bounds
  *
@@ -117,10 +108,9 @@ exports.expLerp = expLerp;
  * @param {number} max   Maximum boundary
  * @returns {number} Normalized value
  */
-function normalize(value, min, max) {
+export function normalize(value, min, max) {
     return (value - min) / (max - min);
 }
-exports.normalize = normalize;
 /**
  * Re-map a number from one range to another
  *
@@ -131,24 +121,22 @@ exports.normalize = normalize;
  * @param {number} targetMax  Upper bound of the value's target range
  * @returns {number} Re-mapped value
  */
-function map(value, currentMin, currentMax, targetMin, targetMax) {
+export function map(value, currentMin, currentMax, targetMin, targetMax) {
     return ((value - currentMin) / (currentMax - currentMin)) * (targetMax - targetMin) + targetMin;
 }
-exports.map = map;
 /**
  * Round a number up to a nearest multiple
  *
  * @param {number} value        Value to round
- * @param {number} [multiple=1] Multiple
+ * @param {number} [multiple=1] Multiple to round to
  * @returns {number} Closest multiple
  */
-function roundTo(value, multiple) {
+export function roundTo(value, multiple) {
     if (multiple === void 0) { multiple = 1; }
     if (multiple === 0)
         return value;
     return Math.round(value / multiple) * multiple;
 }
-exports.roundTo = roundTo;
 /**
  * Modulo absolute a value based on a length
  *
@@ -156,13 +144,12 @@ exports.roundTo = roundTo;
  * @param {number} length Total length
  * @returns {number} Modulated value
  */
-function modAbs(value, length) {
+export function modAbs(value, length) {
     if (value < 0) {
         return length + (value % length);
     }
     return value % length;
 }
-exports.modAbs = modAbs;
 /**
  * Move back and forth a value between 0 and length, so that it is never larger than length and never smaller than 0
  *
@@ -170,11 +157,10 @@ exports.modAbs = modAbs;
  * @param {number} length Total length
  * @returns {number} PingPonged value
  */
-function pingPong(value, length) {
+export function pingPong(value, length) {
     value = modAbs(value, length * 2);
     return length - Math.abs(value - length);
 }
-exports.pingPong = pingPong;
 /**
  * Smooth a value using cubic Hermite interpolation
  *
@@ -183,13 +169,12 @@ exports.pingPong = pingPong;
  * @param {number} [max=1] Maximum boundary
  * @returns {number} Normalized smoothed value
  */
-function smoothstep(value, min, max) {
+export function smoothstep(value, min, max) {
     if (min === void 0) { min = 0; }
     if (max === void 0) { max = 1; }
     var x = clamp(normalize(value, min, max));
     return x * x * (3 - 2 * x);
 }
-exports.smoothstep = smoothstep;
 /**
  * Re-map the [0, 1] interval into [0, 1] parabola, such that corners are remaped to 0 and the center to 1
  * -> parabola(0) = parabola(1) = 0, and parabola(0.5) = 1
@@ -198,31 +183,28 @@ exports.smoothstep = smoothstep;
  * @param {number} [power=1] Parabola power
  * @returns {number} Normalized re-mapped value
  */
-function parabola(x, power) {
+export function parabola(x, power) {
     if (power === void 0) { power = 1; }
     return Math.pow(4 * x * (1 - x), power);
 }
-exports.parabola = parabola;
 /**
  * Return the sum of numbers
  *
- * @param {number[]} array Array of number
+ * @param {number[]} array Array of numbers
  * @returns {number} Total sum
  */
-function sum(array) {
+export function sum(array) {
     return array.reduce(function (previous, current) { return previous + current; });
 }
-exports.sum = sum;
 /**
  * Return the average of numbers
  *
- * @param {number[]} array Array of number
+ * @param {number[]} array Array of numbers
  * @returns {number} Total average
  */
-function average(array) {
+export function average(array) {
     return sum(array) / array.length;
 }
-exports.average = average;
 /**
  * Smoothly interpolate a number toward another
  *
@@ -232,7 +214,6 @@ exports.average = average;
  * @param {number} delta   Delta time (in seconds)
  * @returns {number} Interpolated number
  */
-function damp(value, target, damping, delta) {
+export function damp(value, target, damping, delta) {
     return lerp(1 - Math.exp(-damping * delta), value, target);
 }
-exports.damp = damp;

package/lib/prng.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Produce a 128-bit hash value from a seed
+ *
+ * @param {string} seed Initial seed state
+ * @returns {[number, number, number, number]} Hash numbers
+ */
+export declare function cyrb128(seed: string): [number, number, number, number];
+/**
+ * Simple Fast Counter, Generator with a 128-bit state
+ *
+ * @param {number} a
+ * @param {number} b
+ * @param {number} c
+ * @param {number} d
+ * @returns {number} Pseudo-random number
+ */
+export declare function sfc32(a: number, b: number, c: number, d: number): number;
+/**
+ * SplitMix32, Generator with a 32-bit state
+ *
+ * @param {number} a
+ * @returns {number} Pseudo-random number
+ */
+export declare function splitmix32(a: number): number;
+/**
+ * Mulberry32, Generator with a 32-bit state
+ *
+ * @param {number} a
+ * @returns {number} Pseudo-random number
+ */
+export declare function mulberry32(a: number): number;
+/**
+ * Jenkins' Small Fast, Generator with a 32-bit state
+ *
+ * @param {number} a
+ * @returns {number} Pseudo-random number
+ */
+export declare function jsf32(a: number, b: number, c: number, d: number): number;
+/**
+ * xoshiro128**, Generator with a 128-bit state
+ *
+ * @param {number} a
+ * @returns {number} Pseudo-random number
+ */
+export declare function xoshiro128ss(a: number, b: number, c: number, d: number): number;

package/lib/prng.js

@@ -0,0 +1,113 @@
+/**
+ * Produce a 128-bit hash value from a seed
+ *
+ * @param {string} seed Initial seed state
+ * @returns {[number, number, number, number]} Hash numbers
+ */
+export function cyrb128(seed) {
+    var h1 = 1779033703;
+    var h2 = 3144134277;
+    var h3 = 1013904242;
+    var h4 = 2773480762;
+    for (var i = 0, k = void 0; i < seed.length; i++) {
+        k = seed.charCodeAt(i);
+        h1 = h2 ^ Math.imul(h1 ^ k, 597399067);
+        h2 = h3 ^ Math.imul(h2 ^ k, 2869860233);
+        h3 = h4 ^ Math.imul(h3 ^ k, 951274213);
+        h4 = h1 ^ Math.imul(h4 ^ k, 2716044179);
+    }
+    h1 = Math.imul(h3 ^ (h1 >>> 18), 597399067);
+    h2 = Math.imul(h4 ^ (h2 >>> 22), 2869860233);
+    h3 = Math.imul(h1 ^ (h3 >>> 17), 951274213);
+    h4 = Math.imul(h2 ^ (h4 >>> 19), 2716044179);
+    return [(h1 ^ h2 ^ h3 ^ h4) >>> 0, (h2 ^ h1) >>> 0, (h3 ^ h1) >>> 0, (h4 ^ h1) >>> 0];
+}
+// *********************
+// PRNG Algorithms
+// *********************
+/**
+ * Simple Fast Counter, Generator with a 128-bit state
+ *
+ * @param {number} a
+ * @param {number} b
+ * @param {number} c
+ * @param {number} d
+ * @returns {number} Pseudo-random number
+ */
+export function sfc32(a, b, c, d) {
+    a >>>= 0;
+    b >>>= 0;
+    c >>>= 0;
+    d >>>= 0;
+    var t = (a + b) | 0;
+    a = b ^ (b >>> 9);
+    b = (c + (c << 3)) | 0;
+    c = (c << 21) | (c >>> 11);
+    d = (d + 1) | 0;
+    t = (t + d) | 0;
+    c = (c + t) | 0;
+    return (t >>> 0) / 4294967296;
+}
+/**
+ * SplitMix32, Generator with a 32-bit state
+ *
+ * @param {number} a
+ * @returns {number} Pseudo-random number
+ */
+export function splitmix32(a) {
+    a |= 0;
+    a = (a + 0x9e3779b9) | 0;
+    var t = a ^ (a >>> 16);
+    t = Math.imul(t, 0x21f0aaad);
+    t = t ^ (t >>> 15);
+    t = Math.imul(t, 0x735a2d97);
+    return ((t = t ^ (t >>> 15)) >>> 0) / 4294967296;
+}
+/**
+ * Mulberry32, Generator with a 32-bit state
+ *
+ * @param {number} a
+ * @returns {number} Pseudo-random number
+ */
+export function mulberry32(a) {
+    var t = (a += 0x6d2b79f5);
+    t = Math.imul(t ^ (t >>> 15), t | 1);
+    t ^= t + Math.imul(t ^ (t >>> 7), t | 61);
+    return ((t ^ (t >>> 14)) >>> 0) / 4294967296;
+}
+/**
+ * Jenkins' Small Fast, Generator with a 32-bit state
+ *
+ * @param {number} a
+ * @returns {number} Pseudo-random number
+ */
+export function jsf32(a, b, c, d) {
+    a |= 0;
+    b |= 0;
+    c |= 0;
+    d |= 0;
+    var t = (a - ((b << 27) | (b >>> 5))) | 0;
+    a = b ^ ((c << 17) | (c >>> 15));
+    b = (c + d) | 0;
+    c = (d + t) | 0;
+    d = (a + t) | 0;
+    return (d >>> 0) / 4294967296;
+}
+/**
+ * xoshiro128**, Generator with a 128-bit state
+ *
+ * @param {number} a
+ * @returns {number} Pseudo-random number
+ */
+export function xoshiro128ss(a, b, c, d) {
+    var t = b << 9;
+    var r = a * 5;
+    r = ((r << 7) | (r >>> 25)) * 9;
+    c ^= a;
+    d ^= b;
+    b ^= c;
+    a ^= d;
+    c ^= t;
+    d = (d << 11) | (d >>> 21);
+    return (r >>> 0) / 4294967296;
+}

package/lib/random.d.ts

@@ -1,9 +1,9 @@
 import { Vector2, Vector3 } from './types';
 /**
- * Generate a random boolean (true or false)
+ * Generate a random boolean (`true` or `false`)
  *
- * @param {number} [probability=0.5] Probability to get true
- * @returns {boolean} Either true or false
+ * @param {number} [probability=0.5] Probability to get `true`
+ * @returns {boolean} Either `true` or `false`
  */
 export declare function randomBoolean(probability?: number): boolean;
 /**
@@ -14,16 +14,16 @@ export declare function randomBoolean(probability?: number): boolean;
  */
 export declare function randomSign(probability?: number): number;
 /**
- * Generate a random float number
+ * Generate a random floating-point number within a specified range
  *
- * @param  {number} [min=0]       Minimum boundary
- * @param  {number} [max=1]       Maximum boundary
- * @param  {number} [precision=2] Number of digits after the decimal point
+ * @param {number} [min=0]       Minimum boundary
+ * @param {number} [max=1]       Maximum boundary
+ * @param {number} [precision=2] Number of digits after the decimal point
  * @returns {number} Generated float
  */
 export declare function randomFloat(min?: number, max?: number, precision?: number): number;
 /**
- * Generate a random integer number
+ * Generate a random integer number within a specified range
  *
  * @param {number} min Minimum boundary
  * @param {number} max Maximum boundary
@@ -33,61 +33,61 @@ export declare function randomInt(min: number, max: number): number;
 /**
  * Generate a random hexadecimal color
  *
- * @returns {string} Hexadecimal color
+ * @returns {string} Generated hexadecimal color
  */
 export declare function randomHexColor(): string;
 /**
- * Pick a random item from an array
+ * Pick a random item from a given array
  *
- * @param {T[]} [array=[]] Array to pick the item from
+ * @param {T[]} array Array to pick the item from
  * @returns {T|undefined} Random item picked
  */
-export declare function randomItem<T = unknown>(array?: T[]): T | undefined;
+export declare function randomItem<T = unknown>(array: T[]): T | undefined;
 /**
- * Pick a random property from an object
+ * Pick a random property value from a given object
  *
  * @param {object} object Object to pick the property from
- * @returns {unknown|undefined} Random item picked
+ * @returns {T|undefined} Random item picked
  */
 export declare function randomObjectProperty<T = unknown>(object: {
     [key: string]: T;
 }): T | undefined;
 /**
- * Return a random index from an array of weights
+ * Select a random index from an array of weighted items
  *
  * @param {number[]} weights Array of weights
  * @returns {number} Random index based on weights
  */
-export declare function randomIndex(weights?: number[]): number;
+export declare function randomIndex(weights: number[]): number;
 /**
  * Produce a random 2D point around the perimiter of a unit circle
  *
- * @param  {number} [radius=1] Radius of the circle
- * @param  {Vector2} target    Target vector
+ * @param  {number} [radius=1]        Radius of the circle
+ * @param  {Vector2} [target] Target vector
  * @returns {Vector2} Random 2D point on circle
  */
 export declare function onCircle(radius?: number, target?: Vector2): Vector2;
 /**
  * Produce a random 2D point inside a unit circle
  *
- * @param  {number} [radius=1] Radius of the circle
- * @param  {Vector2} target    Target vector
+ * @param  {number} [radius=1]        Radius of the circle
+ * @param  {Vector2} [target] Target vector
  * @returns {Vector2} Random 2D point inside circle
  */
 export declare function insideCircle(radius?: number, target?: Vector2): Vector2;
 /**
  * Produce a random 3D point on the surface of a unit sphere
  *
- * @param  {number} [radius=1] Radius of the sphere
- * @param  {Vector3} target    Target vector
+ * @param  {number} [radius=1]        Radius of the sphere
+ * @param  {Vector3} [target] Target vector
  * @returns {Vector3} Random 3D point on sphere
  */
 export declare function onSphere(radius?: number, target?: Vector3): Vector3;
 /**
  * Produce a random 3D point inside a unit sphere
  *
- * @param  {number} [radius=1] Radius of the sphere
- * @param  {Vector3} target    Target vector
+ * @param  {number} [radius=1]        Radius of the sphere
+ * @param  {Vector3} [target] Target vector
  * @returns {Vector3} Random 3D point inside sphere
  */
 export declare function insideSphere(radius?: number, target?: Vector3): Vector3;