math.dim() function

The math.dim() function returns the maximum of x - y or 0.

Output data type: Float

import "math"

math.dim(x: 12.2, y: 8.1)

// Returns 4.1

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.dim(x: +Inf, y: +Inf) // Returns NaN
math.dim(x: -Inf, y: -Inf) // Returns NaN
math.dim(x:x, y    : NaN)  // Returns NaN
math.dim(x: NaN, y :y)     // Returns NaN

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


Need help getting up and running? Get Support