Class Mode
java.lang.Object
org.apache.poi.ss.formula.functions.Mode
- All Implemented Interfaces:
Function
- Author:
- Amol S. Deshmukh < amolweb at ya hoo dot com >
-
Constructor Summary
Constructors -
Method Summary
-
Constructor Details
-
Mode
public Mode()
-
-
Method Details
-
evaluate
if v is zero length or contains no duplicates, return value is Double.NaN. Else returns the value that occurs most times and if there is a tie, returns the first such value.- Parameters:
v
- An array of values on which the mode is computed.- Throws:
EvaluationException
-
evaluate
- Specified by:
evaluate
in interfaceFunction
- Parameters:
args
- the evaluated function arguments. Empty values are represented withBlankEval
orMissingArgEval
, nevernull
.srcCellRow
- row index of the cell containing the formula under evaluationsrcCellCol
- column index of the cell containing the formula under evaluation- Returns:
- The evaluated result, possibly an
ErrorEval
, nevernull
. Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate toDouble.NaN
be sure to translate the result toErrorEval.NUM_ERROR
.
-