Calculates the cash flows for a Payment-In-Kind (PIK) odd last bond
Introduced in release: 1.0 Component: US Bonds Purpose:
Determines all future cash flows and their corresponding dates, from the settlement date, for a Payment In Kind bond. The cash flows are all interest payments and principal repayments combined by date.
Special Considerations:
For the cash flows to be scaled consistently with those used by the security specific price/yield routine, set the variable thous_securities to zero. This forces the cash flows to be based on 100 of maturity value.
Alternatives:
If you have a PIK bond with an odd last period use pik_cfs_ol.
Results:
All results are scaled by thous_securities, and are accurate to as many places as supported by a double precision value. The array cfs contains the cash flows and the arrays cf_months, cf_days, cf_years contain the corresponding dates.
Error Conditions:
Returned values should be ignored for a non-zero status. See Errors.