Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "util/math"

Index

Functions

average

  • average(numbers: number[]): number
  • calculates the average value of an array of numbers

    Parameters

    • numbers: number[]

    Returns number

divide

  • divide(numerator: number, denominator: number): number
  • If the denominator is 0 the output will be 0 otherwise normal division occurs.

    Parameters

    • numerator: number
    • denominator: number

    Returns number

fitToRange

  • fitToRange(x: number, min: number, max: number, targetMin: number, targetMax: number): number
  • Fits a number into a new range of values.

    Parameters

    • x: number

      the number to convert

    • min: number

      the minimum value of the number's current range

    • max: number

      the maximum value of the number's current range

    • targetMin: number

      the minimum value of the desired range

    • targetMax: number

      the maximum value of the desired range.

    Returns number

measureRelativeProximity

  • measureRelativeProximity(x: number, y: number, xRange: number, yRange: number): number
  • Measures how close two points, on two separate ranges, are to each other. It should be noted that the relative proximity will be more pronounced on larger ranges, requiring a relatively larger distance between points to measure a lower proximity.

    NOTE: This assumes ranges with a min value of 1.

    Parameters

    • x: number

      a point along the x-range

    • y: number

      a point along the y-range

    • xRange: number

      the maximum value in the x-range

    • yRange: number

      the maximum value in the y-range

    Returns number

    a value close to 1 indicates they are very close. A value close to 0 indicates they are as var away as possible.

median

  • median(numbers: number[]): number
  • The "median" is the "middle" value in the list of numbers.

    Parameters

    • numbers: number[]

      an array of numbers

    Returns number

    • the calculated median value from the specified numbers

reduceStrength

  • reduceStrength(x: number, factor: number): number
  • Moves a value toward 1 in order to reduce it's effect in multiplication and division. This is the inverse of scaleUp.

    Parameters

    • x: number
    • factor: number

    Returns number

scaleUp

  • scaleUp(x: number, factor: number): number
  • Scales scales a value up to 1. Setting a scale factor of 1 will return 1. A scale factor of 0 will return the original value.

    Parameters

    • x: number

      the number to scale. Must be between 0 and 1 inclusive.

    • factor: number

      The amount to scale by. Must be between 0 and 1 inclusive.

    Returns number

Generated using TypeDoc