CreateCapAndFLRFLTLegTS




http://www.QuantTools.com
CapeTools Exotic Legs function list

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

Key TAGs | Excel Index | API Index


Creates a portfolio of caplet and floorlet options from this floating Rate Leg.

A CAP and FLOOR option strategy involves trading in 2 options on a single floating rate fixing (reset).

If receiving the float leg, bought floorlets and sold caplets will be constructed, if however you are paying the float leg, bought caplets and sold floorlets will be constructed.

This function uses Termstructure models to price this strategy (via the 'engine' parameter).

Via the 'EnablePeriods' parameter, you can indicate which periods you actually want the option strategy to be enabled.

Thus you can indicate, for example, zeros (0) for the first 4 periods and then ones (1's) after that.

This would imply that the option strategies would only kick in after the 4th period.

You can price this strategy via the PrcIROptionStrategyTS() function.

This function requires the input of a floating leg object (or an inverse floater leg object) key, which must have been produced via a call to one of the numerous Leg construction functions (see the CapeTools FLOAT Legs or CapeTools FIXED + FLOAT Legs category of functions).

This strategy does not support CMS, Averaging, InArrears or Compounding legs.

These leg functions will have returned a string 'KEY' which is to be passed to the 'LegKey' parameter of this function.

Unlike the PrcIROptionStrategy() function, This function returns the leg price, the option strategy price and the sum of the two combined.



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



Note: Within Excel, the function is named - CT.CALL.CreateCapAndFLRFLTLegTS


High level graphic of CreateCapAndFLRFLTLegTS() 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 recomputing 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 base leg (via a call to the CreateFloatLeg() function).
  4. EnablePeriods parameter

    An array of zero (0's) or ones (1's) indicating whether you want the option strategy to be priced for the corresponding period.
  5. CapStrikes parameter

    Specify here the caplets strike(s).
  6. FloorStrikes parameter

    Specify here the floorlets strike(s).
  7. ModelKey parameter

    Key value to an already constructed ShortRate Model object (ie BlackKarasinski, HullWhite, Vasicek, G2).
  8. timeSteps parameter

    Number of timesteps within the pricing Tree (ie 100).


Extended information

Function Syntax

VB Syntax 


String CTExoticLegs.CreateCapAndFLRFLTLegTS( _
String Key, _
Long Reload, _
String LegKey, _
Variant EnablePeriods, _
Variant CapStrikes, _
Variant FloorStrikes, _
String ModelKey, _
Long timeSteps)


Excel Spreadsheet Syntax 


=CT.CALL.CreateCapAndFLRFLTLegTS(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell LegKey,
XLRange EnablePeriods,
XLRange CapStrikes,
XLRange FloorStrikes,
Excel String Cell ModelKey,
Excel Numeric Cell timeSteps)


C++ Syntax 


static std::string CreateCapAndFLRFLTLegTS(
std::string Key,
long Reload,
std::string LegKey,
CTRangeDataCPP EnablePeriods,
CTRangeDataCPP CapStrikes,
CTRangeDataCPP FloorStrikes,
std::string ModelKey,
long timeSteps);


DotNET Syntax 


System.String CTExoticLegsSA.CreateCapAndFLRFLTLegTS(
System.String Key,
System.Int32 Reload,
System.String LegKey,
CTRangeData EnablePeriods,
CTRangeData CapStrikes,
CTRangeData FloorStrikes,
System.String ModelKey,
System.Int32 timeSteps);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
LegKeyStringTRUE
EnablePeriodsRangeFALSE
CapStrikesRangeFALSE
FloorStrikesRangeFALSE
ModelKeyStringTRUE
timeStepsLongFALSE

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
KeyFALSEMyTSCreateCapAndFLRFLTLegTS
ReloadFALSE1
LegKeyFALSELegKeyNAME.EXTTAG.TICKER (from a function call)
EnablePeriodsFALSECreateCapAndFLRFLTLegTS_EnablePeriods_Range (creates a range object)
CapStrikesFALSECreateCapAndFLRFLTLegTS_CapStrikes_Range (creates a range object)
FloorStrikesFALSECreateCapAndFLRFLTLegTS_FloorStrikes_Range (creates a range object)
ModelKeyFALSEModelKeyNAME.EXTTAG.TICKER (from a function call)
timeStepsFALSE100


Example range for parameter : EnablePeriods

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


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

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


CTQL.CTRangeData CreateCapAndFLRFLTLegTS_EnablePeriods;


int[] arrBCreateCapAndFLRFLTLegTS_EnablePeriods = {
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1,
1  //  Array Data

};

CTQL.IntVector arrCreateCapAndFLRFLTLegTS_EnablePeriods =
new  CTQL.IntVector(arrBCreateCapAndFLRFLTLegTS_EnablePeriods);

// Second parameter determines whether the array is a column array (false) or a row array (true)
CreateCapAndFLRFLTLegTS_EnablePeriods = new  CTQL.CTRangeData(arrCreateCapAndFLRFLTLegTS_EnablePeriods, false);

Example range for parameter : CapStrikes

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


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

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


CTQL.CTRangeData CreateCapAndFLRFLTLegTS_CapStrikes;


double[] arrBCreateCapAndFLRFLTLegTS_CapStrikes = {
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03,
0.03  //  Array Data

};

CTQL.DoubleVector arrCreateCapAndFLRFLTLegTS_CapStrikes =
new  CTQL.DoubleVector(arrBCreateCapAndFLRFLTLegTS_CapStrikes);

// Second parameter determines whether the array is a column array (false) or a row array (true)
CreateCapAndFLRFLTLegTS_CapStrikes = new  CTQL.CTRangeData(arrCreateCapAndFLRFLTLegTS_CapStrikes, false);

Example range for parameter : FloorStrikes

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


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

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


CTQL.CTRangeData CreateCapAndFLRFLTLegTS_FloorStrikes;


double[] arrBCreateCapAndFLRFLTLegTS_FloorStrikes = {
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04,
0.04  //  Array Data

};

CTQL.DoubleVector arrCreateCapAndFLRFLTLegTS_FloorStrikes =
new  CTQL.DoubleVector(arrBCreateCapAndFLRFLTLegTS_FloorStrikes);

// Second parameter determines whether the array is a column array (false) or a row array (true)
CreateCapAndFLRFLTLegTS_FloorStrikes = new  CTQL.CTRangeData(arrCreateCapAndFLRFLTLegTS_FloorStrikes, false);


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.IRLegs20 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 CreateCapAndFLRFLTLegTS() 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 CreateCapAndFLRFLTLegTS() function call


MyTSCreateCapAndFLRFLTLegTS_22.CAPFLRFLTLEGTS.0

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