FlatYieldCurve





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

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

Key TAGs | Excel Index | API Index



Creates a yield curve from a single input rate.

This curve cannot be used to determine interest rate market rates (SWAP rates , CMS rates etc...).

You can use this curve to compute discount factors, forward rates and zero rates.

If you do want to use market information that can price various financial products (Bonds, Swaps, various legs etc...) use one of the following category of functions : CapeTools Curves, CapeTools XCCY Curves or CapeTools Bond Curves or you can employ a risky curve via Credit Default Curves (CapeTools Credit Curves).

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

These curves take in extra information pertaining to the interest rate market and can be used to also prices interest rate deals (in regards to the computation of fixing or reset rates).



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



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




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

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

    Rate for building a flat curve
  5. DayCount parameter

    DayCounter to use
  6. Cal parameter

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

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

    The compounding of the interest rate passed in. 'Discounted' 1/(1-r*t), 'Simple' (1+r*t), 'Compounded' (1+r/N)^(t*N), where N is the number of coupons per year, 'Continuous' e^{r*t} and 'SimpleThenCompounded' (Simple up to the first period then Compounded).
  9. Freq parameter

    Frequency of the passed in interest rate. (


Extended information

Function Syntax

VB Syntax


String CTCurves.FlatYieldCurve( _
String Key, _
Long Reload, _
String ValueDate, _
Double Rate, _
DayCountEnum DayCount, _
String Cal, _
BDCEnum BusDayConv, _
COMPEnum compounding, _
FreqEnum Freq)


Excel Spreadsheet Syntax


=CT.CRV.FlatYieldCurve(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell ValueDate,
Excel Numeric Cell Rate,
Excel String Cell DayCount,
Excel String Cell Cal,
Excel String Cell BusDayConv,
Excel String Cell compounding,
Excel String Cell Freq)


C++ Syntax


static std::string FlatYieldCurve(
std::string Key,
long Reload,
std::string ValueDate,
double Rate,
DayCountEnum DayCount,
std::string Cal,
BDCEnum BusDayConv,
COMPEnum compounding,
FreqEnum Freq);


DotNET Syntax


System.String CTCurvesSA.FlatYieldCurve(
System.String Key,
System.Int32 Reload,
System.String ValueDate,
System.Double Rate,
CTIEnums.DayCountEnum DayCount,
System.String Cal,
CTIEnums.BDCEnum BusDayConv,
CTIEnums.COMPEnum compounding,
CTIEnums.FreqEnum Freq);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
ValueDateStringTRUE
RateDoubleFALSE
DayCountDayCountEnumFALSE
CalStringTRUE
BusDayConvBDCEnumFALSE
compoundingCOMPEnumFALSE
FreqFreqEnumFALSE


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
KeyFALSEMyFlatYieldCurve
ReloadFALSE1
ValueDateFALSEValueDateNAME.EXTTAG.TICKER (from a function call)
RateFALSE5.0
DayCountFALSEACT365F
CalFALSECalNAME.EXTTAG.TICKER (from a function call)
BusDayConvFALSEModifiedFollowing
compoundingFALSEContinuous
FreqFALSEA


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


MyFlatYieldCurve_2.FLATYC.0

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