mbs_halflife

Main Index

TIPS Home

mbs_halflife

mbs_halflife (routine)

Mortgage backed security - calculates half life

Introduced in release: 1.0
Component: US MBS
Purpose: Calculate the point in time at which half the principal of the underlying mortgages has been paid

Notes: This routine takes as input cash flows which must first be calculated.

 To calculate the cash flows for a Fixed Rate MBS use mbs_gen_tbls.
 To calculate the cash flows for a GPM use mbs_gentblsg.
 To calculate the cash flows for an ARM use arm_gen_tbls. See Coding Examples for a more detailed explanation.

Results: The number of years is returned as the value of the function, 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: 04/02/1990

Doc Version: 5.0