Public API index

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 a complete solution
`lcm.load_solution`	Load a complete solution lazily
`lcm.load_legacy_solution`	Read the old value-only format
`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. These 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`	Sequence parameter leaf
`lcm.params.as_leaf`	Explicit parameter-leaf wrapper
`lcm.koopmans_aggregation.KoopmansAggregator`	Koopmans-form base contract
`lcm.solver_api.ResultRetention`	Solution result retention
`lcm.solver_api.LoadState`	Per-entry materialization state
`lcm.solver_api.ValueStore`	Lazy addressed value store
`lcm.solver_api.ArtifactKey`	Versioned artifact identity
`lcm.solver_api.ArtifactRef`	Period/regime artifact address
`lcm.solver_api.ArtifactStore`	Immutable artifact store
`lcm.solver_api.ArtifactChannel`	Artifact semantic channel
`lcm.solver_api.ArtifactDescriptor`	Descriptive persisted schema
`lcm.solver_api.ArtifactAuthority`	Model-built artifact authority
`lcm.solver_api.TreePath`	Stable PyTree leaf/container path
`lcm.solver_api.AxisRole`	Mathematical artifact-axis role
`lcm.solver_api.AxisDescriptor`	Descriptive named artifact axis
`lcm.solver_api.AxisAuthority`	Model-owned axis and coordinates
`lcm.solver_api.LeafDescriptor`	Descriptive numerical leaf schema
`lcm.solver_api.LeafAuthority`	Model-owned numerical leaf schema
`lcm.solver_api.CategoryDomain`	Exact categorical labels and codes
`lcm.solver_api.PersistencePolicy`	Per-artifact persistence policy
`lcm.solver_api.KernelOutput`	What a period kernel returns
`lcm.solver_api.OmissionReason`	Recorded reason for absence
`lcm.solver_api.SolutionMetadata`	Labelled-solution metadata
`lcm.solver_api.SolutionResult`	Labelled solution result
`lcm.solver_api.SolutionSource`	In-memory or persisted origin
`lcm.solver_api.ValueArraySchema`	Named value-array shape/dtype
`lcm.solver_api.SIMULATION_POLICY`	Replay-policy schema key
`lcm.solver_api.DISSOLUTION_FLAG`	Dissolution-flag schema key
`lcm.solver_api.EGM_CONTINUATION`	Continuation schema key
`lcm.solver_api.SOLVER_DIAGNOSTICS`	Diagnostics schema key
`lcm.solver_api.ContinuationArtifact`	Keyed rolling-continuation protocol
`lcm.solver_api.ReplayMode`	How a regime’s decision is obtained
`lcm.solver_api.ReplayRoute`	A regime’s declared replay route
`lcm.solver_api.ExecutableReplayRoute`	External replay implementation
`lcm.solver_api.DeclaredReplay`	Replay declared without a route
`lcm.solver_api.ReplayReader`	JAX-transformable replay reader
`lcm.solver_api.ReplayRouteSnapshot`	Validated immutable replay snapshot
`lcm.solver_api.ReplayModelContext`	Period-specific route model view
`lcm.solver_api.ReplayRouteRequirements`	Exact replay artifact dependencies
`lcm.solver_api.SimulationBuildContext`	Model-owned replay build context
`lcm.solver_api.ActionOutput`	Named replayed action arrays
`lcm.solver_api.SolverIdentity`	Exact plugin compatibility identity
`lcm.solver_api.ReplayRouteIdentity`	Exact replay compatibility identity
`lcm.solver_api.PYLCM_VERSION`	Exact pylcm compatibility version
`lcm.solver_api.SOLVER_API_VERSION`	Public solver-interface version
`lcm.solver_api.SOLUTION_SCHEMA_VERSION`	Labelled-result schema version
`lcm.solver_api.SOLUTION_FORMAT_VERSION`	Durable archive format version

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 the out-of-tree solver surface: a solver can be written against these names without importing anything private. Persistence, durable identity, executable replay, and the exact-version conformance contract are documented in Custom solvers.

