Math

namespace Math

a collection of math utility functions

Summary


Properties from Math

number
DEG_TO_RAD
number
EPSILON = 0.000001
number
ETA
number
RAD_TO_DEG
number
TAU

Public Properties


DEG_TO_RAD math.js:6
DEG_TO_RAD: number

number

constant to convert from degrees to radians

EPSILON math.js:34
EPSILON: number = 0.000001

number

the difference between 1 and the smallest floating point number greater than 1

ETA math.js:27
ETA: number

number

constant equals to half pi

RAD_TO_DEG math.js:13
RAD_TO_DEG: number

number

constant to convert from radians to degrees

TAU math.js:20
TAU: number

number

constant equals to 2 times pi

Public Methods


clamp math.js:116
clamp(val: number, low: number, high: number) → {number}

clamp the given value

Parameters:
Name Type Description
val number

the value to clamp

low number

lower limit

high number

higher limit

Returns:
Type Description
number

clamped value

degToRad math.js:90
degToRad(angle: number) → {number}

Converts an angle in degrees to an angle in radians

// convert a specific angle
me.Math.degToRad(60); // return 1.0471...
Parameters:
Name Type Description
angle number

angle in degrees

Returns:
Type Description
number

corresponding angle in radians

isPowerOfFour math.js:51
isPowerOfFour(val: number) → {boolean}

returns true if the given value is a power of four

Parameters:
Name Type Description
val number
Returns:
Type Description
boolean
isPowerOfTwo math.js:41
isPowerOfTwo(val: number) → {boolean}

returns true if the given value is a power of two

Parameters:
Name Type Description
val number
Returns:
Type Description
boolean
nextPowerOfTwo math.js:73
nextPowerOfTwo(val: number) → {boolean}

returns the next power of two for the given value

Parameters:
Name Type Description
val number
Returns:
Type Description
boolean
pow math.js:204
pow(n: number) → {number}

Calculates the power of a number.

Parameters:
Name Type Description
n number

The number to be raised to the power of 2.

Returns:
Type Description
number

The result of raising the number to the power of 2.

radToDeg math.js:103
radToDeg(radians: number) → {number}

Converts an angle in radians to an angle in degrees.

// convert a specific angle
me.Math.radToDeg(1.0471975511965976); // return 60
Parameters:
Name Type Description
radians number

angle in radians

Returns:
Type Description
number

corresponding angle in degrees

random math.js:128
random(min: number, max: number) → {number}

return a random integer between min (included) and max (excluded)

// Print a random number; one of 5, 6, 7, 8, 9
console.log(me.Math.random(5, 10) );
Parameters:
Name Type Description
min number

minimum value.

max number

maximum value.

Returns:
Type Description
number

random value

randomFloat math.js:142
randomFloat(min: number, max: number) → {number}

return a random float between min, max (exclusive)

// Print a random number; one of 5, 6, 7, 8, 9
console.log(me.Math.randomFloat(5, 10) );
Parameters:
Name Type Description
min number

minimum value.

max number

maximum value.

Returns:
Type Description
number

random value

round math.js:170
round(num: number, dec: number) → {number}

round a value to the specified number of digit

// round a specific value to 2 digits
me.Math.round(10.33333, 2); // return 10.33
Parameters:
Name Type Attributes Default Description
num number

value to be rounded.

dec number

<optional>

0

number of decimal digit to be rounded to.

Returns:
Type Description
number

rounded value

toBeCloseTo math.js:186
toBeCloseTo(expected: number, actual: number, precision: number) → {boolean}

check if the given value is close to the expected one

// test if the given value is close to 10
if (me.Math.toBeCloseTo(10, value)) {
    // do something
}
Parameters:
Name Type Attributes Default Description
expected number

value to be compared with.

actual number

actual value to compare

precision number

<optional>

2

float precision for the comparison

Returns:
Type Description
boolean

if close to

weightedRandom math.js:156
weightedRandom(min: number, max: number) → {number}

return a weighted random between min, max (exclusive)

// Print a random number; one of 5, 6, 7, 8, 9
console.log(me.Math.weightedRandom(5, 10) );
Parameters:
Name Type Description
min number

minimum value.

max number

maximum value.

Returns:
Type Description
number

random value


Powered by webdoc!