Functional API#

The functional API provides standalone functions that are exactly equivalent to the corresponding LifeTable, DisabilityTable, and ExitTable OOP methods, with an explicit table argument replacing the implicit self of the method call. Multi-life functions (äxy, äjoint, etc.) take a sequence of LifeTable instances as their first argument.

Use the functional API when:

  • You prefer a procedural style or want tabular functional composition.

  • You are working with heterogeneous collections of table instances.

  • You need to pass actuarial functions as callables to higher-order operations.

For all other workflows the OOP methods on LifeTable, DisabilityTable, or ExitTable are recommended.

See also

Functional API — Why and when to use the functional API.

Single-life functions#

Commutation functions#

Multi-life functions#

See also

Joint-Life Calculations — Full guide to joint-life and multi-life annuities and insurances.
Utilities — generate_payment_times() and other helpers for constructing custom payment grids (cashflow_times parameter).