Table of Contents



Arithmetic Functions

Arithmetic built-in functions operate on numbers.

abs(x)

Returns the absolute value of a number.

Argument Type Description
`x` number Input value.

Returns: number.

Example: 

abs(-5);        // 5
abs(5);         // 5

dec(value, min, reset)

Decrements a value by one and wraps when it goes below a minimum.

Argument Type Description
`value` number, `none()`, or NaN Current value. If `none()` or NaN, `reset` is returned.
`min` number Minimum allowed value.
`reset` number Value returned after wrap or invalid input.

Returns: number.

Example: 

index = 0;
index = dec(index, 0, 9);   // 9
index = dec(index, 0, 9);   // 8

inc(value, max, reset)

Increments a value by one and wraps when it goes above a maximum.

Argument Type Description
`value` number, `none()`, or NaN Current value. If `none()` or NaN, `reset` is returned.
`max` number Maximum allowed value.
`reset` number Value returned after wrap or invalid input.

Returns: number.

Example: 

index = 9;
index = inc(index, 9, 0);   // 0
index = inc(index, 9, 0);   // 1

max(value, ...)

Returns the largest number from one or more arguments.

Argument Type Description
`value` number First value. At least one value is required.
`…` number Additional values.

Returns: number.

Example: 

max(3, 8, 2);   // 8

min(value, ...)

Returns the smallest number from one or more arguments.

Argument Type Description
`value` number First value. At least one value is required.
`…` number Additional values.

Returns: number.

Example: 

min(3, 8, 2);   // 2

rand()

Returns a random number from 0 to 1.

Argument Type Description
none No arguments.

Returns: number.

Example: 

r = rand();

rand(max)

Returns a random integer-style value from 0 to `max`.

Argument Type Description
`max` number Upper bound.

Returns: number.

Example: 

roll = rand(10);

rand(min, max)

Returns a random integer-style value from `min` to `max`.

Argument Type Description
`min` number Lower bound. Must be smaller than `max`.
`max` number Upper bound.

Returns: number.

Example: 

roll = rand(1, 6);

sign(x)

Returns the sign of a number.

Argument Type Description
`x` number Input value.

Returns: `-1`, `0`, or `1`.

Example: 

sign(-12);      // -1
sign(0);        // 0
sign(12);       // 1

Previous: None and NaN

Next: Algebra