mbs_py

Main Index

TIPS Home

mbs_py

mbs_py (routine)

Mortgage backed security - calculate the price/yield

Introduced in release: 1.0
Component: US MBS
Purpose: Calculates either dollar price or bond equivalent yield to maturity for a mortgage backed security. It uses the monthly cash flows as input

Special Considerations: This function differs from mbs_py_ai in that it uses or returns the dirty price (inclusive of accrued interest) as opposed to the clean price (exclusive of accrued interest) .

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 result 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/03/1990

Doc Version: 5.0