CLHS: Function MOD, REM

#

Function MOD, REM

Syntax:

mod number divisor => modulus

rem number divisor => remainder

Arguments and Values:

number---a real.

divisor---a real.

modulus, remainder---a real.

Description:

mod and rem are generalizations of the modulus and remainder functions respectively.

mod performs the operation floor on number and divisor and returns the remainder of the floor operation.

rem performs the operation truncate on number and divisor and returns the remainder of the truncate operation.

mod and rem are the modulus and remainder functions when number and divisor are integers.

Examples:

     (rem -1 5) =>  -1
     (mod -1 5) =>  4
     (mod 13 4) =>  1
     (rem 13 4) =>  1
     (mod -13 4) =>  3
     (rem -13 4) =>  -1
     (mod 13 -4) =>  -3
     (rem 13 -4) =>  1
     (mod -13 -4) =>  -1
     (rem -13 -4) =>  -1
     (mod 13.4 1) =>  0.4
     (rem 13.4 1) =>  0.4
     (mod -13.4 1) =>  0.6
     (rem -13.4 1) =>  -0.4

Side Effects: None.

Affected By: None.

Exceptional Situations: None.

See Also:

floor, truncate

Notes:

The result of mod is either zero or a real with the same sign as divisor.

The following X3J13 cleanup issue, not part of the specification, applies to this section:

- REAL-NUMBER-TYPE:X3J13-MAR-89

Copyright 1996-2005, LispWorks Ltd. All rights reserved.