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

sfns_cfs (routine)

Calculate cash flows for a Multi-stepped coupon sinking fund security with off cycle sinks

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

Special Considerations: The cash 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 fields.

Alternatives: If some or all of the bonds are sunk at other than par use sfns_rv_cfs.

Results: All results 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.
Last Mod Date: 01/20/1997© 2001 TIPS, Inc.Doc Version: 5.0