Header menu logo bristlecone

Solver Module

Helper functions for the creation of `Solver` functions, which apply time-series models to time-series data (when using Bristlecone time-series types).

Types and nested modules

Type/Module Description

Conditioning

Conditioning of time-series data, which allows for maximum use of observed time-series data.

Discrete

Solver<'a>

StepType

If environmental forcing data is supplied, the output series may be configured to be either external (i.e. on observation timeline) or internal (e.g. on environmental data timeline).

Functions and values

Function or value Description

fixedResolutionSolver fRes stepType dynamicSeries environment engine t0

Full Usage: fixedResolutionSolver fRes stepType dynamicSeries environment engine t0

Parameters:
Returns: CodedMap<ODE> -> Map<ShortCode, float[]>
fRes : FixedTemporalResolution
stepType : StepType
dynamicSeries : TimeFrame<float>
environment : TimeFrame<float> option
engine : EstimationEngine<float, float>
t0 : CodedMap<float>
Returns: CodedMap<ODE> -> Map<ShortCode, float[]>

fixedStep logTo timeHandling tStart tEnd initialState forcings

Full Usage: fixedStep logTo timeHandling tStart tEnd initialState forcings

Parameters:
Returns: CodedMap<ODE> -> Map<ShortCode, 'a[]>

Step the solver using high resolution, and output at low resolution. External steps are of a fixed width.

logTo : WriteOut
timeHandling : TimeMode<'a, float>
tStart : float
tEnd : float
initialState : CodedMap<'a>
forcings : CodedMap<TimeIndex<'a>>
Returns: CodedMap<ODE> -> Map<ShortCode, 'a[]>

solver stepType dynamicSeries environment engine t0

Full Usage: solver stepType dynamicSeries environment engine t0

Parameters:
Returns: Solver<float>

Create a solver that applies time-series models to time-series data. Takes a `TimeFrame` of dynamic time-series

stepType : StepType
dynamicSeries : TimeFrame<float>
environment : TimeFrame<float> option
engine : EstimationEngine<float, float>
t0 : CodedMap<float>
Returns: Solver<float>

variableExternalStep logTo timeHandling timeSteps initialPoint

Full Usage: variableExternalStep logTo timeHandling timeSteps initialPoint

Parameters:
Returns: CodedMap<ODE> -> Map<ShortCode, float[]>

Step the solver using the high resolution, and output at low resolution. External steps can be variable in size. Each time jump is integrated individually.

logTo : WriteOut
timeHandling : TimeMode<float, float>
timeSteps : float seq
initialPoint : CodedMap<float>
Returns: CodedMap<ODE> -> Map<ShortCode, float[]>

Type something to start searching.