Public API index

This curated index covers the names exported from the top-level lcm and lcm.solvers namespaces and the explicit public submodule surfaces below. It is a navigation-completeness check, not an exhaustive semantic specification: 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.InitialNodes`	Explicit coordinates of admissible starts
`lcm.CompositeState`	Reachable tuples of discrete member states
`lcm.PeriodCandidate`	Exact primary ranked-width request
`lcm.LoweredPeriodCandidate`	Immutable descriptors and raw unoptimized IR
`lcm.Regime`	General regime
`lcm.Exit`	Named current-period move
`lcm.ExitTarget`	Mapped destination policy and adjustment
`lcm.Consent`	Strict formation consent
`lcm.Counterparty`	Counterparty Raw policy context
`lcm.RuleResult`	Custom rule’s stable alternative ID
`lcm.ExecutionConfig`	Devices, budget, sharded states, widths, donation
`lcm.InvariantBlockSchedule`	Period- or block-major invariant schedule
`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
`lcm.EULER_GAMMA`	Mean of a standard Gumbel draw

Grids, categories, and processes¶

Public name	Canonical documentation
`lcm.shocks`	Named IID laws and integration rules
`lcm.AgeGrid`	Lifecycle grid
`lcm.categorical`	Category declaration
`lcm.characteristics`	Checked category characteristics
`lcm.category_with`	Category code from characteristics
`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.ConditionalAction`	Action active under some codes
`lcm.UniformIIDProcess`	IID uniform process
`lcm.NormalIIDProcess`	IID normal process
`lcm.JointNormalIIDProcess`	Named correlated IID normal shocks
`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.StochasticTransition`	Stochastic transition wrapper
`lcm.AdditiveShockTransition`	Additive continuous-state shock law
`lcm.Transition`	Graph edges with their regime law
`lcm.ParticipationCheck`	Incoming edge’s participation rule
`lcm.ParticipationRead`	Typed projected participation comparison
`lcm.JointTransition`	Shared-draw joint law
`lcm.ByAge`	Numerical laws by exact source age
`lcm.AgeRange`	Half-open age interval
`lcm.ByPeriod`	Numerical laws by source period
`lcm.PeriodRange`	Half-open period interval
`lcm.Periods`	Explicit source periods
`lcm.DeterministicTransition`	Deterministic transition wrapper
`lcm.deterministic_transition`	Deterministic transition decorator
`lcm.stochastic_transition`	Stochastic transition decorator
`lcm.fixed_transition`	Identity law
`lcm.AgeSpecializedFunction`	Age-varying function
`lcm.AgeSpecializedGrid`	Age-varying grid
`lcm.PeriodSpecializedFunction`	Period-varying function
`lcm.PeriodSpecializedGrid`	Period-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

Temporal parameters¶

Public name	Canonical documentation
`lcm.TimeVarying`	Labelled temporal values
`lcm.time_varying_params`	Managed temporal selection
`lcm.UnlabelledTimeParameterWarning`	Unchecked manual time mapping

Preferences, results, and persistence¶

Public name	Canonical documentation
`lcm.LinearAggregator`	Linear Koopmans form
`lcm.CESAggregator`	CES Koopmans form
`lcm.Decoupled`	Choose with one W, store another
`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.PolicyLookup`	Per-period policy lookup 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¶

