Top Description Constructors Methods
org.apache.poi.ss.formula.functions

public final Class Npv

extends Object
implements Function
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.functions.Function
Imports
java.util.Arrays, org.apache.poi.ss.formula.eval.ErrorEval, .EvaluationException, .NumberEval, .ValueEval
Calculates the net present value of an investment by using a discount rate and a series of future payments (negative values) and income (positive values). Minimum 2 arguments, first arg is the rate of discount over the length of one period others up to 254 arguments representing the payments and income.

Constructor Summary

AccessConstructor and Description
public
Npv()

Method Summary

Modifier and TypeMethod and Description
public ValueEval
evaluate(ValueEval[]
the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.
args, int
row index of the cell containing the formula under evaluation
srcRowIndex, int
column index of the cell containing the formula under evaluation
srcColumnIndex)

Implements org.apache.poi.ss.formula.functions.Function.evaluate.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Npvback to summary
public Npv()

Method Detail

evaluateback to summary
public ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

Implements org.apache.poi.ss.formula.functions.Function.evaluate.

Parameters
args:ValueEval[]

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.

srcRowIndex:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

row index of the cell containing the formula under evaluation

srcColumnIndex:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

column index of the cell containing the formula under evaluation

Returns:ValueEval

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

The evaluated result, possibly an ErrorEval, never null

Note

- Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to Double#NaN be sure to translate the result to ErrorEval#NUM_ERROR.