DisplayYCHedgeSens2





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 and a Discounting YieldCurve and an array of hedge instrument tenors, this function will display the sensitivity vector (delta) on each of the hedge instruments (for a unit notional).

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.



Note: Within Excel, the function is named - CT.RSK.DisplayYCHedgeSens2




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

    An array of hedge Tenors in which the sensitivity will be computed for.


Extended information

Function Syntax

VB Syntax


Variant CTQryIRRisk.DisplayYCHedgeSens2( _
String FixingYC, _
String DiscountYC, _
Variant HedgeTenors)


Excel Spreadsheet Syntax


=CT.RSK.DisplayYCHedgeSens2(
Excel String Cell FixingYC,
Excel String Cell DiscountYC,
XLRange HedgeTenors)


C++ Syntax


static CTRangeDataCPP DisplayYCHedgeSens2(
std::string FixingYC,
std::string DiscountYC,
CTRangeDataCPP HedgeTenors);


DotNET Syntax


CTRangeData CTQryIRRiskSA.DisplayYCHedgeSens2(
System.String FixingYC,
System.String DiscountYC,
CTRangeData HedgeTenors);

Parameter data types

ArgNameArgTypeIsKey
FixingYCStringTRUE
DiscountYCStringTRUE
HedgeTenorsRangeFALSE


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)
HedgeTenorsFALSEDisplayYCHedgeSens2_HedgeTenors_Range (creates a range object)


Example range for parameter : HedgeTenors

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


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

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



CTQL.CTRangeData DisplayYCHedgeSens2_HedgeTenors;


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

};

CTQL.StringVector arrDisplayYCHedgeSens2_HedgeTenors =
new  CTQL.StringVector(arrBDisplayYCHedgeSens2_HedgeTenors);

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


Example
3M0.24666
6M0.486913
1Y0.942369
2Y1.87142
3Y2.78001
5Y4.55668
7Y6.29126
10Y8.77698
15Y12.6506
20Y16.1047



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