math

Generated from the engine catalog by tools/gen-docs.mjs; do not edit.

Constants

math.abs

math.abs(x) -> num

Absolute value.

math.acos

math.acos(x) -> num

Arc cosine.

math.asin

math.asin(x) -> num

Arc sine.

math.atan

math.atan(x) -> num

Arc tangent.

math.atan2

math.atan2(y, x) -> num

Angle of the point (x, y).

math.avg_of

math.avg_of(a, b) -> num

Mean of 2 .. 16 values.

math.ceil

math.ceil(x) -> num

Smallest integer >= x.

math.clamp

math.clamp(x, lo, hi) -> num

x limited to [lo, hi].

math.coalesce

math.coalesce(x, fallback) -> any

x, or fallback when x is na.

math.cos

math.cos(x) -> num

Cosine (radians).

math.equal

math.equal(a, b, eps = 1e-9) -> bool

math.exp

math.exp(x) -> num

e to the power x.

math.floor

math.floor(x) -> num

Largest integer <= x.

math.hypot

math.hypot(a, b) -> num

sqrt(a^2 + b^2).

math.is_na

math.is_na(x) -> bool

True when x is na.

math.lerp

math.lerp(a, b, t) -> num

a + t * (b - a).

math.log

math.log(x) -> num

Natural logarithm (na for x <= 0).

math.log10

math.log10(x) -> num

Base-10 logarithm.

math.max

math.max(a, b) -> num

Larger of a and b (na if either is na).

math.min

math.min(a, b) -> num

Smaller of a and b (na if either is na).

math.normalize

math.normalize(x, lo, hi) -> num

(x - lo) / (hi - lo).

math.pow

math.pow(x, p) -> num

x to the power p.

math.random

math.random(seed = 0) -> num

Deterministic uniform random number in [0, 1), one stream per call site.

math.relu

math.relu(x) -> num

max(x, 0).

math.round

math.round(x, digits = 0) -> num

Round half away from zero to digits decimals.

math.round_to

math.round_to(x, step = asset.tick_size) -> num

Round to the nearest multiple of step (default: the tick size).

math.sigmoid

math.sigmoid(x) -> num

Logistic function 1 / (1 + e^-x).

math.sign

math.sign(x) -> num

-1, 0 or 1.

math.sin

math.sin(x) -> num

Sine (radians).

math.sqrt

math.sqrt(x) -> num

Square root (na for x < 0).

math.sum_of

math.sum_of(a, b) -> num

Sum of 2 .. 16 values.

math.tan

math.tan(x) -> num

Tangent (radians).

math.tanh

math.tanh(x) -> num

Hyperbolic tangent.

math.to_bool

math.to_bool(x) -> bool

True for a non-zero number; na is false.

math.to_degrees

math.to_degrees(x) -> num

Radians to degrees.

math.to_radians

math.to_radians(x) -> num

Degrees to radians.

math.trunc

math.trunc(x) -> num

Integer part (towards zero).