src.data_sources.annuity.product.base.crediting_rate.indexed.IndexedCreditingRate

class src.data_sources.annuity.product.base.crediting_rate.indexed.IndexedCreditingRate(path: str)

Data source for the fixed indexed account crediting table.

Inheritance Diagram

Variables & Properties

Methods

__init__(path)	Constructor method.
cap(account_name)	Returns a crediting rate cap.
floor(account_name)	Returns a crediting rate floor.
index(account_name)	Returns an account's underlying index.
participation_rate(account_name)	Returns a participation rate.
spread(account_name)	Returns a crediting rate spread.
term(account_name)	Returns a crediting rate term (duration of a crediting strategy), in years.

Details

__init__(path: str)

Constructor method. Loads data from the fixed indexed account crediting table into cache.

Relative path to the fixed indexed account crediting table:

resource/annuity/product/base/crediting_rate_indexed.csv

Parameters:

path – Path to the fixed indexed account crediting table.

cache: DataFrame

Internal cache, populated at runtime.

cap(account_name: str) → float | None

Returns a crediting rate cap.

Parameters:

account_name – Account name.

Returns:

Crediting rate cap.

floor(account_name: str) → float | None

Returns a crediting rate floor.

Parameters:

account_name – Account name.

Returns:

Crediting rate floor.

index(account_name: str) → str

Returns an account’s underlying index.

Parameters:

account_name – Account name.

Returns:

Index name.

participation_rate(account_name: str) → float | None

Returns a participation rate.

Parameters:

account_name – Account name.

Returns:

Participation rate.

spread(account_name: str) → float | None

Returns a crediting rate spread.

Parameters:

account_name – Account name.

Returns:

Crediting rate spread.

term(account_name: str) → int

Returns a crediting rate term (duration of a crediting strategy), in years.

Parameters:

account_name – Account name.

Returns:

Crediting rate term.