xtr.math¶

abs¶

abs(num: Number): Number

Returns the absolute value of the given num.

Example

xtr.math.abs(-1)

1

acos¶

acos(x: Number): Number

Returns the arc cosine of the given x.

Example

xtr.math.acos(1)

0

asin¶

asin(x: Number): Number

Returns the arc sine of the given x.

Example

xtr.math.asin(1)

1.5707963267948966

atan¶

atan(x: Number): Number

Returns the arc tangent of the given x.

Example

xtr.math.atan(1)

0.7853981633974483

avg¶

avg(array: Array[Number]): Number

Returns the average of the numbers in array.

Example

xtr.math.avg([1,2,3])

2

ceil¶

ceil(num: Number): Number

Returns the ceiling (aka round up) of the given num.

Example

xtr.math.ceil(1.01)

2

clamp¶

clamp(x: Number, minVal: Number, maxVal: Number): Number

Returns x if it exists between minVal and maxVal, otherwise the one that is closest.

Example

xtr.math.clamp(100, 0, 10)

10

cos¶

cos(x: Number): Number

Returns the cosine of the given x.

Example

xtr.math.cos(0)

1

exp¶

exp(x: Number): Number

Returns Euler's number e, to the power of x.

Example

xtr.math.exp(2)

7.38905609893065

exponent¶

exponent(x: Number): Number

Returns the exponent portion of the double-precision binary floating-point representation (IEEE 754:binary64) of the given x.

Example

xtr.math.exponent(2)

2

floor¶

floor(num: Number): Number

Returns the floor (aka round down) of the given num.

Example

xtr.math.floor(4.99)

4

log¶

log(x: Number): Number

Returns the natural logarithm of the given x.

Example

xtr.math.log(2)

0.6931471805599453

mantissa¶

mantissa(x: Number): Number

Returns the fraction portion (aka significand) of the double-precision binary floating-point representation (IEEE 754:binary64) of the given x.

Example

xtr.math.mantissa(2)

0.5

pow¶

pow(num1: Number, num2: Number): Number

Returns the value of num1 raised to the power of num2.

Example

xtr.math.pow(2, 2)

4

random¶

random(): Number

Returns a pseudo-random double-precision floating-point number between 0 and 1.

Example

xtr.math.random()

0.5963038027787421

randomInt¶

randomInt(num: Number): Number

Returns a pseudo-random integer between 0 (inclusive) and the given num (exclusive). A num of zero or less is an error.

Example

xtr.math.randomInt(500)

485

round¶

round(num: Number, mode: String = 'half-up', precision: Number = 0): Number

Rounds the given num using the mode and precision requested. Supported modes are up, down, half-up, half-down, ceiling, floor, and half-even.

Example

xtr.math.round(2.5)

3

sin¶

sin(x: Number): Number

Returns the sine of the given x.

Example

xtr.math.sin(1)

0.8414709848078965

sqrt¶

sqrt(num: Number): Number

Returns the square root of the given num.

Example

xtr.math.sqrt(4)

2

sum¶

sum(array: Array[Number]): Number

Returns the sum of all numbers in array.

Example

xtr.math.sum([10, 20, 30])

60

tan¶

tan(x: Number): Number

Returns the tangent of the given x.

Example

xtr.math.tan(1)

1.5574077246549023