Class Mirr
java.lang.Object
org.apache.poi.ss.formula.functions.MultiOperandNumericFunction
org.apache.poi.ss.formula.functions.Mirr
- All Implemented Interfaces:
Function
Calculates Modified internal rate of return. Syntax is MIRR(cash_flow_values, finance_rate, reinvest_rate)
Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost of the investment and the interest received on reinvestment of cash.
Values is an array or a reference to cells that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods.- Values must contain at least one positive value and one negative value to calculate the modified internal rate of return. Otherwise, MIRR returns the #DIV/0! error value.
- If an array or reference argument contains text, logical values, or empty cells, those values are ignored; however, cells with the value zero are included.
- Author:
- Carlos Delgado (carlos dot del dot est at gmail dot com), Cedric Walter (cedric dot walter at gmail dot com)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected double
evaluate
(double[] values) protected int
Maximum number of operands accepted by this function.Methods inherited from class org.apache.poi.ss.formula.functions.MultiOperandNumericFunction
evaluate, getNumberArray, isSubtotalCounted
-
Constructor Details
-
Mirr
public Mirr()
-
-
Method Details
-
getMaxNumOperands
protected int getMaxNumOperands()Description copied from class:MultiOperandNumericFunction
Maximum number of operands accepted by this function. Subclasses may override to change default value.- Overrides:
getMaxNumOperands
in classMultiOperandNumericFunction
-
evaluate
- Specified by:
evaluate
in classMultiOperandNumericFunction
- Throws:
EvaluationException
-