QuasiAMonteCarloEngine





http://www.QuantTools.com
CapeTools American Engine function list

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

Key TAGs | Excel Index | API Index



Creates a Quasi MonteCarlo Engine for pricing american options.

The simulation terminates when the required number of samples is reached.

The string 'Key' resulting from a successful construction of this engine object can be passed to the VanillaOption() function in order to create an VanillaOption object that can be priced via the PrcObjVanillaOption() 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 : "AQMCENG"



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




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

    Number of TOTAL steps for a single simulation. If this parameter is populated then the 'maxStepsPerYear' parameter must be set to zero (0). Same is true for the reverse case.
  4. maxStepsPerYear parameter

    Maximum number of steps PER YEAR. If this parameter is populated then the 'NoOfSteps' parameter must be set to zero (0).
  5. Samples parameter

    Number of samples.
  6. PolynomOrder parameter

    The polynomial order.
  7. BasisSystem parameter

    The Basis System type. Possible values are : 'Monomial', 'Laguerre', 'Hermite', 'Hyperbolic', 'Legendre', 'Chebyshev' or 'Chebyshev2th'.
  8. CalibSamples parameter

    The number of calibration samples. You can enter only positive valued values (including zero).
  9. Seed parameter

    Seed value.
  10. ControlVariate parameter

    With controlVariate variate?
  11. AntitheticVariate parameter

    With antithetic variate?


Extended information

Function Syntax

VB Syntax


String CTAmericanEngine.QuasiAMonteCarloEngine( _
String Key, _
Long Reload, _
Long NoOfSteps, _
Long maxStepsPerYear, _
Long Samples, _
Long PolynomOrder, _
String BasisSystem, _
Long CalibSamples, _
Long Seed, _
Boolean ControlVariate, _
Boolean AntitheticVariate)


Excel Spreadsheet Syntax


=CT.ENG.QuasiAMonteCarloEngine(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell NoOfSteps,
Excel Numeric Cell maxStepsPerYear,
Excel Numeric Cell Samples,
Excel Numeric Cell PolynomOrder,
Excel String Cell BasisSystem,
Excel Numeric Cell CalibSamples,
Excel Numeric Cell Seed,
Excel Boolean Value Cell ControlVariate,
Excel Boolean Value Cell AntitheticVariate)


C++ Syntax


static std::string QuasiAMonteCarloEngine(
std::string Key,
long Reload,
long NoOfSteps,
long maxStepsPerYear,
long Samples,
long PolynomOrder,
std::string BasisSystem,
long CalibSamples,
long Seed,
bool ControlVariate,
bool AntitheticVariate);


DotNET Syntax


System.String CTAmericanEngineSA.QuasiAMonteCarloEngine(
System.String Key,
System.Int32 Reload,
System.Int32 NoOfSteps,
System.Int32 maxStepsPerYear,
System.Int32 Samples,
System.Int32 PolynomOrder,
System.String BasisSystem,
System.Int32 CalibSamples,
System.Int32 Seed,
System.Boolean ControlVariate,
System.Boolean AntitheticVariate);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
NoOfStepsLongFALSE
maxStepsPerYearLongFALSE
SamplesLongFALSE
PolynomOrderLongFALSE
BasisSystemStringFALSE
CalibSamplesLongFALSE
SeedLongFALSE
ControlVariateBooleanFALSE
AntitheticVariateBooleanFALSE


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
KeyFALSEMyQuasiAMonteCarloEngine
ReloadFALSE1
NoOfStepsTRUE90
maxStepsPerYearTRUE0
SamplesFALSE40000
PolynomOrderFALSE2
BasisSystemFALSEMonomial
CalibSamplesTRUE2048
SeedFALSE42
ControlVariateFALSEfalse
AntitheticVariateFALSEtrue


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


MyQuasiAMonteCarloEngine_3.AQMCENG.0

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