Public name	Canonical documentation
`lcm.persistence.PeriodCapture`	Selected production period capture
`lcm.persistence.PeriodCaptureRecord`	Completed or entry-only evidence
`lcm.persistence.CapturedPeriodReplay`	Strict replay qualification
`lcm.persistence.load_period_capture`	Inspect verified numerical captures

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.component_jobs.ComponentJobPlan`	Immutable component campaign manifest
`lcm.component_jobs.CollectedComponentJobs`	Complete collected solution and simulation
`lcm.component_jobs.plan_component_jobs`	Assign original codes and publish a plan
`lcm.component_jobs.load_component_job_plan`	Read the shared plan
`lcm.component_jobs.run_component_job`	Run one job and atomically publish its fragment
`lcm.component_jobs.collect_component_jobs`	Verify fragments and collect the full result
`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.params.TimeVarying`	Labelled temporal values
`lcm.params.time_varying_params`	Managed temporal selection
`lcm.params.UnlabelledTimeParameterWarning`	Unchecked manual time mapping
`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.EGM_CONTINUATION`	Continuation schema key
`lcm.solver_api.SOLVER_DIAGNOSTICS`	Diagnostics schema key
`lcm.solver_api.ContinuationArtifact`	Keyed rolling-continuation protocol
`lcm.solver_api.ContinuationReader`	What a parent may ask a payload
`lcm.solver_api.ContinuationCapabilities`	What a payload can answer
`lcm.solver_api.EGM_ENDOGENOUS_COORDINATE`	Coordinate EGM rows are read on
`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.SolverExecutionCapabilities`	Solver prerequisites and potential execution axes
`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.Gate`	Value-dependent branch on the transition into one target
`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.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.SolverExecutionCapabilities`	Solver prerequisites and potential execution axes
`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.CoreExecutionDisposition`	Planned, dense, or host-driven
`lcm.solvers.InternalOutputSpec`	Output published within one graph
`lcm.solvers.InternalInputRef`	Argument read from another program
`lcm.solvers.ValueRead`	Declared read of a stored value
`lcm.solvers.ValueArtifactAddress`	Stored value being read
`lcm.solvers.ValueConsumerAddress`	Program input receiving a value
`lcm.solvers.ValueArtifactKind`	Kind of stored value artifact
`lcm.solvers.ValueInputChannel`	Input channel of a value consumer
`lcm.solvers.ValueTransferKind`	Operator one planned transfer runs
`lcm.solvers.TransferOperationClass`	Local, device copy, or collective
`lcm.solvers.TransferCost`	What one planned transfer occupies
`lcm.solvers.ProgramScope`	Retention scope of a program
`lcm.solvers.ReducedAxis`	Declared axis folded by a reduction
`lcm.solvers.TiledOutputAxis`	Declared axis whose tiles concatenate
`lcm.solvers.ACTION_PRODUCT_AXIS`	Name of the action-product axis
`lcm.solvers.STOCHASTIC_NODE_AXIS`	Name of the stochastic-node axis
`lcm.solvers.CELL_AXIS`	Name of the output state-cell axis
`lcm.solvers.SAVINGS_POINT_AXIS`	Name of the savings-node axis
`lcm.solvers.EULER_POINT_AXIS`	Name of the Euler-node axis
`lcm.solvers.ENVELOPE_CELL_AXIS`	Name of the envelope-cell axis
`lcm.solvers.OUTER_CANDIDATE_AXIS`	Name of the outer-candidate axis
`lcm.solvers.INTERVAL_AXIS`	Name of the liquid-interval axis
`lcm.solvers.BRANCH_AXIS`	Name of the discrete-branch axis
`lcm.solvers.ReductionDeclaration`	Contract a reduced axis names
`lcm.solvers.ReductionSemantics`	Declaration carrying its own fold
`lcm.solvers.EXACTNESS_VALUES`	The two published exactness values
`lcm.solvers.WeightedExpectationReduction`	Weighted sum over stochastic nodes
`lcm.solvers.HardMaxWithCarryReduction`	Hard max carrying the winner payload
`lcm.solvers.IntervalEnvelopeReduction`	Upper envelope over intervals
`lcm.solvers.INTERVAL_ENVELOPE_REDUCTION`	Shared interval-envelope declaration
`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.SOLVER_DIAGNOSTICS`	Diagnostics schema key
`lcm.solvers.ContinuationArtifact`	Keyed rolling-continuation protocol
`lcm.solvers.ContinuationReader`	What a parent may ask a payload
`lcm.solvers.ContinuationCapabilities`	What a payload can answer
`lcm.solvers.EGM_ENDOGENOUS_COORDINATE`	Coordinate EGM rows are read on
`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