Variable MathUtils`Const`

MathUtils: {
    abs(value): number;
    angle(x1, y1, x2, y2): number;
    average(numbers): number;
    acos(value): number;
    acosh(value): number;
    asin(value): number;
    asinh(value): number;
    atan(value): number;
    atan2(y, x): number;
    atanh(value): number;
    ceil(value): number;
    clamp(value, min, max): number;
    cos(angle): number;
    cosh(value): number;
    cbrt(value): number;
    distance(x1, y1, x2, y2): number;
    isEven(value): boolean;
    fibonacci(n): number;
    factorial(n): number;
    floor(value): number;
    gcd(a, b): number;
    iqr(numbers): number;
    isInteger(value): boolean;
    isInRange(value, min, max, inclusive?): boolean;
    isOdd(value): boolean;
    isPrime(n): boolean;
    lcm(a, b): number;
    lerp(start, end, t): number;
    log(value): number;
    log10(value): number;
    log2(value): number;
    map(value, inMin, inMax, outMin, outMax): number;
    max(numbers): number;
    median(numbers): number;
    min(numbers): number;
    mode(numbers): number[];
    percentile(numbers, value): number;
    product(numbers): number;
    pow(base, exponent): number;
    quartiles(numbers): {
        q1: number;
        q2: number;
        q3: number;
    };
    random(min, max): number;
    randomInt(min, max): number;
    range(numbers): number;
    round(value, decimals): number;
    sign(value): number;
    sin(angle): number;
    sinh(value): number;
    sqrt(value): number;
    standardDeviation(numbers): number;
    sum(numbers): number;
    tan(angle): number;
    tanh(value): number;
    toRadians(degrees): number;
    toDegrees(radians): number;
    variance(numbers): number;
} = ...

Type declaration

abs:function
- abs(value): number
- Calculates the absolute value of a number
  Parameters
  - value: number
    Number to calculate absolute value for
  Returns number
  Absolute value
  Example
```
MathUtils.abs(-5); // 5
MathUtils.abs(5); // 5
```
  - Defined in MathUtils.ts:33
angle:function
- angle(x1, y1, x2, y2): number
- Calculates the angle between two points in radians
  Parameters
  - x1: number
    First point x coordinate
  - y1: number
    First point y coordinate
  - x2: number
    Second point x coordinate
  - y2: number
    Second point y coordinate
  Returns number
  Angle in radians
  Example
```
// Calculate angle between points (0,0) and (1,1)
const angle = MathUtils.angle(0, 0, 1, 1); // π/4 radians
```
  - Defined in MathUtils.ts:50
average:function
- average(numbers): number
- Calculates the average (arithmetic mean) of an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number
  Average value
  Throws
  If array is empty
  
  Example
```
MathUtils.average([1, 2, 3, 4, 5]); // 3
MathUtils.average([10, 20, 30]); // 20
```
  - Defined in MathUtils.ts:65
acos:function
- acos(value): number
- Calculates the inverse cosine (arccos) of a number
  Parameters
  - value: number
    Number to calculate inverse cosine for (-1 to 1)
  Returns number
  Inverse cosine in radians
  Example
```
MathUtils.acos(0); // π/2 radians
MathUtils.acos(1); // 0 radians
```
  - Defined in MathUtils.ts:82
acosh:function
- acosh(value): number
- Calculates the inverse hyperbolic cosine of a number
  Parameters
  - value: number
    Number to calculate inverse hyperbolic cosine for (≥ 1)
  Returns number
  Inverse hyperbolic cosine
  Example
```
MathUtils.acosh(1); // 0
MathUtils.acosh(2); // 1.3169...
```
  - Defined in MathUtils.ts:96
asin:function
- asin(value): number
- Calculates the inverse sine (arcsin) of a number
  Parameters
  - value: number
    Number to calculate inverse sine for (-1 to 1)
  Returns number
  Inverse sine in radians
  Example
```
MathUtils.asin(0); // 0 radians
MathUtils.asin(1); // π/2 radians
```
  - Defined in MathUtils.ts:110
