Crate retiretui_engine 

Plan model, tax engine, and deterministic projection for the retirement planner.

Modules

estimate

The plan’s expenses estimated from a bank’s exports: each row sorted into a category, or ignored, by the user’s rules, the bank’s own column, its transaction type or its payee’s words, the latest twelve months’ spending in each annualized in the plan’s dollars, and each category placed, as the plan’s [estimate] table leans, in the expense that is for it, one of its family, a new one, or the bucket - one proposal per expense.

market

Markets for a plan to be projected through: drawn at random from its assumptions or from history, or replayed from a historical start year.

optimize

The optimizers: each searches a plan by re-projecting candidate plans, so every interaction the engine models is priced in rather than approximated, and emits its answer as a scenario overlay.

params

Tax parameters: per-year TOML tables, embedded for known years, extended past the last known year by inflating indexed values. Values are data; rule shapes live in crate::tax.

plan

The plan document: schema types, TOML load/save, and validation.

project

The deterministic year-by-year projection.

search

What every search the engine runs shares: how far it has got, a way to stop it, why it answered nothing, and the machine’s threads to run its steps on.

statement

The Social Security statement a person downloads from ssa.gov as XML, reduced to what a plan keeps: who it is for, and the covered earnings by year. The estimates it also carries are not read; the engine computes its own.

tax

Federal tax formulas. The rule shapes live here; the yearly values come from crate::params.