CFCalibInst




http://www.QuantTools.com
CapeTools Calibration Instruments function list

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

Key TAGs | Excel Index | API Index


Creates an array of Caplet/Floorlet calibration instruments.

Each period within the leg object will be taken as a caplet or floorlet instrument (depending on the value of the 'Types' parameter).

To be used in the calibration of a ShortRate Model (ie BlackKarasinski, HullWhite, Vasicek, G2, LiborMarketModel).

The string 'Key' value returned from this function can be passed to the calibration functions (functions with a naming convention of Calibrate*() ) within the CapeTools IR Calibration or CapeTools LMM Calibration category of functions.

Not all calibration functions can be used with each model.

If you indicate 0.0 for any of the cells within the StrikeRange, then ATM forward rates will be computed for each caplet/floorlet and used as the strike.



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



Note: Within Excel, the function is named - CT.CAL.CFCalibInst


High level graphic of CFCalibInst() 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 value to an already created leg (via a call to the CreateFloatLeg() or CreateAmortFloatLeg() functions).
  4. StrikeRange parameter

    A range of strike values that corresponds to each caplet/floorlet. Or you can enter a single value which will be applied to all the caplets/floorlets.
  5. CFVCKey parameter

    Key to an already created VolCurve object. Caplet/Floorlet vols will be extracted from this object.
  6. Types parameter

    Are we pricing Caplets (CAPLET) or Floorlets (FLOORLET). This is a range object so each row can contain either one of the possible choices. Each row will correspond to the rows within the floatleg.


Extended information

Function Syntax

VB Syntax 


String CTCalibrationInsts.CFCalibInst( _
String Key, _
Long Reload, _
String LegKey, _
Variant StrikeRange, _
String CFVCKey, _
Variant Types)


Excel Spreadsheet Syntax 


=CT.CAL.CFCalibInst(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell LegKey,
XLRange StrikeRange,
Excel String Cell CFVCKey,
XLRange Types)


C++ Syntax 


static std::string CFCalibInst(
std::string Key,
long Reload,
std::string LegKey,
CTRangeDataCPP StrikeRange,
std::string CFVCKey,
CTRangeDataCPP Types);


DotNET Syntax 


System.String CTCalibrationInstsSA.CFCalibInst(
System.String Key,
System.Int32 Reload,
System.String LegKey,
CTRangeData StrikeRange,
System.String CFVCKey,
CTRangeData Types);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
LegKeyStringTRUE
StrikeRangeRangeFALSE
CFVCKeyStringTRUE
TypesRangeFALSE

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
KeyFALSEMyCFCalibInst
ReloadFALSE1
LegKeyFALSELegKeyNAME.EXTTAG.TICKER (from a function call)
StrikeRangeTRUECFCalibInst_StrikeRange_Range (creates a range object)
CFVCKeyFALSECFVCKeyNAME.EXTTAG.TICKER (from a function call)
TypesFALSECFCalibInst_Types_Range (creates a range object)


Example range for parameter : StrikeRange

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


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

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


CTQL.CTRangeData CFCalibInst_StrikeRange;

CFCalibInst_StrikeRange = new  CTQL.CTRangeData(0.025);

Example range for parameter : Types

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


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

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


CTQL.CTRangeData CFCalibInst_Types;

CFCalibInst_Types = new  CTQL.CTRangeData("CAPLET");


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.Models20 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 CFCalibInst() 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 CFCalibInst() function call


MyCFCalibInst_1.CFCAL.0

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