CMSOption




http://www.QuantTools.com
CapeTools Query Curves function list

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

Key TAGs | Excel Index | API Index


Computes a CMS caplet or floorlet given a swap index object.

This function requires the input of a SWAP IndexKey object key, which must have been produced via a call to CreateSwapIndex(), IDXEURSwap(), IDXGBPSwap(), IDXJPYSwap(), IDXCHFSwap() or IDXUSDSwap(). This function would have returned a string 'KEY' which is to be passed to the 'CMSIndexKey' parameter of this function.

This function requires the input of a VolCurve object key, which must have been produced via a call to one of the following functions : FlatVolCurve(), ATMVolMatrix(), ExpiryKVolMatrix() or SABRVolCurve(). These functions would have returned a string 'KEY' which is to be passed to the 'VCKey' parameter of this function.



Note: Within Excel, the function is named - CT.MKT.CMSOption


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



Parameter Description


  1. OptionType parameter

    Type of option. Possible values are 'cap' or 'floor'.
  2. Strike parameter

    Strike value
  3. Start parameter

    Start date of the payment period
  4. EndDate parameter

    End date of the payment period
  5. CMSIndexKey parameter

    SWAP Index Key to an already constructed Swap Index object (via a call to the CreateSwapIndex(), IDXEURSwap(), IDXGBPSwap(), IDXJPYSwap(), IDXCHFSwap() or IDXUSDSwap() function). Used for the description of the SWAP underlying the CMS for the Fixing period of this forward rate.
  6. VCKey parameter

    Key to an already constructed interest rate VolCurve object.
  7. InArrears parameter

    Is the swap Index fixed on the payment date of the payment period?
  8. Greek parameter

    Risk output type. Possible values are : PREMIUM, DELTA, GAMMA or VEGA (VEGA, not via the full integration via swaption method). All the greeks (except 'PREMIUM') output are equivalent to the mathematical notion of a derivative, thus if you would like to see the risk in terms of a finite movement (ie - 5 percent or 10 basis points move in the interested parameter) simply multiply the output amount by the shift of interest.


Extended information

Function Syntax

VB Syntax 


Double CTQryCurves.CMSOption( _
String OptionType, _
Double Strike, _
Long Start, _
Long EndDate, _
String CMSIndexKey, _
String VCKey, _
Boolean InArrears, _
String Greek)


Excel Spreadsheet Syntax 


=CT.MKT.CMSOption(
Excel String Cell OptionType,
Excel Numeric Cell Strike,
Excel Numeric Cell Start,
Excel Numeric Cell EndDate,
Excel String Cell CMSIndexKey,
Excel String Cell VCKey,
Excel Boolean Value Cell InArrears,
Excel String Cell Greek)


C++ Syntax 


static double CMSOption(
std::string OptionType,
double Strike,
long Start,
long EndDate,
std::string CMSIndexKey,
std::string VCKey,
bool InArrears,
std::string Greek);


DotNET Syntax 


System.Double CTQryCurvesSA.CMSOption(
System.String OptionType,
System.Double Strike,
System.Int32 Start,
System.Int32 EndDate,
System.String CMSIndexKey,
System.String VCKey,
System.Boolean InArrears,
System.String Greek);

Parameter data types

ArgNameArgTypeIsKey
OptionTypeStringFALSE
StrikeDoubleFALSE
StartLongFALSE
EndDateLongFALSE
CMSIndexKeyStringTRUE
VCKeyStringTRUE
InArrearsBooleanFALSE
GreekStringFALSE

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
OptionTypeFALSEcap
StrikeFALSE0.05
StartFALSE21/Jan/2006 (serial date type)
EndDateFALSE21/Jul/2006 (serial date type)
CMSIndexKeyFALSECMSIndexKeyNAME.EXTTAG.TICKER (from a function call)
VCKeyFALSEVCKeyNAME.EXTTAG.TICKER (from a function call)
InArrearsFALSEfalse
GreekFALSEPREMIUM


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.Curves20 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 CMSOption() 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 CMSOption() function call


0.00115422211424918

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