asinh:function
- asinh(value): number
- Calculates the inverse hyperbolic sine of a number
  Parameters
  - value: number
    Number to calculate inverse hyperbolic sine for
  Returns number
  Inverse hyperbolic sine
  Example
```
MathUtils.asinh(0); // 0
MathUtils.asinh(1); // 0.8813...
```
  - Defined in MathUtils.ts:124
atan:function
- atan(value): number
- Calculates the inverse tangent (arctan) of a number
  Parameters
  - value: number
    Number to calculate inverse tangent for
  Returns number
  Inverse tangent in radians
  Example
```
MathUtils.atan(0); // 0 radians
MathUtils.atan(1); // π/4 radians
```
  - Defined in MathUtils.ts:138
atan2:function
- atan2(y, x): number
- Calculates the inverse tangent of y/x
  Parameters
  - y: number
    Y coordinate
  - x: number
    X coordinate
  Returns number
  Inverse tangent in radians
  Example
```
MathUtils.atan2(1, 1); // π/4 radians
MathUtils.atan2(1, 0); // π/2 radians
```
  - Defined in MathUtils.ts:153
atanh:function
- atanh(value): number
- Calculates the inverse hyperbolic tangent of a number
  Parameters
  - value: number
    Number to calculate inverse hyperbolic tangent for (-1 to 1)
  Returns number
  Inverse hyperbolic tangent
  Example
```
MathUtils.atanh(0); // 0
MathUtils.atanh(0.5); // 0.5493...
```
  - Defined in MathUtils.ts:167
ceil:function
- ceil(value): number
- Rounds a number up to the nearest integer
  Parameters
  - value: number
    Number to round up
  Returns number
  Rounded number
  Example
```
MathUtils.ceil(3.14); // 4
MathUtils.ceil(-3.14); // -3
```
  - Defined in MathUtils.ts:181
clamp:function
- clamp(value, min, max): number
- Clamps a number between a minimum and maximum value
  Parameters
  - value: number
    Number to clamp
  - min: number
    Minimum value
  - max: number
    Maximum value
  Returns number
  Clamped number
  Example
```
MathUtils.clamp(10, 0, 5); // 5
MathUtils.clamp(-10, 0, 5); // 0
MathUtils.clamp(3, 0, 5); // 3
```
  - Defined in MathUtils.ts:198
cos:function
- cos(angle): number
- Calculates the cosine of an angle
  Parameters
  - angle: number
    Angle in radians
  Returns number
  Cosine value
  Example
```
MathUtils.cos(0); // 1
MathUtils.cos(Math.PI); // -1
```
  - Defined in MathUtils.ts:212
cosh:function
- cosh(value): number
- Calculates the hyperbolic cosine of a number
  Parameters
  - value: number
    Number to calculate hyperbolic cosine for
  Returns number
  Hyperbolic cosine
  Example
```
MathUtils.cosh(0); // 1
MathUtils.cosh(1); // 1.5430...
```
  - Defined in MathUtils.ts:226
cbrt:function
- cbrt(value): number
- Calculates the cube root of a number
  Parameters
  - value: number
    Number to calculate cube root for
  Returns number
  Cube root
  Example
```
MathUtils.cbrt(8); // 2
MathUtils.cbrt(-8); // -2
```
  - Defined in MathUtils.ts:240
distance:function
- distance(x1, y1, x2, y2): number
- Calculates the Euclidean distance between two points
  Parameters
  - x1: number
    First point x coordinate
  - y1: number
    First point y coordinate
  - x2: number
    Second point x coordinate
  - y2: number
    Second point y coordinate
  Returns number
  Distance between points
  Example
```
MathUtils.distance(0, 0, 3, 4); // 5
MathUtils.distance(1, 1, 4, 5); // 5
```
  - Defined in MathUtils.ts:257
isEven:function
- isEven(value): boolean
- Checks if a number is even
  Parameters
  - value: number
    Number to check
  Returns boolean
  True if even, false otherwise
  Example
