retiretui_engine 0.6.0

Plan model, tax engine, and projection for RetireTui.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! 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.

mod claims;
mod conversions;
mod estimate;
mod measure;
mod order;
mod spending;

pub use claims::{
    Claim, ClaimCandidate, ClaimSearch, apply_claims, claims_overlay, optimize_claims,
};
pub use conversions::{
    BracketSweep, GainsRate, LADDER_ID_PREFIX, LadderStep, OptimizeOptions, OptimizedLadder,
    SweptBracket, apply_ladder, is_ladder, ladder_overlay, optimize_conversions, sweep_brackets,
};
pub use estimate::{benefit_estimates, career_at_salary};
pub use measure::{Judged, Measure};
pub use order::{OrderCandidate, OrderSearch, apply_order, optimize_order, order_overlay};
pub use spending::{
    CEILING_STEPS, MAX_FACTOR, ScaledExpense, SpendingCeiling, apply_spending, spending_ceiling,
    spending_overlay,
};

use std::cmp::Reverse;

use crate::plan::Dollars;
use crate::project::Projection;

/// What a search ranks an outcome by, best first: the least left
/// unfunded, then the most left at the end in today's dollars.
#[must_use]
pub fn rank_key(projection: &Projection) -> (Dollars, Reverse<Dollars>) {
    let summary = projection.summary(true);
    (summary.lifetime_unfunded, Reverse(summary.final_net_worth))
}