Header menu logo bristlecone

Model Module

Terms for scaffolding a model system for use with Bristlecone.

Functions and values

Function or value Description

addDiscreteEquation name expr mb

Full Usage: addDiscreteEquation name expr mb

Parameters:
Returns: ModelBuilder<Discrete, 'time>
name : StateId<'state>
expr : ModelExpression<'state>
mb : ModelBuilder<Discrete, 'time>
Returns: ModelBuilder<Discrete, 'time>

addMeasure name measure builder

Full Usage: addMeasure name measure builder

Parameters:
Returns: ModelBuilder<'mode, 'time>
name : MeasureId<'u>
measure : ModelExpression<'u>
builder : ModelBuilder<'mode, 'time>
Returns: ModelBuilder<'mode, 'time>

addRateEquation name expr mb

Full Usage: addRateEquation name expr mb

Parameters:
Returns: ModelBuilder<Continuous, 'time>
name : StateId<'state>
expr : ModelExpression<MeasureProduct<MeasureInverse<'time>, MeasureProduct<'state, MeasureOne>>>
mb : ModelBuilder<Continuous, 'time>
Returns: ModelBuilder<Continuous, 'time>

compile

Full Usage: compile

Returns: ModelBuilder<'a, 'u> -> ModelSystem<'u>
Returns: ModelBuilder<'a, 'u> -> ModelSystem<'u>

continuous

Full Usage: continuous

Returns: ModelBuilder<Continuous, 'time>

An empty continuous-time model.

Returns: ModelBuilder<Continuous, 'time>

discrete

Full Usage: discrete

Returns: ModelBuilder<Discrete, 'time>

An empty discrete-time model.

Returns: ModelBuilder<Discrete, 'time>

empty

Full Usage: empty

Returns: ModelBuilder<Continuous, 'time>

The default Bristlecone model is continuous-time.

Returns: ModelBuilder<Continuous, 'time>

estimateParameter p builder

Full Usage: estimateParameter p builder

Parameters:
Returns: ModelBuilder<'mode, 'time>
p : IncludedParameter<'u>
builder : ModelBuilder<'mode, 'time>
Returns: ModelBuilder<'mode, 'time>

initialiseHiddenStateWith name initialiser builder

Full Usage: initialiseHiddenStateWith name initialiser builder

Parameters:
Returns: ModelBuilder<'mode, 'time>
name : StateId<'u>
initialiser : ModelExpression<'u>
builder : ModelBuilder<'mode, 'time>
Returns: ModelBuilder<'mode, 'time>

useLikelihoodFunction likelihoodFn builder

Full Usage: useLikelihoodFunction likelihoodFn builder

Parameters:
Returns: ModelBuilder<'a, 'u>
likelihoodFn : Likelihood<MeasureProduct<state, MeasureOne>>
builder : ModelBuilder<'a, 'u>
Returns: ModelBuilder<'a, 'u>

Type something to start searching.