arm_dm

Main Index

TIPS Home

arm_dm_dm

arm_dm_dm (routine)

ARMs - calculate the discounted margin

Introduced in release: 1.2
Component: US MBS
Purpose: Calculates the discounted margin for an Adjustable Rate mortgage backed security from the price.

Notes: The price output from this routine is the dirty price.

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: 11/15/1995

Doc Version: 5.0