org.apache.poi.ss.formula.functions

Class Lcm

java.lang.Object

org.apache.poi.ss.formula.functions.Lcm

All Implemented Interfaces:

FreeRefFunction

public class Lcm
extends Object
implements FreeRefFunction

Implementation for Excel LCM() function.

Syntax:
LCM (number, ...)

Returns the least common multiple of integers. The least common multiple is the smallest positive integer that is a multiple of all integer arguments number1, number2, and so on. Use LCM to add fractions with different denominators.

See https://support.microsoft.com/en-us/office/lcm-function-7152b67a-8bb5-4075-ae5c-06ede5563c94

Field Summary

Fields

Modifier and Type	Field and Description
static Lcm	instance

Constructor Summary

Constructors

Constructor and Description
Lcm()

Method Summary

Modifier and Type	Method and Description
ValueEval	evaluate(ValueEval[] args, OperationEvaluationContext ec)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instance

public static final Lcm instance

Constructor Detail

Lcm

public Lcm()

Method Detail

evaluate

public ValueEval evaluate(ValueEval[] args,
                          OperationEvaluationContext ec)

Specified by:

evaluate in interface FreeRefFunction

Parameters:

args - the pre-evaluated arguments for this function. args is never null, nor are any of its elements.

ec - primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.

Returns:

never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).