
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.



Arguments
   Number              A number.
   Result              Output: number.

Type
   Arithmetic

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
   floor(+, -) is det

Exceptions
     4 --- Number is not instantiated (non-coroutining mode only).
    24 --- Number is not of a numeric type.

Examples
   
    Result is floor(1.8).		% gives Result = 1.0
    Result is floor(-1.8).		% gives Result = -2.0
    Result is floor(1.0).		% gives Result = 1.0
    Result is floor(-0.0).		% gives Result = -0.0
    Result is floor(5).			% gives Result = 5



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