DisplayVCHedgeSens3





http://www.QuantTools.com
CapeTools Query IR Risk function list

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

Key TAGs | Excel Index | API Index



Given a Fixing YieldCurve, Discounting YieldCurve and a VolCurve, this function will display the sensitivity matrix (vega) on each of the ('option maturity' / 'Option Strike') hedge instrument combination (for a unit notional) on a single underlying Tenor.

You must provide the actual Option maturity and option strike arrays.

You also provide a single tenor to represent the underlying instrument that the sensitivities will be computed upon.

This underlying instrument represents the underlying contract of the caplet/Swaption trade that will be created in order to compute the vega.

If the Fixing curve and the discounting curves are the same, enter the same key for both parameters.

This function requires the input of YieldCurve object keys, which must have been produced via a call to one of the YieldCurve (CapeTools Curves, CapeTools XCCY Curves or CapeTools Bond Curves) or Credit Default Curves (CapeTools Credit Curves) category of functions.

(For the FixingYC, you cannot use the DiscountCurve(), ForwardCurve(), ZeroCurve(), DiscountCurve2(), ForwardCurve2(), ZeroCurve2() or FlatYieldCurve() functions as these do not contain enough information for hedging.).

For the discounting yieldcurve, these additional 3 functions can also be used : DiscountCurve2(), ForwardCurve2() or ZeroCurve2(). These functions would have returned a string 'KEY' which is to be passed to the 'FixingYC' and 'DiscountYC' parameters 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 : 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.RSK.DisplayVCHedgeSens3




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



Parameter Description


  1. FixingYC parameter

    Key to an already created yieldcurve object.
  2. DiscountYC parameter

    Key to an already created yieldcurve object.
  3. VCKey parameter

    Key to an already created volcurve object.
  4. UndTenor parameter

    The underlying that the sensitivities (vega) will be computed upon. This underlying instrument represents the underlying contract of the caplet/Swaption trade that will be created in order to compute the vega.
  5. OptMaturities parameter

    An array of option maturity tenors. The exercise dates will be computed as the calculation date from the VolCurve, plus the Option maturity tenors.
  6. OptStrikes parameter

    An array of strikes (in percent).


Extended information

Function Syntax

VB Syntax


Variant CTQryIRRisk.DisplayVCHedgeSens3( _
String FixingYC, _
String DiscountYC, _
String VCKey, _
String UndTenor, _
Variant OptMaturities, _
Variant OptStrikes)


Excel Spreadsheet Syntax


=CT.RSK.DisplayVCHedgeSens3(
Excel String Cell FixingYC,
Excel String Cell DiscountYC,
Excel String Cell VCKey,
Excel String Cell UndTenor,
XLRange OptMaturities,
XLRange OptStrikes)


C++ Syntax


static CTRangeDataCPP DisplayVCHedgeSens3(
std::string FixingYC,
std::string DiscountYC,
std::string VCKey,
std::string UndTenor,
CTRangeDataCPP OptMaturities,
CTRangeDataCPP OptStrikes);


DotNET Syntax


CTRangeData CTQryIRRiskSA.DisplayVCHedgeSens3(
System.String FixingYC,
System.String DiscountYC,
System.String VCKey,
System.String UndTenor,
CTRangeData OptMaturities,
CTRangeData OptStrikes);

Parameter data types

ArgNameArgTypeIsKey
FixingYCStringTRUE
DiscountYCStringTRUE
VCKeyStringTRUE
UndTenorStringFALSE
OptMaturitiesRangeFALSE
OptStrikesRangeFALSE


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
FixingYCFALSEFixingYCNAME.EXTTAG.TICKER (from a function call)
DiscountYCFALSEDiscountYCNAME.EXTTAG.TICKER (from a function call)
VCKeyFALSEVCKeyNAME.EXTTAG.TICKER (from a function call)
UndTenorFALSE5Y
OptMaturitiesFALSEDisplayVCHedgeSens3_OptMaturities_Range (creates a range object)
OptStrikesFALSEDisplayVCHedgeSens3_OptStrikes_Range (creates a range object)


Example range for parameter : OptMaturities

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


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

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



CTQL.CTRangeData DisplayVCHedgeSens3_OptMaturities;


string[] arrBDisplayVCHedgeSens3_OptMaturities = {
"3M",
"6M",
"1Y",
"2Y",
"3Y",
"5Y",
"7Y",
"10Y"  //  Array Data

};

CTQL.StringVector arrDisplayVCHedgeSens3_OptMaturities =
new  CTQL.StringVector(arrBDisplayVCHedgeSens3_OptMaturities);

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


Example range for parameter : OptStrikes

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


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

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



CTQL.CTRangeData DisplayVCHedgeSens3_OptStrikes;


double[] arrBDisplayVCHedgeSens3_OptStrikes = {
2.0,
2.5,
3.0,
3.5,
4.0,
4.5,
5.0,
5.5,
6.0,
6.5  //  Array Data

};

CTQL.DoubleVector arrDisplayVCHedgeSens3_OptStrikes =
new  CTQL.DoubleVector(arrBDisplayVCHedgeSens3_OptStrikes);

// Second parameter determines whether the array is a column array (false) or a row array (true)
DisplayVCHedgeSens3_OptStrikes = new  CTQL.CTRangeData(arrDisplayVCHedgeSens3_OptStrikes, 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.IRRisk20 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 DisplayVCHedgeSens3() 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 DisplayVCHedgeSens3() function call


Example
OptMat/Strike22.533.544.555.566.5
3M6.68291e-0056.68291e-0056.68291e-0056.68291e-0056.68291e-0056.68291e-0056.68291e-0056.68291e-0056.68291e-0056.68291e-005
6M0.006993830.006993830.006993830.006993830.006993830.006993830.006993830.006993830.006993830.00699383
1Y0.03969290.03969290.03969290.03969290.03969290.03969290.03969290.03969290.03969290.0396929
2Y0.0860890.0860890.0860890.0860890.0860890.0860890.0860890.0860890.0860890.086089
3Y0.1186270.1186270.1186270.1186270.1186270.1186270.1186270.1186270.1186270.118627
5Y0.1517860.1517860.1517860.1517860.1517860.1517860.1517860.1517860.1517860.151786
7Y0.1763150.1763150.1763150.1763150.1763150.1763150.1763150.1763150.1763150.176315
10Y0.1916310.1916310.1916310.1916310.1916310.1916310.1916310.1916310.1916310.191631



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