math.mod() function

The math.mod() function returns the floating-point remainder of x/y. The magnitude of the result is less than y and its sign agrees with that of x.

Output data type: Float

import "math"

math.mod(x: 1.23, y: 4.56)

// Returns 1.23

Parameters

x

The X value used in the operation.

Data type: Float

y

The Y value used in the operation.

Data type: Float

Special cases

math.mod(x: ±Inf, y:y)  // Returns NaN
math.mod(x: NaN, y:y)   // Returns NaN
math.mod(x:x, y: 0)     // Returns NaN
math.mod(x:x, y: ±Inf)  // Returns x
math.mod(x:x, y: NaN)   // Returns NaN

This documentation is open source. See a typo? Please, open an issue.


Need help getting up and running? Get Support