Class Rank
java.lang.Object
org.apache.poi.ss.formula.functions.Rank
- All Implemented Interfaces:
Function
,Function2Arg
,Function3Arg
Returns the rank of a number in a list of numbers. The rank of a number is its size relative to other values in a list.
Syntax:
RANK(number,ref,order)
Number is the number whose rank you want to find.
Ref is an array of, or a reference to, a list of numbers. Nonnumeric values in ref are ignored.
Order is a number specifying how to rank number.
If order is 0 (zero) or omitted, Microsoft Excel ranks number as if ref were a list sorted in descending order.
If order is any nonzero value, Microsoft Excel ranks number as if ref were a list sorted in ascending order.
- Author:
- Rubin Wang
-
Constructor Summary
Constructors -
Method Summary
-
Constructor Details
-
Rank
public Rank()
-
-
Method Details
-
evaluate
Description copied from interface:Function2Arg
-
evaluate
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2) Description copied from interface:Function3Arg
-
evaluate
- Specified by:
evaluate
in interfaceFunction
- Parameters:
args
- the evaluated function arguments. Empty values are represented withBlankEval
orMissingArgEval
, nevernull
.srcRowIndex
- row index of the cell containing the formula under evaluationsrcColumnIndex
- 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
.
-