RSKForEquOptInDomCur




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

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

Key TAGs | Excel Index | API Index


This is an option on foreign equity where the strike is denominated in domestic currency.

At expiry, the foreign equity is translated into the domestic currency.

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.RSKForEquOptInDomCur


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

    Spot exchange rate specified in units of the domestic currency per unit of the foreign currency.
  7. S parameter

    Underlying price in foreign currency
  8. X parameter

    Delivery price in domestic currency
  9. T parameter

    Time to option maturity.
  10. r parameter

    Domestic interest rate
  11. q parameter

    Instantaneous proportional dividend payout rate of the underlying asset
  12. vS parameter

    Volatility of the underlying asset.
  13. vE parameter

    Volatility of the foreign exchange rate.
  14. rho parameter

    Correlation between the asset and the foreign exchange rate.
  15. Greek parameter

    For the option premium specify 'PREMIUM'. For all first derivatives, you can specify one of the following : 'dE' (for the 'E' parameter), 'dS' (for the 'S' parameter), 'dX' (for the 'X' parameter), 'dT' (for the 'T' parameter), 'dr' (for the 'r' parameter), 'dq' (for the 'q' parameter), 'dvS' (for the 'vS' parameter), 'dvE' (for the 'vE' parameter), 'drho' (for the 'rho' parameter), For second order derivatives, you can specify combinations of the first order derivatives (i.e. - 'dSdS', 'dvSdvS', 'dSdvS'. )


Extended information

Function Syntax

VB Syntax 


Variant CTBumpRisk.RSKForEquOptInDomCur( _
Long ValueDate, _
DayCountEnum dayCounter, _
Variant BumpRange, _
String BumpParam, _
Variant CallPut, _
Variant E, _
Variant S, _
Variant X, _
Variant T, _
Variant r, _
Variant q, _
Variant vS, _
Variant vE, _
Variant rho, _
String Greek)


Excel Spreadsheet Syntax 


=CT.RSKForEquOptInDomCur(
Excel Numeric Cell ValueDate,
Excel String Cell dayCounter,
XLRange BumpRange,
Excel String Cell BumpParam,
XLRange CallPut,
XLRange E,
XLRange S,
XLRange X,
XLRange T,
XLRange r,
XLRange q,
XLRange vS,
XLRange vE,
XLRange rho,
Excel String Cell Greek)


C++ Syntax 


static CTRangeDataCPP RSKForEquOptInDomCur(
long ValueDate,
DayCountEnum dayCounter,
CTRangeDataCPP BumpRange,
std::string BumpParam,
CTRangeDataCPP CallPut,
CTRangeDataCPP E,
CTRangeDataCPP S,
CTRangeDataCPP X,
CTRangeDataCPP T,
CTRangeDataCPP r,
CTRangeDataCPP q,
CTRangeDataCPP vS,
CTRangeDataCPP vE,
CTRangeDataCPP rho,
std::string Greek);


DotNET Syntax 


CTRangeData CTBumpRiskSA.RSKForEquOptInDomCur(
System.Int32 ValueDate,
CTIEnums.DayCountEnum dayCounter,
CTRangeData BumpRange,
System.String BumpParam,
CTRangeData CallPut,
CTRangeData E,
CTRangeData S,
CTRangeData X,
CTRangeData T,
CTRangeData r,
CTRangeData q,
CTRangeData vS,
CTRangeData vE,
CTRangeData rho,
System.String Greek);

Parameter data types

ArgNameArgTypeIsKey
ValueDateLongFALSE
dayCounterDayCountEnumFALSE
BumpRangeRangeFALSE
BumpParamStringFALSE
CallPutRangeFALSE
ERangeFALSE
SRangeFALSE
XRangeFALSE
TRangeFALSE
rRangeFALSE
qRangeFALSE
vSRangeFALSE
vERangeFALSE
rhoRangeFALSE
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
BumpRangeFALSERSKForEquOptInDomCur_BumpRange_Range (creates a range object)
BumpParamFALSEvS
CallPutFALSERSKForEquOptInDomCur_CallPut_Range (creates a range object)
EFALSERSKForEquOptInDomCur_E_Range (creates a range object)
SFALSERSKForEquOptInDomCur_S_Range (creates a range object)
XFALSERSKForEquOptInDomCur_X_Range (creates a range object)
TFALSERSKForEquOptInDomCur_T_Range (creates a range object)
rFALSERSKForEquOptInDomCur_r_Range (creates a range object)
qFALSERSKForEquOptInDomCur_q_Range (creates a range object)
vSFALSERSKForEquOptInDomCur_vS_Range (creates a range object)
vEFALSERSKForEquOptInDomCur_vE_Range (creates a range object)
rhoFALSERSKForEquOptInDomCur_rho_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 RSKForEquOptInDomCur_BumpRange;


double[] arrBRSKForEquOptInDomCur_BumpRange = {
0.0196,
0.0206,
0.0187,
0.0187,
0.0187,
0.0186,
0.0196,
0.02,
0.0195,
0.0189,
0.02,
0.0203,
0.0191,
0.019,
0.0193,
0.0204,
0.0215,
0.0207,
0.0205,
0.02  //  Array Data

};

CTQL.DoubleVector arrRSKForEquOptInDomCur_BumpRange =
new  CTQL.DoubleVector(arrBRSKForEquOptInDomCur_BumpRange);

