truncate(+Number, -Result)

-Result is truncate(+Number)

Number

A number.

Result

Output: number.

Description

This operation works on all numeric types. The result value is the closest integral value that lies between 0 and Number (rounding towards zero).

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

This predicate can be used as a function in arithmetic expressions. In coroutining mode, if Number is uninstantiated, the call to truncate/2 is delayed until this variable is instantiated.

Modes and Determinism

• truncate(+, -) is det

Exceptions

(4) instantiation fault

Number is not instantiated (non-coroutining mode only).

(24) number expected

Number is not of a numeric type.

Examples

    Result is truncate(1.8).		% gives Result = 1.0
    Result is truncate(-1.8).		% gives Result = -1.0
    Result is truncate(1.0).		% gives Result = 1.0
    Result is truncate(-0.0).		% gives Result = -0.0
    Result is truncate(5).		% gives Result = 5

See Also