Base (bristlecone) | bristlecone

bristlecone

Base Module

Namespace: Bristlecone.Integration
Assembly: Bristlecone.dll

Module provides functions that 'wrap' a raw integration routine into a form that can be used within Bristlecone.

Functions and values

Function or value	Description
`makeCompiledFunctionForIntegration tInitial tEnd tStep externalEnv initialStateFn modelMap` Full Usage: `makeCompiledFunctionForIntegration tInitial tEnd tStep externalEnv initialStateFn modelMap` Parameters: tInitial : `float<'modelTime>` tEnd : `float<'modelTime>` tStep : `float<'modelTime>` externalEnv : `CodedMap<TimeIndex<float<MeasureProduct<environment, MeasureOne>>, 'date, 'timeunit, 'timespan, MeasureProduct<'modelTime, MeasureProduct<MeasureInverse<time index>, MeasureOne>>>>` initialStateFn : `TypedTensor<Vector, MeasureProduct<parameter, MeasureOne>> -> CodedMap<TypedTensor<Scalar, MeasureProduct<state, MeasureOne>>>` modelMap : `CodedMap<TensorODE>` Returns: `UnparameterisedRHS`	Scaffolds an AD-aware function that bakes in the current parameter set, and only requires the current time and state on any calculation. Because of the way in which external environment variables are inserted, the function should only be run at times as specified in tInitial, tEnd, and tStep. tInitial : `float<'modelTime>` tEnd : `float<'modelTime>` tStep : `float<'modelTime>` externalEnv : `CodedMap<TimeIndex<float<MeasureProduct<environment, MeasureOne>>, 'date, 'timeunit, 'timespan, MeasureProduct<'modelTime, MeasureProduct<MeasureInverse<time index>, MeasureOne>>>>` initialStateFn : `TypedTensor<Vector, MeasureProduct<parameter, MeasureOne>> -> CodedMap<TypedTensor<Scalar, MeasureProduct<state, MeasureOne>>>` modelMap : `CodedMap<TensorODE>` Returns: `UnparameterisedRHS`
`nanResult tInitial tEnd tStep modelMap` Full Usage: `nanResult tInitial tEnd tStep modelMap` Parameters: tInitial : `float<MeasureProduct<time index, MeasureOne>>` tEnd : `float<MeasureProduct<time index, MeasureOne>>` tStep : `float<MeasureProduct<time index, MeasureOne>>` modelMap : `Map<'a, 'b>` Returns: `Map<'a, float[]>`	Generates a coded map of time-series where all values are NaN. tInitial : `float<MeasureProduct<time index, MeasureOne>>` tEnd : `float<MeasureProduct<time index, MeasureOne>>` tStep : `float<MeasureProduct<time index, MeasureOne>>` modelMap : `Map<'a, 'b>` Returns: `Map<'a, float[]>`