Header menu logo bristlecone

SolverCompiler Module

Functions and values

Function or value Description

compile logTo dataTimeToModelTime modelEquations engineTimeMode stepType observedStates observedMeasuresT0 hiddenStatesT0 hiddenStatesT0Initialisers environment interpolationModeFor

Full Usage: compile logTo dataTimeToModelTime modelEquations engineTimeMode stepType observedStates observedMeasuresT0 hiddenStatesT0 hiddenStatesT0Initialisers environment interpolationModeFor

Parameters:
Returns: ConfiguredSolver

Compile a configured solver, automatically selecting the correct runner. t0 (conditioned or otherwise) is obtained automatically from the dynamic series.

logTo : LogEvent -> unit
dataTimeToModelTime : ResolutionToModelUnits<'date, 'timespan, 'modelTimeUnit>
modelEquations : ModelForm<'modelTimeUnit>
engineTimeMode : TimeMode
stepType : StepType<'date>
observedStates : TimeFrame<float<MeasureProduct<state, MeasureOne>>, 'date, 'timeunit, 'timespan>
observedMeasuresT0 : CodedMap<TypedTensor<Scalar, MeasureProduct<state, MeasureOne>>>
hiddenStatesT0 : CodedMap<TypedTensor<Scalar, MeasureProduct<state, MeasureOne>>>
hiddenStatesT0Initialisers : CodedMap<Initialiser<MeasureProduct<state, MeasureOne>>>
environment : TimeFrame<float<MeasureProduct<environment, MeasureOne>>, 'date, 'timeunit, 'timespan> option
interpolationModeFor : ShortCode -> InterpolationMode
Returns: ConfiguredSolver

enforceExactAlignment envIndex solverTimeline

Full Usage: enforceExactAlignment envIndex solverTimeline

Parameters:

Mandate that environmental data falls exactly on the solver's timesteps. Only required when no interpolation is specified.

envIndex : CodedMap<TimeIndex<float<MeasureProduct<environment, MeasureOne>>, 'date, 'timeunit, 'timespan, 'modelTimeUnit>>
solverTimeline : TimeIndex<float<MeasureProduct<environment, MeasureOne>>, 'date, 'timeunit, 'timespan, 'modelTimeUnit>[]

Type something to start searching.