Returns the internal rate of return for a schedule of cash flows with
a user supplied initial guess.
Namespace:
Imsl.FinanceAssembly: ImslCS (in ImslCS.dll) Version: 6.5.0.0
Syntax
C# |
---|
public static double Xirr( double[] pmt, DateTime[] dates, double guess ) |
Visual Basic (Declaration) |
---|
Public Shared Function Xirr ( _ pmt As Double(), _ dates As DateTime(), _ guess As Double _ ) As Double |
Visual C++ |
---|
public: static double Xirr( array<double>^ pmt, array<DateTime>^ dates, double guess ) |
Parameters
- pmt
- Type: array<
System..::.Double
>[]()[]
A double array which contains cash flow values which correspond to a schedule of payments in dates.
- dates
- Type: array<
System..::.DateTime
>[]()[]
A DateTime array which contains a schedule of payment dates.
- guess
- Type: System..::.Double
A double value which represents an initial guess at the return value from this function.
Return Value
A double which specifies the internal rate of return.Remarks
It is not necessary that the cash flows be periodic. It can be found
by solving the following:
In the equation above, represents the th payment date. represents the 1st payment date. represents the th cash flow. is the internal rate of return.