Prepayment Library - Structures
Summary
This page summarizes the most important Prepayment Library structures. Click on the structure name to access more detailed information.
See the Default Model chapter for information on structures that relate to that model.
Structure
Type
Description
Input
Additional structure for fine tuning of the prepayment model's projections.
Input
ARM collateral indicatives relating to generation of cash flows. Called by structure
EspARMDescStruct() for use by the MBS Calculator Library in computing cash-flow dependant values (Yield, OAS, Duration, etc.).
Input
Provides the specifications of an adjustable rate mortage (ARM) to the ARM prepayment model.
Input
Linked list used to describe weighted participation of members (for example, mortgages) in a group
(for example, a pool).
Input
General purpose utility structure used for arrays of numerical data arranged by date.
Input
Structure for passing detailed historical values for a particular security. Actual SMMs, WACs and balances can optionally be
used to apply dynamic adjustments (based on the recent history) to the model's projections.
Input
Provides additional detail at the loan and borrower level. Member data refers to loan
level; may be used as a "summary record" for pools.
Input
Contains all of the mortgage collateral indicatives needed by the prepayment model.
Passed directly to the prepayment model.
Input
Contains geographic (region name, region code, zipcode, etc.) information regarding the loan or pool.
In/Out
(Advanced users only) Provides a mechanism to adjust many of the prepayment model outputs.
Input
Contains pool level loan specifications required by the Whole Loan prepayment model.
Input
Describes mortgage collateral prepayment penalties considered in generating prepayment projections.
In/Out
Provides to the prepayment model all projected mortgage rates and other macro data
required to perform prepayment projections. Prepayment projections (as SMMs)
are returned via this structure.
Input
Contains additional elements dictating how the prepayment model will interpret prepayment penalties.
Input
Used to pass user-supplied housing sales statistics to the prepayment model.
Input
Optional variables used by the MBS/OAS calculator's cash flow generator.
In/Out
(Advanced users only) Provides access to various characteristics of the prepayment model;
usually used in conjunction with the MBS Calculator Library.