IFinance.Intrate

Fore Syntax

Intrate(Settlement: DateTime;

Maturity: DateTime;

Investment: Double;

Redemption: Double;

Basis: Integer): Double;

Fore.NET Syntax

Intrate(Settlement: System.DateTime;

Maturity: System.DateTime;

Investment: double;

Redemption: double;

Basis: integer): double;

Parameters

Parameters	Description	Constraints
Settlement	Securities settlement date.	Must be less than Maturity.
Maturity	Securities maturity date.	Must be greater than Settlement.
Investment	Investment volume.	Must be positive.
Redemption	The sum, which should be acquired on maturity date.	Must be positive.
Basis	The employed method of day calculation: 0 - American/360 days (NSAD method). 1 - Factual/factual. 2 - Factual/360days. 3 - Factual/365 days. 4 - European 30/360 days.	Must be in the [0,4] interval.

Description

The Intrate method returns the interest rate for fully invested securities.

Comments

Intrate is calculated using the following formula:

Where:

B. The number of days in a year (depends on the Basis argument value).
DIM. The number of days from settlement date to maturity date.

Fore Example

To execute the example, add a link to the MathFin system assembly.

Sub UserProc;
Var
    r: Double;
Begin
    r := Finance.Intrate(DateTime.ComposeDay(2008,01,01), DateTime.ComposeDay(2008,06,01), 1500.5, 1600.4, 0);
    Debug.WriteLine(r);
End Sub UserProc;

After executing the example the console window displays the interest rate equal to 0.16.

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example.

Imports Prognoz.Platform.Interop.MathFin;
…
Public Shared Sub Main(Params: StartParams);
Var
    r: double;
    Finance: FinanceClass = New FinanceClass();
    DateTime1, DateTime2: System.DateTime;
Begin
    DateTime1 := New DateTime(2008,01,01);
    DateTime2 := New DateTime(2008,06,01);
    r := Finance.Intrate(DateTime1, DateTime2, 1500.5, 1600.4, 0);
    System.Diagnostics.Debug.WriteLine(r);
End Sub;