// Second parameter determines whether the array is a column array (false) or a row array (true)
RSKForEquOptInDomCur_BumpRange = new  CTQL.CTRangeData(arrRSKForEquOptInDomCur_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 RSKForEquOptInDomCur_CallPut;


string[] arrBRSKForEquOptInDomCur_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 arrRSKForEquOptInDomCur_CallPut =
new  CTQL.StringVector(arrBRSKForEquOptInDomCur_CallPut);

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

Example range for parameter : E

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


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

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


CTQL.CTRangeData RSKForEquOptInDomCur_E;


double[] arrBRSKForEquOptInDomCur_E = {
1.5948,
1.3892,
1.445,
1.5167,
1.6154,
1.4845,
1.3626,
1.5278,
1.4652,
1.4603,
1.4337,
1.3936,
1.4053,
1.6027,
1.494,
1.6258,
1.6441,
1.4548,
1.5072,
1.5  //  Array Data

};

CTQL.DoubleVector arrRSKForEquOptInDomCur_E =
new  CTQL.DoubleVector(arrBRSKForEquOptInDomCur_E);

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

Example range for parameter : S

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


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

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


CTQL.CTRangeData RSKForEquOptInDomCur_S;


double[] arrBRSKForEquOptInDomCur_S = {
94.475,
96.3611,
101.6586,
91.6486,
107.7808,
109.8274,
106.1084,
108.7532,
90.1047,
106.9427,
107.5017,
91.3557,
106.9507,
107.4446,
97.8757,
109.5938,
109.1551,
95.0746,
97.2562,
100.0  //  Array Data

};

CTQL.DoubleVector arrRSKForEquOptInDomCur_S =
new  CTQL.DoubleVector(arrBRSKForEquOptInDomCur_S);

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

Example range for parameter : X

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


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

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


CTQL.CTRangeData RSKForEquOptInDomCur_X;


int[] arrBRSKForEquOptInDomCur_X = {
151,
150,
166,
167,
145,
173,
155,
167,
158,
172,
152,
171,
166,
154,
160,
157,
155,
165,
169,
160  //  Array Data

};

CTQL.IntVector arrRSKForEquOptInDomCur_X =
new  CTQL.IntVector(arrBRSKForEquOptInDomCur_X);

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

Example range for parameter : T

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


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

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


CTQL.CTRangeData RSKForEquOptInDomCur_T;


int[] arrBRSKForEquOptInDomCur_T = {
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/1/2006", "dd/mm/yyyy")  //  Array Data

};

CTQL.IntVector arrRSKForEquOptInDomCur_T =
new  CTQL.IntVector(arrBRSKForEquOptInDomCur_T);

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

Example range for parameter : r

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


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

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


CTQL.CTRangeData RSKForEquOptInDomCur_r;


double[] arrBRSKForEquOptInDomCur_r = {
0.0795,
0.0836,
0.0855,
0.0757,
0.0802,
0.0766,
0.0767,
0.084,
0.0822,
0.0741,
0.078,
0.0863,
0.0765,
0.0754,
0.0767,
0.0861,
0.0777,
0.0745,
0.0761,
0.08  //  Array Data

};

CTQL.DoubleVector arrRSKForEquOptInDomCur_r =
new  CTQL.DoubleVector(arrBRSKForEquOptInDomCur_r);

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

Example range for parameter : q

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


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

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


CTQL.CTRangeData RSKForEquOptInDomCur_q;


double[] arrBRSKForEquOptInDomCur_q = {
0.046,
0.0505,
0.0451,
0.049,
0.0483,
0.0543,
0.0541,
0.053,
0.0459,
0.0455,
0.0512,
0.0527,
0.0466,
0.0462,
0.0526,
0.0497,
0.0538,
0.052,
0.0452,
0.05  //  Array Data

};

CTQL.DoubleVector arrRSKForEquOptInDomCur_q =
new  CTQL.DoubleVector(arrBRSKForEquOptInDomCur_q);

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

Example range for parameter : vS

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


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

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


CTQL.CTRangeData RSKForEquOptInDomCur_vS;


double[] arrBRSKForEquOptInDomCur_vS = {
0.2067,
0.1889,
0.2168,
0.2068,
0.1831,
0.1925,
0.2175,
0.1804,
0.1853,
0.1877,
0.1965,
0.1994,
0.1904,
0.1955,
0.1936,
0.1966,
0.2032,
0.194,
0.2168,
0.20  //  Array Data

};

CTQL.DoubleVector arrRSKForEquOptInDomCur_vS =
new  CTQL.DoubleVector(arrBRSKForEquOptInDomCur_vS);

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

Example range for parameter : vE

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


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

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


CTQL.CTRangeData RSKForEquOptInDomCur_vE;


double[] arrBRSKForEquOptInDomCur_vE = {
0.1168,
0.1271,
0.1202,
0.1092,
0.1153,
0.1103,
0.1206,
0.1202,
0.1242,
0.1083,
0.1297,
0.1128,
0.116,
0.1096,
0.1299,
0.1298,
0.1144,
0.1162,
0.1109,
0.12  //  Array Data

};

CTQL.DoubleVector arrRSKForEquOptInDomCur_vE =
new  CTQL.DoubleVector(arrBRSKForEquOptInDomCur_vE);

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

Example range for parameter : rho

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


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

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


CTQL.CTRangeData RSKForEquOptInDomCur_rho;


double[] arrBRSKForEquOptInDomCur_rho = {
0.428,
0.4124,
0.4353,
0.4772,
0.4422,
0.4499,
0.4653,
0.4331,
0.4595,
0.4053,
0.4195,
0.4113,
0.4846,
0.4726,
0.4421,
0.4124,
0.4767,
0.4424,
0.4469,
0.45  //  Array Data

};

CTQL.DoubleVector arrRSKForEquOptInDomCur_rho =
new  CTQL.DoubleVector(arrBRSKForEquOptInDomCur_rho);

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


Example
0.762091
0.703648
0.747375
0.813633
0.440288
0.81103
0.749417
0.559093
0.886304
0.443787
0.646206
0.86664
0.588432
0.650211
0.3442
0.765432
0.668668
0.271488
0.671232
0.755618



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