Returns the cumulative interest paid between two periods.

Namespace: Imsl.Finance
Assembly: ImslCS (in ImslCS.dll) Version: 6.5.0.0

Syntax

C#
public static double Cumipmt(
	double rate,
	int nper,
	double pv,
	int firstPeriod,
	int lastPeriod,
	Finance..::.Period period
)
Visual Basic (Declaration)
Public Shared Function Cumipmt ( _
	rate As Double, _
	nper As Integer, _
	pv As Double, _
	firstPeriod As Integer, _
	lastPeriod As Integer, _
	period As Finance..::.Period _
) As Double
Visual C++
public:
static double Cumipmt(
	double rate, 
	int nper, 
	double pv, 
	int firstPeriod, 
	int lastPeriod, 
	Finance..::.Period period
)

Parameters

rate
Type: System..::.Double
A double which specifies the interest rate.
nper
Type: System..::.Int32
A int which specifies the total number of payment periods.
pv
Type: System..::.Double
A double which specifies the present value.
firstPeriod
Type: System..::.Int32
A int containing the first period in the caclulation. Periods are numbered starting with one.
lastPeriod
Type: System..::.Int32
A int which specifies the last period in the calculation.
period
Type: Imsl.Finance..::.Finance..::.Period
A int which specifies the time in each period when the payment is made, either AtEnd or AtBeginning

Return Value

A double which specifies the cumulative interest paid between the first period and the last period.

Remarks

It is computed using the following:

\sum\limits_{i = {\it firstPeriod}}^{\it lastPeriod} {\it interest}_i

where {\it interest}_i is computed from Ipmt for the i-th period.

See Also