Skip to main content

Zymba Documentation

Math

object @Math() {
E;
LN2;
LN10;
LNPI;
LOG10E;
LOG2E;
PI;
SQRT2;
SQRT3;
SQRTPI;
abs(number $x): number {}
acos(number $x): float {}
acosh(number $x): float {}
acot(number $x): float {}
acoth(number $x): float {}
acsc(number $x): float {}
acsch(number $x): float {}
add(number $x, number $y): number {}
alice(): float {}
asec(number $x): float {}
asech(number $x): float {}
asin(number $x): float {}
asinh(number $x): float {}
atan(number $x): float {}
atan2(number $x, number $y): float {}
atanh(number $x): float {}
bob(): float {}
cbrt(number $x): float {}
cos(number $x): float {}
ceil(number $x): float {}
cosh(number $x): float {}
cot(number $x): float {}
coth(number $x): float {}
csc(number $x): float {}
csch(number $x): float {}
dim(number $x, number $y): number {}
div(number $x, number $y): number {}
erf(number $x): float {}
euclideanMod(number $x, number $y): float {}
exp(number $x): float {}
expm1(number $x): float {}
fib(number $x): float {}
floor(number $x): float {}
flooredMod(number $x, number $y): float {}
fromDegrees(number $angle): float {}
gamma(number $x): number {}
gcd(number $x, number $y): number {}
hypot(number $x, number $y): float {}
ln(number $x): float {}
ln1p(number $x): float {}
log(number $x, number $y): float {}
mod(number $x, number $y): float {}
mul(number $x, number $y): number {}
neg(number $x): number {}
pow(number $x, number $y): number {}
rand(): float {}
recip(number $x): float {}
rem(number $x, number $y): float {}
round(number $number): float {}
sec(number $x): float {}
sech(number $x): float {}
sgn(number $x): int {}
sin(number $x): float {}
sinh(number $x): float {}
sqr(number $x): number {}
sqrt(number $x): float {}
sub(number $x, number $y): number {}
tan(number $x): float {}
tanh(number $x): float {}
toDegrees(number $angle): float {}
truncate(number $x): float {}
truncatedDiv(number $x, number $y): number {}
}

Static mathematical constants and functions.

Functions

Returns the absolute value of a number.

@Math.abs(number $x): number
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
number

Calculates the inverse cosine of a number in radians.

