src.data_sources.annuity.product.gmwb.benefit.GmwbBenefit

class src.data_sources.annuity.product.gmwb.benefit.GmwbBenefit(path: str)

Data source for GMWB benefits.

Inheritance Diagram

Variables & Properties

Methods

__init__(path)	Constructor method.
av_active_withdrawal_rate(rider_name, ...)	Returns a GMWB withdrawal rate for policies that still have a positive account value.
av_exhaust_withdrawal_rate(rider_name, ...)	Returns a GMWB withdrawal rate for policies that no longer have an account value.

Details

__init__(path: str)

Constructor method. Loads data from the GMWB benefits table into cache.

Relative path to the GMWB benefits table:

resource/annuity/product/gmwb/benefit.json

Parameters:

path – Path to the GMWB benefits table.

av_active_withdrawal_rate(rider_name: str, age_first_withdrawal: int) → float

Returns a GMWB withdrawal rate for policies that still have a positive account value.

Parameters:

• rider_name – Rider name.

• age_first_withdrawal – Attained age at 1st withdrawal.

Returns:

GMWB withdrawal rate.

av_exhaust_withdrawal_rate(rider_name: str, age_first_withdrawal: int) → float

Returns a GMWB withdrawal rate for policies that no longer have an account value.

Parameters:

• rider_name – Rider name.

• age_first_withdrawal – Attained age at 1st withdrawal.

Returns:

GMWB withdrawal rate.

cache: DataFrame

Internal cache, populated at runtime.