FRA2





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

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

Key TAGs | Excel Index | API Index



Returns the FRA rate given a FRA tenor.

Uses the Index to extract details of the FRA.

This function requires the input of a IndexKey template object key, which must have been produced via a call to CreateDepoTemplate(). This function would have returned a string 'KEY' which is to be passed to the 'IndexKeyTPL' parameter of this function.

This function requires the input of a YieldCurve object key, which must have been produced via a call to one of the YieldCurve (CapeTools Curves, CapeTools XCCY Curves or CapeTools Bond Curves) or Credit Default Curves (CapeTools Credit Curves) category of functions.

(You cannot use the DiscountCurve(), ForwardCurve(), ZeroCurve() or FlatYieldCurve() functions as these do not contain enough information for pricing.).

These functions would have returned a string 'KEY' which is to be passed to the 'YCKey' parameter of this function.



Note: Within Excel, the function is named - CT.MKT.FRA2




High level graphic of FRA2() function with parameters. Blue square node is the actual function with the parameters ordered.



Parameter Description


  1. FraTenor parameter

    The FRA Tenor of interest (eg 3x6).
  2. IndexKeyTPL parameter

    Index Key to an already constructed Index Template object (Via a call to the CreateDepoTemplate() function). Used for the FLOAT side of the swap.
  3. YCKey parameter

    Key to an already constructed YieldCurve object.


Extended information

Function Syntax

VB Syntax


Double CTQryCurves.FRA2( _
String FraTenor, _
String IndexKeyTPL, _
String YCKey)


Excel Spreadsheet Syntax


=CT.MKT.FRA2(
Excel String Cell FraTenor,
Excel String Cell IndexKeyTPL,
Excel String Cell YCKey)


C++ Syntax


static double FRA2(
std::string FraTenor,
std::string IndexKeyTPL,
std::string YCKey);


DotNET Syntax


System.Double CTQryCurvesSA.FRA2(
System.String FraTenor,
System.String IndexKeyTPL,
System.String YCKey);

Parameter data types

ArgNameArgTypeIsKey
FraTenorStringFALSE
IndexKeyTPLStringTRUE
YCKeyStringTRUE


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
FraTenorFALSE6X9
IndexKeyTPLFALSEIndexKeyTPLNAME.EXTTAG.TICKER (from a function call)
YCKeyFALSEYCKeyNAME.EXTTAG.TICKER (from a function call)


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


0.0376783778773736

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