FlatVolCurve




http://www.QuantTools.com
CapeTools Volatility Curves function list

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

Key TAGs | Excel Index | API Index


Creates a vol curve from a single input.



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



Note: Within Excel, the function is named - CT.CRV.FlatVolCurve


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

    A tag used to identify this curve (case insensitive) if placed within a Volatility curve collection ( via the GroupedVolCurves() function ). If you pass in an empty string, it will default to the name of the 'Key' parameter.
  4. ValueDate parameter

    Key to an already created Valuation Date Object. (Via the ValueDateObj() function).
  5. Vol parameter

    Volatility, ie, 22.50. Implying 22.50%
  6. DivideVolBy100 parameter

    Is the input volatility entered as a percentage value (true), or the raw volatility value (false). If entered as a percentage, the value will be divided by 100.0 internally.
  7. DayCount parameter

    DayCounter to use
  8. Cal parameter

    Calendar to use for the adjustment of the 'ValueDate' parameter.
  9. BusDayConv parameter

    Business Day Convention needed for the adjustment of the 'ValueDate' parameter.


Extended information

Function Syntax

VB Syntax 


String CTVolatiltyCurves.FlatVolCurve( _
String Key, _
Long Reload, _
String CurveName, _
String ValueDate, _
Double Vol, _
Boolean DivideVolBy100, _
DayCountEnum DayCount, _
String Cal, _
BDCEnum BusDayConv)


Excel Spreadsheet Syntax 


=CT.CRV.FlatVolCurve(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell CurveName,
Excel String Cell ValueDate,
Excel Numeric Cell Vol,
Excel Boolean Value Cell DivideVolBy100,
Excel String Cell DayCount,
Excel String Cell Cal,
Excel String Cell BusDayConv)


C++ Syntax 


static std::string FlatVolCurve(
std::string Key,
long Reload,
std::string CurveName,
std::string ValueDate,
double Vol,
bool DivideVolBy100,
DayCountEnum DayCount,
std::string Cal,
BDCEnum BusDayConv);


DotNET Syntax 


System.String CTVolatiltyCurvesSA.FlatVolCurve(
System.String Key,
System.Int32 Reload,
System.String CurveName,
System.String ValueDate,
System.Double Vol,
System.Boolean DivideVolBy100,
CTIEnums.DayCountEnum DayCount,
System.String Cal,
CTIEnums.BDCEnum BusDayConv);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
CurveNameStringFALSE
ValueDateStringTRUE
VolDoubleFALSE
DivideVolBy100BooleanFALSE
DayCountDayCountEnumFALSE
CalStringTRUE
BusDayConvBDCEnumFALSE

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
KeyFALSEMyFlatVolCurve
ReloadFALSE1
CurveNameTRUEMyFlatVolCurve
ValueDateFALSEValueDateNAME.EXTTAG.TICKER (from a function call)
VolFALSE20
DivideVolBy100FALSEtrue
DayCountFALSEACT365F
CalFALSECalNAME.EXTTAG.TICKER (from a function call)
BusDayConvFALSEModifiedFollowing


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.Curves20 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 FlatVolCurve() 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 FlatVolCurve() function call


MyFlatVolCurve_4.FVC.0

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