Package org.apache.poi.ss.formula.functions

Class Gcd

java.lang.Object

org.apache.poi.ss.formula.functions.Gcd

All Implemented Interfaces:

FreeRefFunction

public class Gcd
extends Object
implements FreeRefFunction

Implementation for Excel GCD() function.

Syntax:
GCD (number, ...)

Returns the greatest common divisor of two or more integers. The greatest common divisor is the largest integer that divides both number1 and number2 without a remainder.

See https://support.microsoft.com/en-us/office/gcd-function-d5107a51-69e3-461f-8e4c-ddfc21b5073a

Field Summary

Fields

Modifier and Type	Field	Description
static final Gcd	instance

Constructor Summary

Constructors

Constructor	Description
Gcd()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

instance

public static final Gcd instance

Constructor Details

Gcd

public Gcd()

Method Details

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).