Go To Documentation Main IndexMain Index
Go To TIPS, Inc.TIPS Home
sf_ifs_pfs

sf_ifs_pfs (routine)

Calculate interest and principal flows for a sinking fund security

Introduced in release: 1.0
Component: Generic
Purpose: Calculates interest and principal flows with corresponding dates for a security with a sinking fund. 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.

Alternatives: If some or all sink dates are off cycle from the coupon payment dates, or the security has an odd last coupon period use sf_ifpfs_ocs.

Notes: This routine only works with security_type 1, or 3 through 8. It does not work with any foreign security types.

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/14/1997© 2001 TIPS, Inc.Doc Version: 5.0