[ Arithmetic | The ECLiPSe Built-In Predicates | Reference Manual | Alphabetic Index ]

# lcm(+Number1, +Number2, -Result)

Unifies Results with the Least Common Multiple of Number1 and Number2

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 lcm(Number1, Number2, Result) is equivalent to

        Result is lcm(Number1, Number2)

which should be preferred for portability.

The Least Common Multiple operation is only defined on integer arguments.

In coroutining mode, if Number1 or Number2 are uninstantiated, the call is delayed until these variables are instantiated.

### Modes and Determinism

- lcm(+, +, -) is det

### 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:
          lcm(9, 15, 45).
          lcm(-9, 15, 45).
          lcm(2358352782,97895234896224,X).  ( gives X = 38478583260342225282528 )

    Error:
          lcm(A, 2, 6).             (Error 4).
          lcm(1, 2, 3.0).           (Error 5).
          lcm(1.0, 2, 3.0).         (Error 5).
          lcm(4 + 2, 2, 12).        (Error 24).

## See Also

gcd / 3, is / 2