```
MathUtils.isEven(2); // true
MathUtils.isEven(3); // false
```
  - Defined in MathUtils.ts:271
fibonacci:function
- fibonacci(n): number
- Calculates the nth Fibonacci number
  Parameters
  - n: number
    Position in Fibonacci sequence (0-based)
  Returns number
  Fibonacci number
  Example
```
MathUtils.fibonacci(0); // 0
MathUtils.fibonacci(1); // 1
MathUtils.fibonacci(10); // 55
```
  - Defined in MathUtils.ts:286
factorial:function
- factorial(n): number
- Calculates the factorial of a number
  Parameters
  - n: number
    Number to calculate factorial for
  Returns number
  Factorial result
  Example
```
MathUtils.factorial(0); // 1
MathUtils.factorial(5); // 120
```
  - Defined in MathUtils.ts:308
floor:function
- floor(value): number
- Rounds a number down to the nearest integer
  Parameters
  - value: number
    Number to round down
  Returns number
  Rounded number
  Example
```
MathUtils.floor(3.14); // 3
MathUtils.floor(-3.14); // -4
```
  - Defined in MathUtils.ts:324
gcd:function
- gcd(a, b): number
- Calculates the greatest common divisor of two numbers
  Parameters
  - a: number
    First number
  - b: number
    Second number
  Returns number
  Greatest common divisor
  Example
```
MathUtils.gcd(12, 18); // 6
MathUtils.gcd(7, 13); // 1
```
  - Defined in MathUtils.ts:339
iqr:function
- iqr(numbers): number
- Calculates the interquartile range of an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number
  Interquartile range
  Example
```
MathUtils.iqr([1, 2, 3, 4, 5, 6, 7, 8]); // 4
```
  - Defined in MathUtils.ts:352
isInteger:function
- isInteger(value): boolean
- Checks if a number is an integer
  Parameters
  - value: number
    Number to check
  Returns boolean
  True if integer, false otherwise
  Example
```
MathUtils.isInteger(5); // true
MathUtils.isInteger(5.1); // false
```
  - Defined in MathUtils.ts:367
isInRange:function
- isInRange(value, min, max, inclusive?): boolean
- Checks if a number is within a range
  Parameters
  - value: number
    Number to check
  - min: number
    Minimum value
  - max: number
    Maximum value
  - inclusive: boolean = true
    Whether to include min and max values
  Returns boolean
  True if in range, false otherwise
  Example
```
MathUtils.isInRange(5, 0, 10); // true
MathUtils.isInRange(5, 0, 5, true); // true
MathUtils.isInRange(5, 0, 5, false); // false
```
  - Defined in MathUtils.ts:385
isOdd:function
- isOdd(value): boolean
- Checks if a number is odd
  Parameters
  - value: number
    Number to check
  Returns boolean
  True if odd, false otherwise
  Example
```
MathUtils.isOdd(3); // true
MathUtils.isOdd(4); // false
```
  - Defined in MathUtils.ts:406
isPrime:function
- isPrime(n): boolean
- Checks if a number is prime
  Parameters
  - n: number
    Number to check
  Returns boolean
  True if prime, false otherwise
  Example
```
MathUtils.isPrime(2); // true
MathUtils.isPrime(4); // false
MathUtils.isPrime(17); // true
```
  - Defined in MathUtils.ts:421
lcm:function
- lcm(a, b): number
- Calculates the least common multiple of two numbers
  Parameters
  - a: number
    First number
  - b: number
    Second number
  Returns number
  Least common multiple
  Example
```
MathUtils.lcm(12, 18); // 36
MathUtils.lcm(5, 7); // 35
```
  - Defined in MathUtils.ts:443
lerp:function
- lerp(start, end, t): number
- Linear interpolation between two numbers
  Parameters
  - start: number
    Start value
  - end: number
    End value
  - t: number
    Interpolation factor (0-1)
  Returns number
  Interpolated value
  Example
