Calculates current full period interest for a bond
Introduced in release: 1.0 Component: Restricted Purpose:
Calculates the extended amount of interest due, taking into account the quantity, for a regular bond or odd first coupon bond. The interest calculated is for the full period in which the settlement date falls, including settlement within an odd first period.
Special Considerations:
In this routine the current period always includes the settlement day.
Notes:
This routine is intended for use in calculating future cash flows. If the settlement date is a coupon payment date, the return value is the amount of interest due to be paid on the next coupon payment date. In this particular case the calculation differs from that provided by bond_pip, which calculates the prior period's interest due to be paid on the current coupon/settlement date (the calculated amounts will differ only for odd coupon periods).
The provided settlement date is not required to be an actual trade settlement date. The routine will calculate a full period's interest for any date provided as a settlement date.
Results:
The result is returned as a dollar and cents amount scaled by the quantity and accurate to as many places as supported by a double precision value.
Error Conditions:
Returned values should be ignored for a non-zero status. See Errors.
Main Index
TIPS Home