AmortFloatingRateBond_y




http://www.QuantTools.com
CapeTools Bonds (Yield) function list

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

Key TAGs | Excel Index | API Index


Creates an amortised floating rate bond object.

The bond takes as input the Bond's yield.

This yield will be used to discount the Bond flows.

A 'BondKey' string value will be returned on a successful creation of the bond object.

This string 'Key' value can then be passed to further bond functions for pricing or querying.



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



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


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



Parameter Description


  1. Key parameter

    Key Handle to be used for the new Bond 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. Ccy parameter

    The currency code that you want to associate with the Bond.
  4. SettleDate parameter

    Settlement date of the Bond.
  5. datedDate parameter

    Dated date of the bond. Date on which the bond begins to accrue interest. If you enter 0 for this parameter (or leave it blank within Excel) the datedDate will be computed internally based on the maturity date and the settlement date.
  6. firstCouponDate parameter

    First Coupon Date: Date that the first coupon is paid (if bond does not have an odd first period, leave blank or enter 0). If entered, this date value must be greater than the Dated Date, but less than the 'penultCouponDate' and 'matDate' parameters.
  7. penultCouponDate parameter

    Penultimate Coupon Date: Date that the penultimate coupon is paid (if bond does not have an odd last period, leave blank or enter 0). If entered, this date value must be greater than the 'datedDate' and 'firstCouponDate' parameters, but less than the 'matDate' parameter.
  8. matDate parameter

    Maturity date of the bond.
  9. IndexKey parameter

    Index Key to an already constructed Index object.
  10. BondDetails parameter

    A positive valued, three column Notional/PrincipalPayments/Spreads array. For the 'PrincipalPayments' column (2nd), Generally in the case where the 'Notional' (1st) column has been filled with amortised Notional values you indicate, (within the 'PrincipalPayments' column), the principal amounts that are to be paid to the holder of this contract during the life of the bond. In the case of amortised periods, this should be populated. Finally the 'spread' (3rd) column holds the bond's spreads (this will be added onto the fixing rates).
  11. cpnDayCount parameter

    Coupon DayCounter to use for the bond coupon payments.
  12. calKey parameter

    Key to an already constructed Calendar object. Used to adjust dates for holidays.
  13. BusDayConv parameter

    Business Day Convention to use.
  14. BondYield parameter

    The Bond's yield value.


Extended information

Function Syntax

VB Syntax 


String CTBonds_y.AmortFloatingRateBond_y( _
String Key, _
Long Reload, _
CCYEnum Ccy, _
Long SettleDate, _
Long datedDate, _
Long firstCouponDate, _
Long penultCouponDate, _
Long matDate, _
String IndexKey, _
Variant BondDetails, _
DayCountEnum cpnDayCount, _
String calKey, _
BDCEnum BusDayConv, _
Double BondYield)


Excel Spreadsheet Syntax 


=CT.BOND.AmortFloatingRateBond_y(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell Ccy,
Excel Numeric Cell SettleDate,
Excel Numeric Cell datedDate,
Excel Numeric Cell firstCouponDate,
Excel Numeric Cell penultCouponDate,
Excel Numeric Cell matDate,
Excel String Cell IndexKey,
XLRange BondDetails,
Excel String Cell cpnDayCount,
Excel String Cell calKey,
Excel String Cell BusDayConv,
Excel Numeric Cell BondYield)


C++ Syntax 


static std::string AmortFloatingRateBond_y(
std::string Key,
long Reload,
CCYEnum Ccy,
long SettleDate,
long datedDate,
long firstCouponDate,
long penultCouponDate,
long matDate,
std::string IndexKey,
CTRangeDataCPP BondDetails,
DayCountEnum cpnDayCount,
std::string calKey,
BDCEnum BusDayConv,
double BondYield);


DotNET Syntax 


System.String CTBonds_ySA.AmortFloatingRateBond_y(
System.String Key,
System.Int32 Reload,
CTIEnums.CCYEnum Ccy,
System.Int32 SettleDate,
System.Int32 datedDate,
System.Int32 firstCouponDate,
System.Int32 penultCouponDate,
System.Int32 matDate,
System.String IndexKey,
CTRangeData BondDetails,
CTIEnums.DayCountEnum cpnDayCount,
System.String calKey,
CTIEnums.BDCEnum BusDayConv,
System.Double BondYield);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
CcyCCYEnumFALSE
SettleDateLongFALSE
datedDateLongFALSE
firstCouponDateLongFALSE
penultCouponDateLongFALSE
matDateLongFALSE
IndexKeyStringTRUE
BondDetailsRangeFALSE
cpnDayCountDayCountEnumFALSE
calKeyStringTRUE
BusDayConvBDCEnumFALSE
BondYieldDoubleFALSE

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
KeyFALSEMyAmortFLTBond_y
ReloadFALSE1
CcyFALSEEUR
SettleDateFALSE19/Jul/2005 (serial date type)
datedDateTRUE21/Apr/2005 (serial date type)
firstCouponDateTRUE0
penultCouponDateTRUE0
matDateFALSE21/Apr/2015 (serial date type)
IndexKeyFALSEIndexKeyNAME.EXTTAG.TICKER (from a function call)
BondDetailsFALSEAmortFloatingRateBond_y_BondDetails_Range (creates a range object)
cpnDayCountFALSE30360
calKeyFALSEcalKeyNAME.EXTTAG.TICKER (from a function call)
BusDayConvFALSEModifiedFollowing
BondYieldFALSE0.055


Example range for parameter : BondDetails

Within Excel, a range such as this can be passed directly into the BondDetails parameter.

10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
10000
1001000

Example C# API usage for setting the range data for parameter : BondDetails 


CTQL.CTRangeData AmortFloatingRateBond_y_BondDetails = new CTQL.CTRangeData();

System.Text.StringBuilder AmortFloatingRateBond_y_BondDetails_builder =
new System.Text.StringBuilder(100);

AmortFloatingRateBond_y_BondDetails_builder.Append("{");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 0	 | 0 ;");
AmortFloatingRateBond_y_BondDetails_builder.Append("100	 | 100	 | 0");
AmortFloatingRateBond_y_BondDetails_builder.Append("}");

// Parse the string into the Range object.
AmortFloatingRateBond_y_BondDetails.RangeFromStr( AmortFloatingRateBond_y_BondDetails_builder.ToString() );


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


MyAmortFLTBond_y_4.AFLTBND_Y.0

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