Header menu logo bristlecone

ModelSystem Module

Represents an ordinary differential equation model system and its likelihood as an objective function that may be optimised.

Types

Type Description

EstimationResult<'date, 'timeunit, 'timespan>

An estimated model fit for a time-series model.

FitSeries<'date, 'timeunit, 'timespan>

FitValue

GenericModelEquation<'timeUnit, 'returnUnit>

An equation that may require fixed or free parameters, the current time t, the current response value, and / or external environmental time series.

Initialiser<'u>

Computes the hidden state’s initial value at t0 from fitted parameters and baseline known values.

Likelihood<'u>

LikelihoodEval<'u>

The negative log likelihood given the predicted and observed per-variable time-series and a function to retrieve parameters required by the likelihood function.

LikelihoodRequirement

Measurement<'u>

A function that computes a measured system property given a current (time t) and previous (time t-1) system state.

ModelForm<'timeUnit>

The model system may make use of either stepped or integrated-time equations. Each are both require the same inputs, but differ in whether a solver is applied or not. Here, the DU's purpose is for additional type safety. TODO Allow state to differ between equations.

ModelSystem<'modelTimeUnit>

ParameterValueAccessor

A function that returns a parameter's current value by its name.

PredictedSeries<'u>

Predicted time-series for a single variable. 'u is the state unit of measure.

RateEquation<'timeUnit>

SeriesPair<'u>

A single variable’s observed vs expected values after model-fitting.

StateEquation<'timeUnit>

environment

state

Type something to start searching.