BasketOption





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

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

Key TAGs | Excel Index | API Index



Creates a Basket Option object.

This function can employ different pricing engines (Analytical and MonteCarlo).

Once the object has been constructed, the value of the option can be obtained by executing the PrcObjBasketOption() 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() functions.

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 payoff object key, which must have been produced via a call to the PlainVanilla() function.

This function 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 one of the following functions : AmericanExercise(), EuropeanExercise(), BermudanExercise(), ExerciseFromLeg(), ExerciseFromSche(), ExerciseFromSW(), ExerciseFromFIXBND() or ExerciseFromFLTBND(). These functions 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 Basket Engine creation functions present within the CapeTools Basket Engine category of functions.

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



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




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

    Type of Basket option. Min, Max
  4. stochProcesses parameter

    Key to a list (range) of already constructed StochasticProcess objects.
  5. payoff parameter

    Key to an already constructed Payoff object.
  6. exercise parameter

    Key to an already constructed Exercise object.
  7. corrMatrix parameter

    CorrelationMatrix between the various processes.
  8. engine parameter

    Key to an already constructed PricingEngine object.


Extended information

Function Syntax

VB Syntax


String CTEngineOptions.BasketOption( _
String Key, _
Long Reload, _
String basketType, _
Variant stochProcesses, _
String payoff, _
String exercise, _
Variant corrMatrix, _
String engine)


Excel Spreadsheet Syntax


=CT.OPT.BasketOption(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell basketType,
XLRange stochProcesses,
Excel String Cell payoff,
Excel String Cell exercise,
XLRange corrMatrix,
Excel String Cell engine)


C++ Syntax


static std::string BasketOption(
std::string Key,
long Reload,
std::string basketType,
CTRangeDataCPP stochProcesses,
std::string payoff,
std::string exercise,
CTRangeDataCPP corrMatrix,
std::string engine);


DotNET Syntax


System.String CTEngineOptionsSA.BasketOption(
System.String Key,
System.Int32 Reload,
System.String basketType,
CTRangeData stochProcesses,
System.String payoff,
System.String exercise,
CTRangeData corrMatrix,
System.String engine);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
basketTypeStringFALSE
stochProcessesRangeTRUE
payoffStringTRUE
exerciseStringTRUE
corrMatrixRangeFALSE
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
KeyFALSEMyBasketOption
ReloadFALSE1
basketTypeFALSEMin
stochProcessesFALSEstochProcessesNAME.EXTTAG.TICKER (from a function call)
payoffFALSEpayoffNAME.EXTTAG.TICKER (from a function call)
exerciseFALSEexerciseNAME.EXTTAG.TICKER (from a function call)
corrMatrixFALSEBasketOption_corrMatrix_Range (creates a range object)
engineFALSEengineNAME.EXTTAG.TICKER (from a function call)


Example range for parameter : corrMatrix

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

10.76450.780.80270.8362
0.764510.78950.81020.8427
0.780.789510.81750.8498
0.80270.81020.817510.8595
0.83620.84270.84980.85951

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



CTQL.CTRangeData BasketOption_corrMatrix = new CTQL.CTRangeData();

System.Text.StringBuilder BasketOption_corrMatrix_builder =
new System.Text.StringBuilder(100);

BasketOption_corrMatrix_builder.Append("{");
BasketOption_corrMatrix_builder.Append("1	 | 0.7645	 | 0.78	 | 0.8027	 | 0.8362 ;");
BasketOption_corrMatrix_builder.Append("0.7645	 | 1	 | 0.7895	 | 0.8102	 | 0.8427 ;");
BasketOption_corrMatrix_builder.Append("0.78	 | 0.7895	 | 1	 | 0.8175	 | 0.8498 ;");
BasketOption_corrMatrix_builder.Append("0.8027	 | 0.8102	 | 0.8175	 | 1	 | 0.8595 ;");
BasketOption_corrMatrix_builder.Append("0.8362	 | 0.8427	 | 0.8498	 | 0.8595	 | 1");
BasketOption_corrMatrix_builder.Append("}");

// Parse the string into the Range object.
BasketOption_corrMatrix.RangeFromStr( BasketOption_corrMatrix_builder.ToString() );



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


MyBasketOption_11.BASOPT.0

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