[ Arithmetic | The ECLiPSe Built-In Predicates | Reference Manual | Alphabetic Index ]
mod(+Number1, +Number2, ?Result)
Evaluates the modulus Number1 mod Number2 and unifies the resulting value
with Result.
- +Number1
- Integer.
- +Number2
- Integer.
- ?Result
- A variable or integer.
Description
This predicate is used by the ECLiPSe compiler to expand evaluable
arithmetic expressions. So the call to mod(Number1, Number2, Result) is
equivalent to
Result is Number1 mod Number2
which should be preferred for portability.
In coroutining mode, if Number1 or Number2 are free variables, the call
to mod/3 is delayed until these variables are instantiated.
Fail Conditions
Fails if the result of the evaluation does not unify with Result.
Resatisfiable
No
Exceptions
- (4) instantiation fault
- Number1 or Number2 is not instantiated (non-coroutining mode only).
- (5) type error
- Result is a number but not an integer.
- (5) type error
- Number1 or Number2 is a number but not an integer.
- (24) number expected
- Number1 or Number2 is not of a numeric type.
- (24) number expected
- Result is neither a number nor a variable.
Examples
Success:
mod(11, 2, 1).
mod(-11, 2, Result). (gives Result = -1)
Fail:
mod(1, 2, 3).
Error:
mod(A, 2, 6). (Error 4).
mod(6, 2.0, 3.0). (Error 5).
mod(2, 0, Result). (Error 20).
mod(4 + 2, 2, 12). (Error 24).
mod(5, 2, r). (Error 24).
See Also
is / 2