CliquetOption





http://www.QuantTools.com
CapeTools EngineOptions function list

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

Key TAGs | Excel Index | API Index



Creates a Cliquet Option object.

This function requires the input of a Payoff object key, which must have been produced via a call to PercentageStrike(). This function would have returned a string 'KEY' which is to be passed to the 'payoff' parameter of this function.

Once the object has been constructed, the value of the option can be obtained by executing the PrcObjCliquetOption() function.

This function requires the input of a BlackScholes Process object key, which must have been produced via a call to one of the following functions : GBSProcess(), GBSProcess2(), BS73Process(), BS73Process2(), BlackProcess(), BlackProcess2(), GKProcess() or GKProcess2(). These functions would have returned a string 'KEY' which is to be passed to the 'stochProcess' parameter of this function.

This function requires the input of a payoff object key, which must have been produced via a call to one of the following functions : PlainVanilla(), PercentageStrike(), CashOrNothing(), AssetOrNothingPayoff() or Gap(). These functions would have returned a string 'KEY' which is to be passed to the 'payoff' parameter of this function.

This function requires the input of a exercise object key, which must have been produced via a call to the EuropeanExercise() function.

This function would have returned a string 'KEY' which is to be passed to the 'exercise' parameter of this function.

This function requires the input of an engine object key, which must have been produced via a call to one of the following functions : AnaCliquetEngine() or AnaPerformanceEngine(). These functions would have returned a string 'KEY' which is to be passed to the 'engine' parameter of this function.



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



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




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

    Key to an already constructed BlackScholesProcess object.
  4. payoff parameter

    Key to an already constructed PercentageStrikePayoff object.
  5. exercise parameter

    Key to an already constructed EuropeanExercise object.
  6. reset parameter

    A range of reset dates.
  7. engine parameter

    Key to an already constructed PricingEngine object.


Extended information

Function Syntax

VB Syntax


String CTEngineOptions.CliquetOption( _
String Key, _
Long Reload, _
String stochProcess, _
String payoff, _
String exercise, _
Variant reset, _
String engine)


Excel Spreadsheet Syntax


=CT.OPT.CliquetOption(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell stochProcess,
Excel String Cell payoff,
Excel String Cell exercise,
XLRange reset,
Excel String Cell engine)


C++ Syntax


static std::string CliquetOption(
std::string Key,
long Reload,
std::string stochProcess,
std::string payoff,
std::string exercise,
CTRangeDataCPP reset,
std::string engine);


DotNET Syntax


System.String CTEngineOptionsSA.CliquetOption(
System.String Key,
System.Int32 Reload,
System.String stochProcess,
System.String payoff,
System.String exercise,
CTRangeData reset,
System.String engine);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
stochProcessStringTRUE
payoffStringTRUE
exerciseStringTRUE
resetRangeFALSE
engineStringTRUE


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
KeyFALSEMyCliquetOption
ReloadFALSE1
stochProcessFALSEstochProcessNAME.EXTTAG.TICKER (from a function call)
payoffFALSEpayoffNAME.EXTTAG.TICKER (from a function call)
exerciseFALSEexerciseNAME.EXTTAG.TICKER (from a function call)
resetFALSECliquetOption_reset_Range (creates a range object)
engineFALSEengineNAME.EXTTAG.TICKER (from a function call)


Example range for parameter : reset

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


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

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



CTQL.CTRangeData CliquetOption_reset;


int[] arrBCliquetOption_reset = {
CTQL.Date.serialNumber("26/7/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("2/8/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("9/8/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("16/8/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("23/8/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("30/8/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("6/9/2005", "dd/mm/yyyy"),
CTQL.Date.serialNumber("13/9/2005", "dd/mm/yyyy")  //  Array Data

};

CTQL.IntVector arrCliquetOption_reset =
new  CTQL.IntVector(arrBCliquetOption_reset);

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


MyCliquetOption_13.CLQOPT.0

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