```
MathUtils.lerp(0, 100, 0.5); // 50
MathUtils.lerp(0, 100, 0.25); // 25
```
  - Defined in MathUtils.ts:459
log:function
- log(value): number
- Calculates the natural logarithm of a number
  Parameters
  - value: number
    Number to calculate logarithm for
  Returns number
  Natural logarithm
  Example
```
MathUtils.log(Math.E); // 1
MathUtils.log(10); // 2.3025...
```
  - Defined in MathUtils.ts:473
log10:function
- log10(value): number
- Calculates the base-10 logarithm of a number
  Parameters
  - value: number
    Number to calculate logarithm for
  Returns number
  Base-10 logarithm
  Example
```
MathUtils.log10(100); // 2
MathUtils.log10(1000); // 3
```
  - Defined in MathUtils.ts:487
log2:function
- log2(value): number
- Calculates the base-2 logarithm of a number
  Parameters
  - value: number
    Number to calculate logarithm for
  Returns number
  Base-2 logarithm
  Example
```
MathUtils.log2(8); // 3
MathUtils.log2(16); // 4
```
  - Defined in MathUtils.ts:501
map:function
- map(value, inMin, inMax, outMin, outMax): number
- Maps a number from one range to another
  Parameters
  - value: number
    Number to map
  - inMin: number
    Input range minimum
  - inMax: number
    Input range maximum
  - outMin: number
    Output range minimum
  - outMax: number
    Output range maximum
  Returns number
  Mapped number
  Example
```
// Map a value from 0-100 range to 0-255 range
MathUtils.map(50, 0, 100, 0, 255); // 127.5

// Map a percentage to a color value
MathUtils.map(0.75, 0, 1, 0, 255); // 191.25
```
  - Defined in MathUtils.ts:522
max:function
- max(numbers): number
- Finds the maximum value in an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number
  Maximum value
  Throws
  If array is empty
  
  Example
```
MathUtils.max([1, 2, 3, 4, 5]); // 5
MathUtils.max([-1, -2, -3]); // -1
MathUtils.max([0, 0, 0]); // 0
```
  - Defined in MathUtils.ts:544
median:function
- median(numbers): number
- Calculates the median of an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number
  Median value
  Throws
  If array is empty
  
  Example
```
// Odd number of elements
MathUtils.median([1, 2, 3, 4, 5]); // 3

// Even number of elements (average of middle two)
MathUtils.median([1, 2, 3, 4]); // 2.5
```
  - Defined in MathUtils.ts:565
min:function
- min(numbers): number
- Finds the minimum value in an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number
  Minimum value
  Throws
  If array is empty
  
  Example
```
MathUtils.min([1, 2, 3, 4, 5]); // 1
MathUtils.min([-1, -2, -3]); // -3
MathUtils.min([0, 0, 0]); // 0
```
  - Defined in MathUtils.ts:590
mode:function
- mode(numbers): number[]
- Calculates the mode(s) of an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number[]
  Array of mode values (most frequently occurring numbers)
  Example
```
// Single mode
MathUtils.mode([1, 2, 2, 3, 3, 3]); // [3]

// Multiple modes
MathUtils.mode([1, 1, 2, 2]); // [1, 2]

// All numbers appear once
MathUtils.mode([1, 2, 3]); // [1, 2, 3]
```
  - Defined in MathUtils.ts:613
percentile:function
- percentile(numbers, value): number
- Calculates the percentile of a value in an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  - value: number
    Value to find percentile for
  Returns number
  Percentile (0-100)
  Example
```
const scores = [1, 2, 3, 4, 5];
MathUtils.percentile(scores, 3); // 40
MathUtils.percentile(scores, 5); // 100
MathUtils.percentile(scores, 1); // 0
```
  - Defined in MathUtils.ts:641
product:function
- product(numbers): number
- Calculates the product of an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number
  Product
  Example
```
MathUtils.product([1, 2, 3, 4]); // 24
MathUtils.product([2, 3, 4]); // 24
MathUtils.product([-1, -2, -3]); // -6
```
  - Defined in MathUtils.ts:658
