This curated index covers the names exported from the top-level lcm and lcm.solvers
namespaces. It is a navigation-completeness check, not an exhaustive semantic
specification: submodule-only public objects, constructor fields, behavioral contracts,
and the correctness of destinations require page-specific documentation and tests.
Model and economic declarations¶
| Public name | Canonical documentation |
|---|---|
lcm.Model | Model assembly and execution |
lcm.Regime | General regime |
lcm.ConsumptionSavingsRegime | One liquid margin |
lcm.NestedConsumptionSavingsRegime | Liquid plus outer margin |
lcm.LiquidMargin | Liquid roles |
lcm.OuterContinuousMargin | Outer roles |
lcm.NetOfAdjustmentCost | Resources composition |
lcm.post_decision_lower_bound | Checkable borrowing bound |
lcm.outer_unchanged | Identity no-adjustment sentinel |
lcm.cash_on_hand_with_subsidy | Supported case-piece fixed form |
lcm.liquid_law_from_resources | Conventional liquid law |
lcm.liquid_law_from_savings | Conventional savings-written liquid law |
lcm.ExtremeValueTasteShocks | EV1 discrete-choice shocks |
Grids, categories, and processes¶
| Public name | Canonical documentation |
|---|---|
lcm.AgeGrid | Lifecycle grid |
lcm.categorical | Category declaration |
lcm.DiscreteGrid | Discrete outcome grid |
lcm.LinSpacedGrid | Linear grid |
lcm.LogSpacedGrid | Log grid |
lcm.IrregSpacedGrid | Explicit irregular grid |
lcm.GridBreakpoint | Piecewise-grid boundary |
lcm.PiecewiseLinSpacedGrid | Piecewise linear grid |
lcm.PiecewiseLogSpacedGrid | Piecewise log grid |
lcm.UniformIIDProcess | IID uniform process |
lcm.NormalIIDProcess | IID normal process |
lcm.LogNormalIIDProcess | IID log-normal process |
lcm.NormalMixtureIIDProcess | IID normal mixture |
lcm.TauchenAR1Process | Tauchen AR(1) |
lcm.RouwenhorstAR1Process | Rouwenhorst AR(1) |
lcm.TauchenNormalMixtureAR1Process | Mixture AR(1) |
lcm.StateConditioned | State-conditioned process parameters |
Transitions, phases, and structured declarations¶
| Public name | Canonical documentation |
|---|---|
lcm.MarkovTransition | Stochastic transition wrapper |
lcm.JointTransition | Shared-draw joint law |
lcm.fixed_transition | Identity law |
lcm.AgeSpecializedFunction | Age-varying function |
lcm.AgeSpecializedGrid | Age-varying grid |
lcm.Phased | Solve/simulate variants |
lcm.Condition | Structured Boolean expression |
lcm.ref | Named reference |
lcm.implies | Conditional requirement |
lcm.case_boundary | Structured case boundary |
lcm.piece | Piece decorator |
lcm.smooth_helper | Reviewed smooth-helper attestation |
lcm.affine_breakpoint | Schedule breakpoint |
lcm.piecewise_affine | Piecewise-affine schedule |
Preferences, results, and persistence¶
| Public name | Canonical documentation |
|---|---|
lcm.LinearAggregator | Linear Koopmans form |
lcm.CESAggregator | CES Koopmans form |
lcm.CertaintyEquivalent | Certainty-equivalent contract |
lcm.LinearExpectation | Linear lottery reduction |
lcm.PowerMean | Power-mean reduction |
lcm.QuasiArithmeticMean | Quasi-arithmetic reduction |
lcm.SimulationResult | Deferred simulation result |
lcm.save_solution | Save value functions |
lcm.load_solution | Load value functions |
lcm.SolveSnapshot | Solve diagnostic snapshot |
lcm.SimulateSnapshot | Simulation diagnostic snapshot |
lcm.load_snapshot | Load diagnostic snapshot |
lcm.__version__ | Installed pylcm version |
Explicit public submodule surfaces¶
Most user-facing names are re-exported from lcm. Two deliberately public submodule
surfaces remain outside that top-level namespace:
| Public name | Canonical documentation |
|---|---|
lcm.params.MappingLeaf | Mapping parameter leaf |
lcm.params.SequenceLeaf | Sequence parameter leaf |
lcm.params.UserMappingLeaf | User mapping parameter leaf |
lcm.params.UserSequenceLeaf | User sequence parameter leaf |
lcm.params.as_leaf | Explicit parameter-leaf wrapper |
lcm.koopmans_aggregation.KoopmansAggregator | Koopmans-form base contract |
Collective regimes and value-dependent choice¶
| Public name | Canonical documentation |
|---|---|
lcm.CollectiveUtility | One utility per stakeholder, one action |
lcm.ParetoObjective | Weighted household objective |
lcm.ValueDependentConstraint | Constraint that reads stakeholder values |
lcm.ValueDependentTransition | Gated transition to a target regime |
lcm.StakeholderRoute | One source stakeholder’s route across it |
lcm.ProjectedRegimeValue | Another regime’s value, projected |
Solvers and configurations¶
| Public name | Canonical documentation |
|---|---|
lcm.solvers.GridSearch | General grid search |
lcm.solvers.EGM | Plain endogenous-grid method |
lcm.solvers.DCEGM | General-resources EGM |
lcm.solvers.NEGM | Nested DCEGM |
lcm.solvers.NBEGM | Declared non-convex-budget EGM |
lcm.solvers.NNBEGM | Nested NBEGM |
lcm.solvers.EnvelopeConfig | DCEGM envelope union |
lcm.solvers.ExactEnvelope | Certified envelope |
lcm.solvers.FUESEnvelope | FUES configuration |
lcm.solvers.RFCEnvelope | RFC configuration |
lcm.solvers.LTMEnvelope | LTM configuration |
lcm.solvers.MSSEnvelope | MSS configuration |
lcm.solvers.OuterSearch | Outer-search marker |
lcm.solvers.FiniteOuterGrid | Finite search |
lcm.solvers.AdaptiveOuterMesh | Adaptive continuous search |
lcm.solvers.OuterBranchAggregator | Branch-aggregation marker |
lcm.solvers.DeterministicOuterMaximum | Hard maximum |
lcm.solvers.UniformObservedFixedCost | Analytic fixed-cost integration |
lcm.solvers.BranchAggregateResult | Aggregation output |
The remaining exported solver infrastructure is currently contributor-facing, not a supported out-of-tree extension seam:
| Public name | Status |
|---|---|
lcm.solvers.Solver | Contributor-facing base contract |
lcm.solvers.OneMarginSolver | Contributor-facing marker |
lcm.solvers.TwoMarginSolver | Contributor-facing marker |
lcm.solvers.SolverBuildContext | Contributor-facing build context |
lcm.solvers.SolutionKernels | Contributor-facing kernel bundle |