Floor




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

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

Key TAGs | Excel Index | API Index


Creates an interest rate Floor object.

This function can employ different pricing engines (Analytical and Tree).

Once the object has been constructed, the value of the option can be obtained by executing the PrcObjFloor() function.

This function requires the input of a Leg object key, which must have been produced via a call to the CreateFloatLeg() function.

This function would have returned a string 'KEY' which is to be passed to the 'LegKey' parameter of this function.

This function requires the input of an engine object key, which must have been produced via a call to one of the following functions : TreeCapFloorEngine(), BlackCapFloorEngine() or AnalyticCapFloorEngine(). These functions would have returned a string 'KEY' which is to be passed to the 'engine' parameter of this function.



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 : "IRFLROPT"



Note: Within Excel, the function is named - CT.OPT.Floor


High level graphic of Floor() 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. LegKey parameter

    Key to an already constructed Leg object
  4. Strikes parameter

    Array of strikes for each floor, or can pass in a single strike to be used for all periods.
  5. engine parameter

    Key to an already constructed PricingEngine object (ie - TreeCapFloorEngine, BlackCapFloorEngine, AnalyticCapFloorEngine).


Extended information

Function Syntax

VB Syntax 


String CTIREngineOptions.Floor( _
String Key, _
Long Reload, _
String LegKey, _
Variant Strikes, _
String engine)


Excel Spreadsheet Syntax 


=CT.OPT.Floor(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell LegKey,
XLRange Strikes,
Excel String Cell engine)


C++ Syntax 


static std::string Floor(
std::string Key,
long Reload,
std::string LegKey,
CTRangeDataCPP Strikes,
std::string engine);


DotNET Syntax 


System.String CTIREngineOptionsSA.Floor(
System.String Key,
System.Int32 Reload,
System.String LegKey,
CTRangeData Strikes,
System.String engine);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
LegKeyStringTRUE
StrikesRangeFALSE
engineStringTRUE

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
KeyFALSEMyFloor
ReloadFALSE1
LegKeyFALSELegKeyNAME.EXTTAG.TICKER (from a function call)
StrikesFALSEFloor_Strikes_Range (creates a range object)
engineFALSEengineNAME.EXTTAG.TICKER (from a function call)


Example range for parameter : Strikes

Within Excel, a range such as this can be passed directly into the Strikes parameter.


Data is stored within the second column (Vector of data)..

Example C# API usage for setting the range data for parameter : Strikes 


CTQL.CTRangeData Floor_Strikes;

Floor_Strikes = new  CTQL.CTRangeData(0.06);


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.EnginePricing20 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 Floor() 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.

These are the financial QuantTools sub-function calls that are used within the examples :





The objects generated by these sub-functions are inter-connected in the following way :




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 Floor() function call


MyFloor_3.IRFLROPT.0

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