RSKTimeSwitchOption




http://www.QuantTools.com
CapeTools Bump Risk function list

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

Key TAGs | Excel Index | API Index


Accumulates cash for every time unit the option is in the money.

This function utilizes an analytical (closed-form) algorithm.

Note that the risk (greek) numbers produced are the mathematically defined equivalent of a derivative (instantaneous change).

You can convert the risk number to your own definition of risk by multiplying by the shift you require.

For example, for a typical definition of VANNA, (change in underlying and volatility), where one defines the change in the underlying as a single unit of change (1.0) and the change in volatility as a one percent change (0.01), simply multiply the VANNA result calculated by (1.0*0.01).

For VEGA, change in volatility of one percent (0.01), simply multiply the VEGA result by 0.01. Within option contracts THETA is negative, however the mathematically defined equivalent of THETA (instantaneous FORWARD change in time) is positive.

Internally we have negated this value for you.

To express THETA as THETA per day, simply multiply the THETA result by 1/365 or 1/252 (depending on whether you require calendar days or business days).

This function bumps an input parameter given a bump map and displays the difference from the base value.

You can request to see the difference of any of the option greeks.

The name of the parameter that you wish to bump is simply entered into the 'BumpParam' string parameter.

The bump map can be a single value, a vector or a matrix input.



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


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



