src.data_sources.annuity.product.base.surrender_charge.SurrenderCharge

class src.data_sources.annuity.product.base.surrender_charge.SurrenderCharge(path: str)

Data source for the surrender charge table.

Inheritance Diagram

Variables & Properties

Methods

__init__(path)	Constructor method.
cdsc_period(product_name)	Returns a maximum surrender charge period for a given product.
surrender_charge_rate(policy_year, product_name)	Returns a surrender charge rate.

Details

__init__(path: str)

Constructor method. Loads data from the surrender charge (CDSC) table into cache.

Relative path to the annuitization table:

resource/annuity/product/base/surrender_charge.csv

Parameters:

path – Path to the surrender charge table.

cache: DataFrame

Internal cache, populated at runtime.

cdsc_period(product_name: str) → int

Returns a maximum surrender charge period for a given product.

Parameters:

product_name – Product name.

Returns:

Maximum surrender charge period.

surrender_charge_rate(policy_year: int, product_name: str) → float

Returns a surrender charge rate.

Parameters:

• policy_year – Policy year.

• product_name – Product name.

Returns:

Surrender charge rate.