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

public Class Mirr

extends MultiOperandNumericFunction
Class Inheritance
Imports
java.util.Arrays, org.apache.poi.ss.formula.eval.ErrorEval, .EvaluationException

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. Finance_rate is the interest rate you pay on the money used in the cash flows. Reinvest_rate is the interest rate you receive on the cash flows as you reinvest them.
See Also
Wikipedia on MIRR, Excel MIRR, Irr

Constructor Summary

AccessConstructor and Description
public
Mirr()

Method Summary

Modifier and TypeMethod and Description
protected double
protected int
getMaxNumOperands()

Overrides org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.getMaxNumOperands.

Maximum number of operands accepted by this function.

private static double
mirr(double[] in, double financeRate, double reinvestRate)

Inherited from org.apache.poi.ss.formula.functions.MultiOperandNumericFunction:
evaluategetNumberArrayisHiddenRowCountedisSubtotalCountedsetBlankEvalPolicysetMissingArgPolicytreatStringsAsZero

Constructor Detail

Mirrback to summary
public Mirr()

Method Detail

evaluateback to summary
protected double evaluate(double[] values) throws EvaluationException

Implements abstract org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.evaluate.

Annotations
@Override
getMaxNumOperandsback to summary
protected int getMaxNumOperands()

Overrides org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.getMaxNumOperands.

Doc from org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.getMaxNumOperands.

Maximum number of operands accepted by this function. Subclasses may override to change default value.

Annotations
@Override
mirrback to summary
private static double mirr(double[] in, double financeRate, double reinvestRate)