Vasicek1FModel





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

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

Key TAGs | Excel Index | API Index



Creates a Single-factor Vasicek ShortRate Model object to be used within the interest rate Engines.

Defined as : dr_t = a(b - r_t)dt + sigma*dW_t, where a, b 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 Vasicek1FModel from.

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



Note: Within Excel, the function is named - CT.MOD.Vasicek1FModel




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

    a parameter, default value is 0.1.
  4. b parameter

    b parameter, default value is 0.05.
  5. sigma parameter

    volatility parameter, default value is 0.01.
  6. lambda parameter

    An optional risk premium, default value is 0.00.
  7. Rate parameter

    Rate parameter.


Extended information

Function Syntax

VB Syntax


String CTModels.Vasicek1FModel( _
String Key, _
Long Reload, _
Double a, _
Double b, _
Double sigma, _
Double lambda, _
Double Rate)


Excel Spreadsheet Syntax


=CT.MOD.Vasicek1FModel(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell a,
Excel Numeric Cell b,
Excel Numeric Cell sigma,
Excel Numeric Cell lambda,
Excel Numeric Cell Rate)


C++ Syntax


static std::string Vasicek1FModel(
std::string Key,
long Reload,
double a,
double b,
double sigma,
double lambda,
double Rate);


DotNET Syntax


System.String CTModelsSA.Vasicek1FModel(
System.String Key,
System.Int32 Reload,
System.Double a,
System.Double b,
System.Double sigma,
System.Double lambda,
System.Double Rate);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
aDoubleFALSE
bDoubleFALSE
sigmaDoubleFALSE
lambdaDoubleFALSE
RateDoubleFALSE


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
KeyFALSEMyVasicek1FModel
ReloadFALSE1
aTRUE0.1
bTRUE0.05
sigmaTRUE0.01
lambdaTRUE0.00
RateFALSE0.05


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


MyVasicek1FModel_5.VAMOD.0

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