src.data_sources.annuity.mortality.base_mortality.BaseMortality

class src.data_sources.annuity.mortality.base_mortality.BaseMortality(path: str)

Data source for the annuity base mortality table.

Inheritance Diagram

Variables & Properties

Methods

__init__(path)	Constructor method.
base_mortality_rate(gender, attained_age)	Returns a base mortality rate.

Details

__init__(path: str)

Constructor method. Loads data from the base mortality table into cache.

Source(s):

• https://mort.soa.org/ViewTable.aspx?&TableIdentity=2581

• https://mort.soa.org/ViewTable.aspx?&TableIdentity=2582

Relative path to the base mortality table:

resource/annuity/mortality/2012_individual_annuity_mortality_basic_table.csv

Parameters:

path – Path to the base mortality table.

base_mortality_rate(gender: Gender, attained_age: int) → float

Returns a base mortality rate.

Parameters:

• gender – Lookup gender.

• attained_age – Lookup attained age. Age should be Age Nearest Birthday (ANB).

Returns:

Base mortality rate.

cache: DataFrame

Internal cache, populated at runtime.