Utilities

Helper functions and return types for actuarial calculations that are not tied to a specific table instance.

Batch result types

BatchResult and BatchErrorReport are the return types produced when on_error='nan' is passed to any batch calculation method. See Batch Calculations for usage examples.

Payment schedule helpers

payment_times() generates the vector of payment times (in years) for a given duration, payment frequency \(m\), and optional subset of periods within each year. It is used internally by all annuity and insurance calculation engines and is also available as a standalone tool for custom cashflow construction.

Use this function directly when you need to inspect or override the default payment grid that LifeTable methods would produce for a given \((n, m)\) combination, or when building Irregular Cashflows.

See also

Irregular Cashflows — Custom cashflow schedules for annuities and insurances.
Last Payment Adjustment — Fractional final payment handling.

Tiered cashflow amounts

tiered_amounts() maps each payment time to a cashflow amount according to a step-up / step-down schedule defined by breakpoints and values. It is the recommended way to build piecewise-constant benefit schedules for use with ax().

See also

Irregular Cashflows — Step-up pension example and further use cases.