Calculate prepayment rate for a graduated payment mortgage
Introduced in release: 1.0 Component: US MBS Purpose:
Calculates a prepayment rate for a graduated payment mortgage backed security. Specifically it will calculate a prepayment rate for mortgage backed securities where the mortgage payments are graduated.
Results:
The function returns the calculated prepayment rate, 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.