pow:function
- pow(base, exponent): number
- Calculates a number raised to a power
  Parameters
  - base: number
    Base number
  - exponent: number
    Exponent
  Returns number
  Result
  Example
```
MathUtils.pow(2, 3); // 8
MathUtils.pow(5, 2); // 25
MathUtils.pow(2, -1); // 0.5
```
  - Defined in MathUtils.ts:674
quartiles:function
- quartiles(numbers): {
      q1: number;
      q2: number;
      q3: number;
  }
- Calculates the quartiles of an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns {
      q1: number;
      q2: number;
      q3: number;
  }
  Object containing quartiles (q1, q2, q3)
  - q1: number
  - q2: number
  - q3: number
  Example
```
const { q1, q2, q3 } = MathUtils.quartiles([1, 2, 3, 4, 5, 6, 7, 8]);
// q1 = 2.5 (25th percentile)
// q2 = 4.5 (50th percentile/median)
// q3 = 6.5 (75th percentile)
```
  - Defined in MathUtils.ts:690
random:function
- random(min, max): number
- Generates a random number between min and max (inclusive)
  Parameters
  - min: number
    Minimum value
  - max: number
    Maximum value
  Returns number
  Random number
  Example
```
// Random number between 0 and 1
MathUtils.random(0, 1); // e.g., 0.2345

// Random number between -10 and 10
MathUtils.random(-10, 10); // e.g., 3.4567
```
  - Defined in MathUtils.ts:717
randomInt:function
- randomInt(min, max): number
- Generates a random integer between min and max (inclusive)
  Parameters
  - min: number
    Minimum value
  - max: number
    Maximum value
  Returns number
  Random integer
  Example
```
// Random integer between 1 and 6 (dice roll)
MathUtils.randomInt(1, 6); // e.g., 4

// Random integer between 0 and 100
MathUtils.randomInt(0, 100); // e.g., 42
```
  - Defined in MathUtils.ts:735
range:function
- range(numbers): number
- Calculates the range of an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number
  Range (difference between max and min)
  Example
```
MathUtils.range([1, 2, 3, 4, 5]); // 4
MathUtils.range([-1, 0, 1]); // 2
MathUtils.range([5, 5, 5]); // 0
```
  - Defined in MathUtils.ts:750
round:function
- round(value, decimals): number
- Rounds a number to a specified number of decimal places
  Parameters
  - value: number
    Number to round
  - decimals: number
    Number of decimal places
  Returns number
  Rounded number
  Example
```
MathUtils.round(3.14159, 2); // 3.14
MathUtils.round(3.14159, 3); // 3.142
MathUtils.round(3.14159, 0); // 3
```
  - Defined in MathUtils.ts:766
sign:function
- sign(value): number
- Calculates the sign of a number
  Parameters
  - value: number
    Number to calculate sign for
  Returns number
  Sign (-1 for negative, 0 for zero, 1 for positive)
  Example
```
MathUtils.sign(-5); // -1
MathUtils.sign(0); // 0
MathUtils.sign(5); // 1
```
  - Defined in MathUtils.ts:782
sin:function
- sin(angle): number
- Calculates the sine of an angle
  Parameters
  - angle: number
    Angle in radians
  Returns number
  Sine value (-1 to 1)
  Example
```
MathUtils.sin(0); // 0
MathUtils.sin(Math.PI / 2); // 1
MathUtils.sin(Math.PI); // 0
```
  - Defined in MathUtils.ts:797
sinh:function
- sinh(value): number
- Calculates the hyperbolic sine of a number
  Parameters
  - value: number
    Number to calculate hyperbolic sine for
  Returns number
  Hyperbolic sine
  Example
```
MathUtils.sinh(0); // 0
MathUtils.sinh(1); // 1.1752...
MathUtils.sinh(-1); // -1.1752...
```
  - Defined in MathUtils.ts:812
sqrt:function
- sqrt(value): number
- Calculates the square root of a number
  Parameters
  - value: number
    Number to calculate square root for
  Returns number
  Square root
  Example