Public name	Canonical documentation
`lcm.solvers.Solver`	Solver base contract
`lcm.solvers.OneMarginSolver`	One-liquid-margin marker
`lcm.solvers.TwoMarginSolver`	Nested-margin marker
`lcm.solvers.SolverBuildContext`	Per-regime build context
`lcm.solvers.SolutionKernels`	Per-period kernel bundle
`lcm.solvers.PeriodKernel`	One period’s execution protocol
`lcm.solvers.CoreProgram`	One declared compiled program
`lcm.solvers.CoreBuildContext`	Argument-builder input
`lcm.solvers.CoreExecutionRequirements`	Declared execution requirements
`lcm.solvers.TargetValueAccess`	One declared stored-value read
`lcm.solvers.ValueArtifactAddress`	Stored value a core reads
`lcm.solvers.ValueArtifactKind`	Regime value or gated continuation
`lcm.solvers.ValueConsumerAddress`	Argument leaf receiving a value
`lcm.solvers.ValueInputChannel`	Core argument channel for values
`lcm.solvers.CoreExecutionDisposition`	Planned or deliberately dense
`lcm.solvers.ProgramScope`	Retention scope of a program
`lcm.solvers.StreamableProductAxis`	Declared streamable action axis
`lcm.solvers.ReductionSemantics`	Reduction a streamed axis performs
`lcm.solvers.OutputRole`	Value and dissolution-flag roles
`lcm.solvers.StateAxesLeading`	Parametrized output-placement role
`lcm.solvers.StateActionSpace`	Per-period state and action arrays
`lcm.solvers.KernelOutput`	What a period kernel returns
`lcm.solvers.ArtifactKey`	Versioned artifact identity
`lcm.solvers.ArtifactRef`	Period/regime artifact address
`lcm.solvers.ArtifactStore`	Addressed artifact store
`lcm.solvers.ArtifactChannel`	Artifact semantic channel
`lcm.solvers.ArtifactDescriptor`	Descriptive persisted schema
`lcm.solvers.ArtifactAuthority`	Model-built artifact authority
`lcm.solvers.TreePath`	Stable PyTree leaf/container path
`lcm.solvers.AxisRole`	Mathematical artifact-axis role
`lcm.solvers.AxisDescriptor`	Descriptive named artifact axis
`lcm.solvers.AxisAuthority`	Model-owned axis and coordinates
`lcm.solvers.LeafDescriptor`	Descriptive numerical leaf schema
`lcm.solvers.LeafAuthority`	Model-owned numerical leaf schema
`lcm.solvers.CategoryDomain`	Exact categorical labels and codes
`lcm.solvers.PersistencePolicy`	Per-artifact persistence policy
`lcm.solvers.EGM_CONTINUATION`	Continuation schema key
`lcm.solvers.SIMULATION_POLICY`	Replay-policy schema key
`lcm.solvers.DISSOLUTION_FLAG`	Dissolution-flag schema key
`lcm.solvers.SOLVER_DIAGNOSTICS`	Diagnostics schema key
`lcm.solvers.ContinuationArtifact`	Keyed rolling-continuation protocol
`lcm.solvers.ContinuationSpec`	Template and key of a continuation
`lcm.solvers.EGMContinuationSpec`	EGM carry template and layout
`lcm.solvers.EGMContinuationLayout`	How a reading parent interprets rows
`lcm.solvers.ReplayMode`	How a regime’s decision is obtained
`lcm.solvers.ReplayRoute`	A regime’s declared replay route
`lcm.solvers.ExecutableReplayRoute`	External replay implementation
`lcm.solvers.DeclaredReplay`	Replay declared without a route
`lcm.solvers.ReplayReader`	JAX-transformable replay reader
`lcm.solvers.ReplayRouteSnapshot`	Validated immutable replay snapshot
`lcm.solvers.ReplayModelContext`	Period-specific route model view
`lcm.solvers.ReplayRouteRequirements`	Exact replay artifact dependencies
`lcm.solvers.SimulationBuildContext`	Model-owned replay build context
`lcm.solvers.ActionOutput`	Named replayed action arrays
`lcm.solvers.SolverIdentity`	Exact plugin compatibility identity
`lcm.solvers.ReplayRouteIdentity`	Exact replay compatibility identity
`lcm.solvers.PYLCM_VERSION`	Exact pylcm compatibility version
`lcm.solvers.SOLVER_API_VERSION`	Public solver-interface version
`lcm.solvers.SOLUTION_SCHEMA_VERSION`	Labelled-result schema version
`lcm.solvers.SOLUTION_FORMAT_VERSION`	Durable archive format version
`lcm.solvers.LoadState`	Per-entry materialization state
`lcm.solvers.ValueStore`	Lazy addressed value store
`lcm.solvers.ResultRetention`	Solution result retention
`lcm.solvers.OmissionReason`	Recorded reason for absence
`lcm.solvers.SolutionMetadata`	Labelled-solution metadata
`lcm.solvers.SolutionResult`	Complete labelled solution
`lcm.solvers.SolutionSource`	In-memory or persisted origin
`lcm.solvers.ValueArraySchema`	Named value-array shape/dtype
`lcm.solvers.period_to_continuation_target`	Target a period carries into
`lcm.solvers.target_period_grid`	A target’s grid in one period
`lcm.solvers.union_free_params`	Free params of a regime and targets
`lcm.solvers.union_fixed_params`	Fixed params of a regime and targets