SABRCalibInst





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

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

Key TAGs | Excel Index | API Index



Creates an array of SABR Vol points in order to calibrate the ATMVol, Alpha, Beta and Rho parameters of the SABR model.



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



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




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

    Valuation Date (typically equal to Today's date)
  4. ExerciseDate parameter

    Exercise date of the Volatility point that you want to calibrate.
  5. StrikeArray parameter

    An array range of strike values that corresponds to the volatility smile curve.
  6. VolArray parameter

    The volatility smile. The points must correspond to the strikes within the 'StrikeArray' parameter.
  7. ATMRate parameter

    The At-the-money Forward rate for the underlying instrument (ie - Forward of a 6M rate starting after the exercise date, if the underlying is the 6M rate).
  8. DayCount parameter

    The DayCounter to use for the calculation of the option maturity year fraction between the ValueDate and the Exercise Date.


Extended information

Function Syntax

VB Syntax


String CTSABRCalibration.SABRCalibInst( _
String Key, _
Long Reload, _
Long ValueDate, _
Long ExerciseDate, _
Variant StrikeArray, _
Variant VolArray, _
Double ATMRate, _
DayCountEnum DayCount)


Excel Spreadsheet Syntax


=CT.CAL.SABRCalibInst(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell ValueDate,
Excel Numeric Cell ExerciseDate,
XLRange StrikeArray,
XLRange VolArray,
Excel Numeric Cell ATMRate,
Excel String Cell DayCount)


C++ Syntax


static std::string SABRCalibInst(
std::string Key,
long Reload,
long ValueDate,
long ExerciseDate,
CTRangeDataCPP StrikeArray,
CTRangeDataCPP VolArray,
double ATMRate,
DayCountEnum DayCount);


DotNET Syntax


System.String CTSABRCalibrationSA.SABRCalibInst(
System.String Key,
System.Int32 Reload,
System.Int32 ValueDate,
System.Int32 ExerciseDate,
CTRangeData StrikeArray,
CTRangeData VolArray,
System.Double ATMRate,
CTIEnums.DayCountEnum DayCount);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
ValueDateLongFALSE
ExerciseDateLongFALSE
StrikeArrayRangeFALSE
VolArrayRangeFALSE
ATMRateDoubleFALSE
DayCountDayCountEnumFALSE


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
KeyFALSEMySABRCalibInst
ReloadFALSE1
ValueDateFALSE19/Jul/2005 (serial date type)
ExerciseDateFALSE21/Jan/2006 (serial date type)
StrikeArrayFALSESABRCalibInst_StrikeArray_Range (creates a range object)
VolArrayFALSESABRCalibInst_VolArray_Range (creates a range object)
ATMRateFALSE0.05
DayCountFALSEACT360


Example range for parameter : StrikeArray

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


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

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



CTQL.CTRangeData SABRCalibInst_StrikeArray;


double[] arrBSABRCalibInst_StrikeArray = {
0.02,
0.025,
0.03,
0.035,
0.04,
0.045,
0.05,
0.055,
0.06,
0.065,
0.07,
0.075  //  Array Data

};

CTQL.DoubleVector arrSABRCalibInst_StrikeArray =
new  CTQL.DoubleVector(arrBSABRCalibInst_StrikeArray);

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


Example range for parameter : VolArray

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


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

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



CTQL.CTRangeData SABRCalibInst_VolArray;


double[] arrBSABRCalibInst_VolArray = {
0.29,
0.275,
0.265,
0.242,
0.23,
0.22,
0.22,
0.25,
0.29,
0.31,
0.34,
0.37  //  Array Data

};

CTQL.DoubleVector arrSABRCalibInst_VolArray =
new  CTQL.DoubleVector(arrBSABRCalibInst_VolArray);

// Second parameter determines whether the array is a column array (false) or a row array (true)
SABRCalibInst_VolArray = new  CTQL.CTRangeData(arrSABRCalibInst_VolArray, 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.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 SABRCalibInst() 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.


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 SABRCalibInst() function call


MySABRCalibInst_1.SABRCAL.0

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