```
MathUtils.sqrt(4); // 2
MathUtils.sqrt(2); // 1.4142...
MathUtils.sqrt(0); // 0
```
  - Defined in MathUtils.ts:827
standardDeviation:function
- standardDeviation(numbers): number
- Calculates the standard deviation of an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number
  Standard deviation
  Example
```
MathUtils.standardDeviation([1, 2, 3, 4, 5]); // 1.4142...
MathUtils.standardDeviation([2, 4, 4, 4, 6]); // 1.4142...
MathUtils.standardDeviation([1, 1, 1, 1]); // 0
```
  - Defined in MathUtils.ts:842
sum:function
- sum(numbers): number
- Calculates the sum of an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number
  Sum
  Example
```
MathUtils.sum([1, 2, 3, 4, 5]); // 15
MathUtils.sum([-1, -2, -3]); // -6
MathUtils.sum([0, 0, 0]); // 0
```
  - Defined in MathUtils.ts:859
tan:function
- tan(angle): number
- Calculates the tangent of an angle
  Parameters
  - angle: number
    Angle in radians
  Returns number
  Tangent value
  Example
```
MathUtils.tan(0); // 0
MathUtils.tan(Math.PI / 4); // 1
MathUtils.tan(Math.PI / 2); // Infinity
```
  - Defined in MathUtils.ts:874
tanh:function
- tanh(value): number
- Calculates the hyperbolic tangent of a number
  Parameters
  - value: number
    Number to calculate hyperbolic tangent for
  Returns number
  Hyperbolic tangent (-1 to 1)
  Example
```
MathUtils.tanh(0); // 0
MathUtils.tanh(1); // 0.7615...
MathUtils.tanh(-1); // -0.7615...
```
  - Defined in MathUtils.ts:889
toRadians:function
- toRadians(degrees): number
- Converts degrees to radians
  Parameters
  - degrees: number
    Angle in degrees
  Returns number
  Angle in radians
  Example
```
MathUtils.toRadians(180); // π
MathUtils.toRadians(90); // π/2
MathUtils.toRadians(360); // 2π
```
  - Defined in MathUtils.ts:904
toDegrees:function
- toDegrees(radians): number
- Converts radians to degrees
  Parameters
  - radians: number
    Angle in radians
  Returns number
  Angle in degrees
  Example
```
MathUtils.toDegrees(Math.PI); // 180
MathUtils.toDegrees(Math.PI / 2); // 90
MathUtils.toDegrees(2 * Math.PI); // 360
```
  - Defined in MathUtils.ts:919
variance:function
- variance(numbers): number
- Calculates the variance of an array of numbers
  Parameters
  - numbers: number[]
    Array of numbers
  Returns number
  Variance
  Example
```
MathUtils.variance([1, 2, 3, 4, 5]); // 2
MathUtils.variance([2, 4, 4, 4, 6]); // 2
MathUtils.variance([1, 1, 1, 1]); // 0
```
  - Defined in MathUtils.ts:934

Variable MathUtilsConst

Type declaration

abs:function

Parameters

Returns number

Example

angle:function

Parameters

Returns number

Example

average:function

Parameters

Returns number

Throws

Example

acos:function

Parameters

Returns number

Example

acosh:function

Parameters

Returns number

Example

asin:function

Parameters

Returns number

Example

asinh:function

Parameters

Returns number

Example

atan:function

Parameters

Returns number

Example

atan2:function

Parameters

Returns number

Example

atanh:function

Parameters

Returns number

Example

ceil:function

Parameters

Returns number

Example

clamp:function

Parameters

Returns number

Example

cos:function

Parameters

Returns number

Example

cosh:function

Parameters

Returns number

Example

cbrt:function

Parameters

Returns number

Example

distance:function

Parameters

Returns number

Example

isEven:function

Parameters

Returns boolean

Example

fibonacci:function

Parameters

Returns number

Example

factorial:function

Parameters

Returns number

Example

floor:function

Variable MathUtils`Const`