InterestRate





http://www.QuantTools.com
CapeTools Utils function list

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index



Creates an interest rate object.

From this object you can query for discount factors, compound factors, convert rates etc....



This function creates an object and returns a string-key value to represent this created object.
The TAG value of the string-key returned (second part of the key) is : "IROBJ"



Note: Within Excel, the function is named - CT.Rate.InterestRate




High level graphic of InterestRate() function with parameters. Blue square node is the actual function with the parameters ordered.



Parameter Description


  1. Key parameter

    Key value to use as a handle for the created object
  2. Reload parameter

    When creating this object for the first time, set this parameter to a positive value. Within Excel, when re-computing a worksheet where you do not wish to recreate the object, set this parameter to zero (0).
  3. Rate parameter

    The interest rate.
  4. compounding parameter

    The compounding of the interest rate passed in. 'Discounted' 1/(1-r*t), 'Simple' (1+r*t), 'Compounded' (1+r/N)^(t*N), where N is the number of coupons per year, 'Continuous' e^{r*t} and 'SimpleThenCompounded' (Simple up to the first period then Compounded).
  5. Freq parameter

    Frequency of the passed in interest rate. (
  6. DayCount parameter

    The DayCounter of the passed in interest rate.


Extended information

Function Syntax

VB Syntax


String CTUtils.InterestRate( _
String Key, _
Long Reload, _
Double Rate, _
COMPEnum compounding, _
FreqEnum Freq, _
DayCountEnum DayCount)


Excel Spreadsheet Syntax


=CT.Rate.InterestRate(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell Rate,
Excel String Cell compounding,
Excel String Cell Freq,
Excel String Cell DayCount)


C++ Syntax


static std::string InterestRate(
std::string Key,
long Reload,
double Rate,
COMPEnum compounding,
FreqEnum Freq,
DayCountEnum DayCount);


DotNET Syntax


System.String CTUtilsSA.InterestRate(
System.String Key,
System.Int32 Reload,
System.Double Rate,
CTIEnums.COMPEnum compounding,
CTIEnums.FreqEnum Freq,
CTIEnums.DayCountEnum DayCount);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
RateDoubleFALSE
compoundingCOMPEnumFALSE
FreqFreqEnumFALSE
DayCountDayCountEnumFALSE


Example Inputs

The first column represents the name of the parameters. The second column specifies whether the parameters are optional or not. Finally the last column provides some sample input data.
Function call input string-keys are always in the format : "NAME.EXTTAG.TICKER" The "EXTTAG.TICKER" part is determined from the output of other, capetools, object creation functions.


ArgNameIsOptional (Excel only)Example
KeyFALSEMyInterestRate
ReloadFALSE1
RateFALSE0.05
compoundingFALSECompounded
FreqFALSEQ
DayCountFALSEACT360


Example function usage


The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.


If you are accessing this functrion via the MiniXL libraries, this function is present within the CT.QL.Utils20 MiniXL Excel Addin.

Within our Excel Example Addin Generator, we have used the following QuantTools sub-functions in order to prepare the arguments needed to call the InterestRate() function. If you are executing this function via the MiniXL libraries, the module addin name, (in brackets, to the right of the sub-functions listed below), indicates the MiniXL library in which the sub-function is held. You will need to load this library into your Excel session (along with any other libraries that the sub-function call within the addin requires (ie - CT.QT.Utils20 addin in almost all cases) in order for the example to compute successfully.


The following four examples demostrate calling this function within a Microsoft .NET environment

The following four examples demostrate calling this function within a non .NET environment

The following is a sample output from executing the InterestRate() function call


MyInterestRate_25.IROBJ.0

Copyright (c) 2003-2007 CapeTools - All Rights Reserved.