AmericanExercise




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

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

Key TAGs | Excel Index | API Index


Creates an American Exercise object.

The string 'Key' resulting from a successful construction of this 'Exercise' object can be passed to the functions present within the CapeTools EngineOptions category of functions.



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



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


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

    Earliest date.
  4. latestDate parameter

    LatestDate date.
  5. payoffAtExpiry parameter

    Whether you like the payoff at the Expiry Date.


Extended information

Function Syntax

VB Syntax 


String CTExercise.AmericanExercise( _
String Key, _
Long Reload, _
Long earliestDate, _
Long latestDate, _
Boolean payoffAtExpiry)


Excel Spreadsheet Syntax 


=CT.EX.AmericanExercise(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell earliestDate,
Excel Numeric Cell latestDate,
Excel Boolean Value Cell payoffAtExpiry)


C++ Syntax 


static std::string AmericanExercise(
std::string Key,
long Reload,
long earliestDate,
long latestDate,
bool payoffAtExpiry);


DotNET Syntax 


System.String CTExerciseSA.AmericanExercise(
System.String Key,
System.Int32 Reload,
System.Int32 earliestDate,
System.Int32 latestDate,
System.Boolean payoffAtExpiry);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
earliestDateLongFALSE
latestDateLongFALSE
payoffAtExpiryBooleanFALSE

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
KeyFALSEMyAmericanExercise
ReloadFALSE1
earliestDateFALSE19/Jul/2005 (serial date type)
latestDateFALSE21/Oct/2005 (serial date type)
payoffAtExpiryFALSEfalse


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.Models20 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 AmericanExercise() 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 AmericanExercise() function call


MyAmericanExercise_1.AMEXC.0

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