[ Arithmetic | Reference Manual | Alphabetic Index ]

floor(+Number, -Result)

Unifies Result with the greatest integral value that is less or equal than Number and of the same numeric type as Number.
Number
A number.
Result
A variable or number.

Description

This predicate is used by the ECLiPSe compiler to expand evaluable arithmetic expressions. So the call to floor(Number, Result) is equivalent to
    Result is floor(Number)
which should be preferred for portability.

This operation works on all numeric types. The result value is the largest integral value that is smaller that Number (rounding down towards minus infinity).

The result type is the same as the argument type. To convert the type to integer, use integer/2.

In coroutining mode, if Number is uninstantiated, the call to floor/2 is delayed until this variable is instantiated.

Modes and Determinism

Exceptions

(4) instantiation fault
Number is not instantiated (non-coroutining mode only).
(24) number expected
Number is not of a numeric type.

Examples

Success:
      floor(1.8, 1.0).
      floor(-1.8, -2.0).
      floor(5, 5).
      floor(-6.4, Result).      (gives Result = -7.0)
Fail:
      floor(1.0, 0.0).
      floor(0.5, 0).
      floor(1, r).
Error:
      floor(A, 6.0).                   (Error 4).
      floor(4 + 2.3, 6.0).             (Error 24).



See Also

is / 2, ceiling / 2, round / 2, truncate / 2, integer / 2