sfns_ifs

Main Index

TIPS Home

sfns_ifs_pfs

sfns_ifs_pfs (routine)

Calculate interest and principal flows for a Multi-stepped coupon sinking fund security with off cycle sinks

Introduced in release: 1.3
Component: US Bonds
Purpose: Calculates interest and principal flows with corresponding dates for a security with multiple coupon steps and a sinking fund where sinks can occur off cycle from the coupon payment dates. The interest flows include all interest payments to the security holder. The principal flows include redemptions of securities (according to the sinking fund schedule) and repayment of principal at maturity.

Special Considerations: The interest and principal flows generated by this routine, unlike the other _cfs routines in the Library, cannot be scaled via the thous_securities variable, since they are based on the actual amounts passed in the outstanding_amt, sink_amt, sinkgrp_amts, overfund_amt, voluntary_amt and voluntarygrp_amts variables.

Results: All results are scaled by thous_securities and accurate to as many places as supported by double precision numbers. The array ifs contains the interest flows, the array pfs contains the principal flows and the arrays cf_months, cf_days, cf_years contain the corresponding date.

Error Conditions: Returned values should be ignored for a non-zero status. See Errors.

Last Mod Date: 01/21/1997

Doc Version: 5.0