@Math.acos(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
floatNAN

Calculates the inverse hyperbolic cosine of a number in radians.

@Math.acosh(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
floatNAN

Calculates the inverse cotangent of a number in radians.

@Math.acot(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates the inverse hyperbolic cotangent of a number in radians.

@Math.acoth(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
float+INF
float-INF
floatNAN

Calculates the inverse cosecant of a number in radians.

@Math.acsc(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
floatNAN

Calculates the inverse hyperbolic cosecant of a number in radians.

@Math.acsch(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
floatNAN

Adds two numbers (x+y) and returns the sum.

@Math.add(number $x, number $y): number
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
number
floatNAN

Easter egg simulating quantum entanglement of two electrons (Alice and Bob).

@Math.alice(): float
Returns
TypeValue
float+0.5
float-0.5

Calculates the inverse secant of a number in radians.

@Math.asec(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
floatNAN

Calculates the inverse hyperbolic secant of a number in radians.

@Math.asech(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
floatNAN

Calculates the inverse sine of a number in radians.

@Math.asin(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
floatNAN

Calculates the inverse hyperbolic sine of a number in radians.

@Math.asinh(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates the inverse tangent of a number in radians.

@Math.atan(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates the inverse tangent of the division of two numbers (y/x) representing the angle theta of an (x,y) point in radians using the sign of both numbers to determine the quadrant.

@Math.atan2(number $x, number $y): float
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
float

Calculates the inverse hyperbolic tangent of a number in radians.

@Math.atanh(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
float+INF
float-INF
floatNAN

Easter egg simulating quantum entanglement of two electrons (Alice and Bob).

@Math.bob(): float
Returns
TypeValue
float+0.5
float-0.5

Calculates the principal cube root of a number.

@Math.cbrt(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates the cosine of a number in radians.

@Math.cos(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Returns the ceiling of a number by rounding it up to the next highest integer.

@Math.ceil(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates the hyperbolic cosine of a number in radians.

@Math.cosh(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates the cotangent of a number in radians.

@Math.cot(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
float+INF

Calculates the hyperbolic cotangent of a number in radians.

@Math.coth(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
float+INF

Calculates the cosecant of a number in radians.

@Math.csc(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
float+INF

Calculates the hyperbolic cosecant of a number in radians.

@Math.csch(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
float+INF

Returns the greatest of zero and the difference of two numbers (x-y).

@Math.dim(number $x, number $y): number
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
number
floatNAN

Divides two numbers (x/y) and returns the quotient.

@Math.div(number $x, number $y): number
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
number
float+INF
float-INF
floatNAN

Calculates the error function of a number using numerical approximation.

@Math.erf(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Divides two numbers (x/y) and returns the remainder in relation to the euclidean quotient.

@Math.euclideanMod(number $x, number $y): float
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
float
floatNAN

Raises Euler's constant to the power of an exponent (x).

@Math.exp(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Raises Euler's constant to the power of an exponent (x) minus one (exp(x)-1), computed in a way that is accurate even when the value of the number is close to zero.

@Math.expm1(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates a specific Fibonacci number using Binet's formula.

@Math.fib(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Returns the floor of a number by rounding it down to the next lowest integer.

@Math.floor(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Divides two numbers (x/y) and returns the remainder in relation to the floored quotient.

@Math.flooredMod(number $x, number $y): float
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
float
floatNAN

Converts an angle in degrees to its equivalent in radians.

@Math.fromDegrees(number $angle): float
Parameters
NameTypeValueDefault
anglenumber0
Returns
TypeValue
float

Calculates the gamma function of a number using the Lanczos approximation with support for reflection.

@Math.gamma(number $x): number
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
number
floatNAN

Calculates the absolute greatest common divisor of two numbers.

@Math.gcd(number $x, number $y): number
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
number
floatNAN

Measures the length of the hypotenuse of a right-angle triangle (sqrt(xx+yy)).

@Math.hypot(number $x, number $y): float
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
float

Calculates the natural logarithm of a number.

@Math.ln(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
float-INF
floatNAN

Calculates the natural logarithm of a number plus one (ln(x+1)), computed in a way that is accurate even when the value of the number is close to zero.

@Math.ln1p(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
float-INF
floatNAN

Calculates the logarithm of a number (x) to a base (y).

@Math.log(number $x, number $y): float
Parameters
NameTypeValueDefault
xnumber0
ynumber10
Returns
TypeValue
float
float-INF
floatNAN

Divides two numbers (x/y) and returns the remainder in relation to the truncated quotient.

@Math.mod(number $x, number $y): float
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
float
floatNAN

Multiplies two numbers (x*y) and returns the product.

@Math.mul(number $x, number $y): number
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
number
floatNAN

Returns the additive inverse of a number.

@Math.neg(number $x): number
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
number

Raises a base (x) to the power of an exponent (y).

@Math.pow(number $x, number $y): number
Parameters
NameTypeValueDefault
xnumber0
ynumber10
Returns
TypeValue
number
float+INF

Generates a pseudo-random number between zero and one using the Mersenne Twister algorithm.

@Math.rand(): float
Returns
TypeValue
float

Returns the multiplicative inverse (reciprocal, 1/x) of a number.

@Math.recip(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
float+INF

Divides two numbers (x/y) and returns the remainder in relation to the rounded quotient as defined in IEEE 754.

@Math.rem(number $x, number $y): float
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
float
floatNAN

Rounds a number to nearest, ties to even as defined in IEEE 754.

@Math.round(number $number): float
Parameters
NameTypeValueDefault
numbernumber0
Returns
TypeValue
float

Calculates the secant of a number in radians.

@Math.sec(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates the hyperbolic secant of a number in radians.

@Math.sech(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Returns the sign of a number.

@Math.sgn(number $x): int
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
int+1
int-1
int0
floatNAN

Calculates the sine of a number in radians.

@Math.sin(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates the hyperbolic sine of a number in radians.

@Math.sinh(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates the square of a number.

@Math.sqr(number $x): number
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
number

Calculates the principal square root of a number.

@Math.sqrt(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float
floatNAN

Subtracts two numbers (x-y) and returns the difference.

@Math.sub(number $x, number $y): number
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
number
floatNAN

Calculates the tangent of a number in radians.

@Math.tan(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Calculates the hyperbolic tangent of a number in radians.

@Math.tanh(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Converts an angle in radians to its equivalent in degrees.

@Math.toDegrees(number $angle): float
Parameters
NameTypeValueDefault
anglenumber0
Returns
TypeValue
float

Truncates a number by rounding it towards zero, whereas the fractional part is discarded.

@Math.truncate(number $x): float
Parameters
NameTypeValueDefault
xnumber0
Returns
TypeValue
float

Divides two numbers (x/y) and returns the truncated quotient.

@Math.truncatedDiv(number $x, number $y): number
Parameters
NameTypeValueDefault
xnumber0
ynumber0
Returns
TypeValue
number
float+INF
float-INF
floatNAN