Parameter Description


  1. ValueDate parameter

    Valuation Date (typically equal to Today's date)
  2. dayCounter parameter

    For any input parameter within this function that represents a dividend rate, risk free rate, foreign rate or holding cost rate, these rates will be defined as annually compounded using the DayCounter defined within this parameter. Thus if 'actual365' is used for this 'dayCounter' parameter, then all input parameters that represent a dividend, risk free, foreign or holding cost rates will be defined as annually compounded Actual365 rates.
  3. BumpRange parameter

    A range of bump values, of which the chosen input will be bumped by. For Equity, FX type deals, you can provide a single value, vector or matrix, for interest rate type products, the bump range must be of the same shape as the market curve.
  4. BumpParam parameter

    The parameter in which will be bumped, you can only choose parameters in which the ranges normally take double (decimal) values.
  5. CallPut parameter

    Option Types (C)all or (P)ut
  6. Underlying parameter

    Underlying price, curve
  7. Strike parameter

    Strike price.
  8. A parameter

    Notional amount. In a call (put) option, the investor accumulates dA*dt for each dt that the corresponding price Si dt has exceeded (was below) the strike price X.
  9. TimeT parameter

    Time to maturity of the option.
  10. m parameter

    If some of the options total lifetime has already passed, dm if the number of time units where the option has fulfilled its condition.
  11. Timedt parameter

    Time unit in which the condition is tested for.
  12. Rate parameter

    For the underlying (equity, futures, FX or commodity), this should be an annualised rate (risk free rate or foreign rate). If this is an option on a FX underlying, then if the underlying is quoted as domestic/foreign then this rate will be the domestic rate. If, however, the FX underlying is quoted as foreign/domestic then this will be the foreign rate.
  13. B parameter

    For the underlying (equity, futures, FX or commodity), this should be an annualised rate (dividend rate, risk free rate, foreign rate or holding cost rate respectively). If this is an option on a FX underlying, then if the underlying is quoted as domestic/foreign then this rate will be the foreign rate. If, however, the FX underlying is quoted as foreign/domestic then this will be the domestic rate.
  14. Vol parameter

    Volatility of the underlying.
  15. Greek parameter

    For the option premium specify 'PREMIUM'. For all first derivatives, you can specify one of the following : 'dUnderlying' (for the 'Underlying' parameter), 'dStrike' (for the 'Strike' parameter), 'dA' (for the 'A' parameter), 'dTimeT' (for the 'TimeT' parameter), 'dTimedt' (for the 'Timedt' parameter), 'dRate' (for the 'Rate' parameter), 'dB' (for the 'B' parameter), 'dVol' (for the 'Vol' parameter), For second order derivatives, you can specify combinations of the first order derivatives (i.e. - 'dUnderlyingdUnderlying', 'dVoldVol', 'dUnderlyingdVol'. )


Extended information

Function Syntax

VB Syntax 


Variant CTBumpRisk.RSKTimeSwitchOption( _
Long ValueDate, _
DayCountEnum dayCounter, _
Variant BumpRange, _
String BumpParam, _
Variant CallPut, _
Variant Underlying, _
Variant Strike, _
Variant A, _
Variant TimeT, _
Variant m, _
Variant Timedt, _
Variant Rate, _
Variant B, _
Variant Vol, _
String Greek)


Excel Spreadsheet Syntax 


=CT.RSKTimeSwitchOption(
Excel Numeric Cell ValueDate,
Excel String Cell dayCounter,
XLRange BumpRange,
Excel String Cell BumpParam,
XLRange CallPut,
XLRange Underlying,
XLRange Strike,
XLRange A,
XLRange TimeT,
XLRange m,
XLRange Timedt,
XLRange Rate,
XLRange B,
XLRange Vol,
Excel String Cell Greek)


C++ Syntax 


static CTRangeDataCPP RSKTimeSwitchOption(
long ValueDate,
DayCountEnum dayCounter,
CTRangeDataCPP BumpRange,
std::string BumpParam,
CTRangeDataCPP CallPut,
CTRangeDataCPP Underlying,
CTRangeDataCPP Strike,
CTRangeDataCPP A,
CTRangeDataCPP TimeT,
CTRangeDataCPP m,
CTRangeDataCPP Timedt,
CTRangeDataCPP Rate,
CTRangeDataCPP B,
CTRangeDataCPP Vol,
std::string Greek);


DotNET Syntax 


CTRangeData CTBumpRiskSA.RSKTimeSwitchOption(
System.Int32 ValueDate,
CTIEnums.DayCountEnum dayCounter,
CTRangeData BumpRange,
System.String BumpParam,
CTRangeData CallPut,
CTRangeData Underlying,
CTRangeData Strike,
CTRangeData A,
CTRangeData TimeT,
CTRangeData m,
CTRangeData Timedt,
CTRangeData Rate,
CTRangeData B,
CTRangeData Vol,
System.String Greek);

Parameter data types

ArgNameArgTypeIsKey
ValueDateLongFALSE
dayCounterDayCountEnumFALSE
BumpRangeRangeFALSE
BumpParamStringFALSE
CallPutRangeFALSE
UnderlyingRangeFALSE
StrikeRangeFALSE
ARangeFALSE
TimeTRangeFALSE
mRangeFALSE
TimedtRangeFALSE
RateRangeFALSE
BRangeFALSE
VolRangeFALSE
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
ValueDateFALSE19/Jul/2005 (serial date type)
dayCounterFALSEACT365
BumpRangeFALSERSKTimeSwitchOption_BumpRange_Range (creates a range object)
BumpParamFALSEVol
CallPutFALSERSKTimeSwitchOption_CallPut_Range (creates a range object)
UnderlyingFALSERSKTimeSwitchOption_Underlying_Range (creates a range object)
StrikeFALSERSKTimeSwitchOption_Strike_Range (creates a range object)
AFALSERSKTimeSwitchOption_A_Range (creates a range object)
TimeTFALSERSKTimeSwitchOption_TimeT_Range (creates a range object)
mFALSERSKTimeSwitchOption_m_Range (creates a range object)
TimedtFALSERSKTimeSwitchOption_Timedt_Range (creates a range object)
RateFALSERSKTimeSwitchOption_Rate_Range (creates a range object)
BFALSERSKTimeSwitchOption_B_Range (creates a range object)
VolFALSERSKTimeSwitchOption_Vol_Range (creates a range object)
GreekFALSEPREMIUM


Example range for parameter : BumpRange

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_BumpRange;


double[] arrBRSKTimeSwitchOption_BumpRange = {
0.0197,
0.0192,
0.0203,
0.0191,
0.0216,
0.0205,
0.0206,
0.019,
0.0212,
0.0211,
0.0219,
0.0187,
0.0206,
0.0208,
0.0182,
0.0205,
0.0199,
0.0214,
0.0214,
0.02  //  Array Data

};

CTQL.DoubleVector arrRSKTimeSwitchOption_BumpRange =
new  CTQL.DoubleVector(arrBRSKTimeSwitchOption_BumpRange);

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

Example range for parameter : CallPut

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_CallPut;


string[] arrBRSKTimeSwitchOption_CallPut = {
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call",
"Call"  //  Array Data

};

CTQL.StringVector arrRSKTimeSwitchOption_CallPut =
new  CTQL.StringVector(arrBRSKTimeSwitchOption_CallPut);

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

Example range for parameter : Underlying

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_Underlying;


int[] arrBRSKTimeSwitchOption_Underlying = {
102,
92,
92,
100,
96,
98,
94,
103,
109,
98,
104,
104,
94,
108,
108,
96,
91,
101,
98,
100  //  Array Data

};

CTQL.IntVector arrRSKTimeSwitchOption_Underlying =
new  CTQL.IntVector(arrBRSKTimeSwitchOption_Underlying);

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

Example range for parameter : Strike

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_Strike;


int[] arrBRSKTimeSwitchOption_Strike = {
108,
103,
114,
110,
121,
118,
113,
118,
112,
102,
118,
108,
110,
103,
109,
111,
112,
112,
113,
110  //  Array Data

};

CTQL.IntVector arrRSKTimeSwitchOption_Strike =
new  CTQL.IntVector(arrBRSKTimeSwitchOption_Strike);

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

Example range for parameter : A

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_A;


int[] arrBRSKTimeSwitchOption_A = {
5,
5,
5,
5,
5,
5,
5,
5,
5,
5,
5,
5,
5,
5,
5,
5,
5,
5,
5,
5  //  Array Data

};

CTQL.IntVector arrRSKTimeSwitchOption_A =
new  CTQL.IntVector(arrBRSKTimeSwitchOption_A);

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

Example range for parameter : TimeT

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_TimeT;


int[] arrBRSKTimeSwitchOption_TimeT = {
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("19/7/2006", "dd/mm/yyyy")  //  Array Data

};

CTQL.IntVector arrRSKTimeSwitchOption_TimeT =
new  CTQL.IntVector(arrBRSKTimeSwitchOption_TimeT);

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

Example range for parameter : m

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_m;


int[] arrBRSKTimeSwitchOption_m = {
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0  //  Array Data

};

CTQL.IntVector arrRSKTimeSwitchOption_m =
new  CTQL.IntVector(arrBRSKTimeSwitchOption_m);

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

Example range for parameter : Timedt

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_Timedt;


int[] arrBRSKTimeSwitchOption_Timedt = {
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("20/7/2005", "dd/mm/yyyy")  //  Array Data

};

CTQL.IntVector arrRSKTimeSwitchOption_Timedt =
new  CTQL.IntVector(arrBRSKTimeSwitchOption_Timedt);

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

Example range for parameter : Rate

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_Rate;


double[] arrBRSKTimeSwitchOption_Rate = {
0.0616,
0.061,
0.0642,
0.0614,
0.0635,
0.0568,
0.0624,
0.0646,
0.0637,
0.0659,
0.0572,
0.0652,
0.0618,
0.0629,
0.0591,
0.0594,
0.0581,
0.0569,
0.06,
0.06  //  Array Data

};

CTQL.DoubleVector arrRSKTimeSwitchOption_Rate =
new  CTQL.DoubleVector(arrBRSKTimeSwitchOption_Rate);

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

Example range for parameter : B

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_B;


double[] arrBRSKTimeSwitchOption_B = {
0.0181,
0.0199,
0.0191,
0.0188,
0.0196,
0.0181,
0.0214,
0.022,
0.0205,
0.0204,
0.02,
0.0183,
0.0201,
0.0216,
0.018,
0.0207,
0.0202,
0.02,
0.0194,
0.02  //  Array Data

};

CTQL.DoubleVector arrRSKTimeSwitchOption_B =
new  CTQL.DoubleVector(arrBRSKTimeSwitchOption_B);

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

Example range for parameter : Vol

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


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

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


CTQL.CTRangeData RSKTimeSwitchOption_Vol;


double[] arrBRSKTimeSwitchOption_Vol = {
0.2789,
0.2637,
0.2697,
0.2373,
0.2572,
0.2699,
0.2842,
0.2632,
0.2444,
0.2823,
0.2341,
0.2572,
0.2767,
0.2605,
0.2439,
0.2518,
0.2851,
0.2714,
0.2718,
0.26  //  Array Data

};

CTQL.DoubleVector arrRSKTimeSwitchOption_Vol =
new  CTQL.DoubleVector(arrBRSKTimeSwitchOption_Vol);

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


Example
0.0420253
0.0426376
0.0566297
-0.0271593
0.0226789
0.0540963
0.0553961
-0.0243436
0.0362334
-0.020904
-0.00576542
0.0548139
0.0325918
0.0491155
0.0417978
-0.0289904
0.0575298
0.0522627
-0.0513913
0.0384101



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