Creates a Single-factor Hull-White (extended Vasicek) ShortRate Model object to be used within the interest rate Engines.

Defined as : dr_t = (theta(t) - alpha*r_t)dt + sigma*dW_t, where alpha and sigma are constants.

This function can be calibrated by executing one of the calibration functions (functions with a naming convention of Calibrate*() ) within the CapeTools IR Calibration or CapeTools LMM Calibration category of functions.

Not all calibration functions can be used with each model.

The calibration parameters will be returned within an array in which you can you construct a new HullWhite1FModel from.

You can create Pricing Engines from this HullWhite1FModel model by executing one of the following functions : JamSwaptionEngine(), TreeSwaptionEngine(), AnalyticCapFloorEngine() or TreeCapFloorEngine(). In these latter functions, the string 'key' returned from this HullWhite1FModel function acts as input to these Engine 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 : "HWMOD"

String CTModels.HullWhite1FModel( _
String Key, _
Long Reload, _
Double alpha, _
Double sigma, _
String YCKey)

=CT.MOD.HullWhite1FModel(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell alpha,
Excel Numeric Cell sigma,
Excel String Cell YCKey)

static std::string HullWhite1FModel(
std::string Key,
long Reload,
double alpha,
double sigma,
std::string YCKey);

System.String CTModelsSA.HullWhite1FModel(
System.String Key,
System.Int32 Reload,
System.Double alpha,
System.Double sigma,
System.String YCKey);

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.