Type Aliases

Type aliases for user-defined model component function arguments.

These aliases use typing.Annotated so the library can identify argument roles by tag (regardless of argument order) when wrapping user-supplied rinit, rproc, dmeas, and rmeas functions.

pypomp.types.StateDict

Latent state dictionary mapping state variable names to current values.

Used as the X_ argument in rproc and rmeas user functions.

alias of Annotated[dict[str, float | Array], ‘StateDict’]

pypomp.types.ParamDict

Parameter dictionary mapping parameter names to current values.

Used as the theta_ argument in all user-defined model component functions.

alias of Annotated[dict[str, float | Array], ‘ParamDict’]

pypomp.types.CovarDict

Covariate dictionary mapping covariate names to values at the current time.

Used as the covars argument in model component functions when covariates are provided.

alias of Annotated[dict[str, float | Array], ‘CovarDict’]

pypomp.types.TimeFloat

Current observation time, passed as the t argument.

alias of Annotated[float, ‘TimeFloat’]

pypomp.types.StepSizeFloat

Euler approximation step size, passed as the dt argument in rproc.

alias of Annotated[float, ‘StepSizeFloat’]

pypomp.types.RNGKey

JAX PRNG key for random number generation, passed as the key argument.

alias of Annotated[Array, ‘RNGKey’]

pypomp.types.ObservationDict

Observation dictionary mapping measurement names to observed values.

Used as the Y_ argument in dmeas user functions.

alias of Annotated[dict[str, float | Array], ‘ObservationDict’]

pypomp.types.InitialTimeFloat

Initial time t0, passed as the t0 argument in rinit.

alias of Annotated[float, ‘InitialTimeFloat’]