BondYields2





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

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

Key TAGs | Excel Index | API Index



Return a range of different Bond yield types (Equivalent annually compounded, Equivalent semi-annually compounded, True yield annual act/365F, True yield semi-annual act/365F, Equivalent (semi-annually compounded with an act/act), Equivalent JGB Simple Rate, Equivalent annually compounded act/365 and Equivalent annually compounded act/360), given a Bond object.

The (clean) price of the bond is taken as input.

The Bond object that is to be queried must have been previously created via one of the numerous Bond creation functions present within the CapeTools Bonds, CapeTools Bonds (Yield), CapeTools Bonds (Price) or CapeTools Forward Bonds category of functions.

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

Please refer to the large number of enumeration functions present within the CapeTools Enums category of functions.

The CapeTools Enums category of functions return correct string codes that can be passed to parameters taking fixed string values defined by the library (ie - DayCount codes, frequency codes, currency codes, compounding codes, business day convention codes etc...).

You can thus execute these enumeration functions which return the proper code, instead of trying to remember the string code needed or making spelling mistakes which can be difficult to debug.



Note: Within Excel, the function is named - CT.BOND.Yields2




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



Parameter Description


  1. BondKey parameter

    Key Handle to an already constructed BOND object (FixedCouponBond, FloatingRateBond, MoneyMarketBond or ZeroCouponBond object).
  2. cleanPrice parameter

    The clean price that you wish to use in the calculation.


Extended information

Function Syntax

VB Syntax


Variant CTQryBonds.BondYields2( _
String BondKey, _
Double cleanPrice)


Excel Spreadsheet Syntax


=CT.BOND.Yields2(
Excel String Cell BondKey,
Excel Numeric Cell cleanPrice)


C++ Syntax


static CTRangeDataCPP BondYields2(
std::string BondKey,
double cleanPrice);


DotNET Syntax


CTRangeData CTQryBondsSA.BondYields2(
System.String BondKey,
System.Double cleanPrice);

Parameter data types

ArgNameArgTypeIsKey
BondKeyStringTRUE
cleanPriceDoubleFALSE


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
BondKeyFALSEBondKeyNAME.EXTTAG.TICKER (from a function call)
cleanPriceFALSE102.5


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.Bonds20 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 BondYields2() 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 BondYields2() function call


Example
Bond's YTM0.0467698
Annual YTM0.0473166
Semi YTM0.0467698
Quarterly YTM0.0464995
True Yield0.0467667
True Yield Annual actact(ISDA)0.0473075
True Yield Semi actact(ISDA)0.0467609
US Street0.046762
US Treasury0.0467533
JGB Yield0.0559329



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