arm_cfs_bals

Main Index

TIPS Home

arm_cfs_bals

arm_cfs_bals (routine)

ARMs - generate arrays of cash flows, balances, and principal payments

Introduced in release: 1.2
Component: US MBS
Purpose: Given the survival factors and the parameters that describe the adjustable rate mortgage-backed security, this routine generates the monthly cash flow arrays needed to perform MBS calculations.

Alternatives: This routine takes as inputs some values which must first be calculated by other routines. For a routine which performs a similar function from general ARM descriptive data use arm_gen_tbls.

Results: The following values for each month are calculated and returned in arrays, with the first element of the array containing the value for the first month:

 monthly_cfs         : Total cash flow array
 monthly_bals        : Mortgage balance at the beginning of the month array
 monthly_tot_prns    : Total principal payment, including prepayments array
 monthly_sched_prns  : Scheduled principal payment array
 monthly_unsched_prns: Unscheduled principal payment (prepayments) array
 monthly_ints        : Interest payments array
 cpn_rates           : Coupon rate array

All results are 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.

Last Mod Date: 12/15/1995

Doc Version: 5.0