math.remainder() function

Warning! This page documents an earlier version of Flux, which is no longer actively developed. Flux v0.36 is the most recent stable version of Flux.

The math.remainder() function returns the IEEE 754 floating-point remainder of x / y.

Output data type: Float

import "math"

math.remainder(x: 21.0, y: 4.0)

// Returns 1.0

Parameters

x

The numerator used in the operation.

Data type: Float

x

The denominator used in the operation.

Data type: Float

Special cases

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