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

Class Quotient

java.lang.Object

org.apache.poi.ss.formula.functions.Fixed2ArgFunction

org.apache.poi.ss.formula.functions.Quotient

All Implemented Interfaces:

FreeRefFunction, Function, Function2Arg

public class Quotient
extends Fixed2ArgFunction
implements FreeRefFunction

Implementation for Excel QUOTIENT () function.

Syntax:
QUOTIENT(Numerator,Denominator)

Numerator is the dividend. Denominator is the divisor. Returns the integer portion of a division. Use this function when you want to discard the remainder of a division.

If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value. If denominator is equals to zero, QUOTIENT returns the #DIV/0! error value.

Field Summary

Fields

Modifier and Type	Field	Description
static FreeRefFunction	instance

Constructor Summary

Constructors

Constructor	Description
Quotient()

Method Summary

Modifier and Type	Method	Description
ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval venumerator, ValueEval vedenominator)	see Function.evaluate(ValueEval[], int, int)
ValueEval	evaluate(ValueEval[] args, OperationEvaluationContext ec)

Methods inherited from class org.apache.poi.ss.formula.functions.Fixed2ArgFunction

evaluate, evaluate, evaluateArray

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static final FreeRefFunction instance

Constructor Detail

Quotient

public Quotient()

Method Detail

evaluate

public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex,
                          ValueEval venumerator,
                          ValueEval vedenominator)

Description copied from interface: Function2Arg

see Function.evaluate(ValueEval[], int, int)

Specified by:

evaluate in interface Function2Arg

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