Function Floor(x)

Floor

Floor(
     x             ! (input) numerical expression
     )

Arguments

x

A scalar numerical expression.

Return Value

The function Floor returns the largest integer value \(\leq\) x.

Example

_p_returnA := Floor(-1.00); ! returns -1
_p_returnB := Floor(-0.99); ! returns -1
_p_returnC := Floor( 0   ); ! returns  0
_p_returnD := Floor( 0.99); ! returns  0

Note

  • The function Floor will round to the nearest integer, if it lies within the equality tolerances equality_absolute_tolerance and equality_relative_tolerance.

  • The function Floor can be used in the constraints of nonlinear mathematical programs. However, nonlinear solvers may experience convergence problems around integer values.

  • When the numerical expression contains a unit, the function Floor will first convert the expression to the corresponding base unit, before evaluating the function itself.

See also