Header menu logo bristlecone

Base Module

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

applyDynamicVariables newValues newValueKeys environment

Full Usage: applyDynamicVariables newValues newValueKeys environment

Parameters:
    newValues : 'a[]
    newValueKeys : 'b[]
    environment : Map<'b, 'a>

Returns: Map<'b, 'a>
newValues : 'a[]
newValueKeys : 'b[]
environment : Map<'b, 'a>
Returns: Map<'b, 'a>

applyExternalEnvironment time externalEnv currentEnv

Full Usage: applyExternalEnvironment time externalEnv currentEnv

Parameters:
    time : float
    externalEnv : Map<'a, TimeIndex<'b>>
    currentEnv : Map<'a, 'b>

Returns: Map<'a, 'b>
time : float
externalEnv : Map<'a, TimeIndex<'b>>
currentEnv : Map<'a, 'b>
Returns: Map<'a, 'b>

nanResult tInitial tEnd tStep modelMap

Full Usage: nanResult tInitial tEnd tStep modelMap

Parameters:
    tInitial : float
    tEnd : float
    tStep : float
    modelMap : Map<'a, 'b>

Returns: Map<'a, float[]>

Generates a coded map of time-series where all values are NaN.

tInitial : float
tEnd : float
tStep : float
modelMap : Map<'a, 'b>
Returns: Map<'a, float[]>

solve log integrate tInitial tEnd tStep initialConditions externalEnvironment modelMap

Full Usage: solve log integrate tInitial tEnd tStep initialConditions externalEnvironment modelMap

Parameters:
    log : LogEvent -> unit
    integrate : float -> 'b -> float -> 'c[] -> (float -> 'c[] -> 'd[]) -> float[][]
    tInitial : float
    tEnd : 'b
    tStep : float
    initialConditions : Map<'a, 'c>
    externalEnvironment : Map<'a, TimeIndex<'c>>
    modelMap : Map<'a, (float -> 'c -> Map<'a, 'c> -> 'd)>

Returns: Map<'a, float[]>
log : LogEvent -> unit
integrate : float -> 'b -> float -> 'c[] -> (float -> 'c[] -> 'd[]) -> float[][]
tInitial : float
tEnd : 'b
tStep : float
initialConditions : Map<'a, 'c>
externalEnvironment : Map<'a, TimeIndex<'c>>
modelMap : Map<'a, (float -> 'c -> Map<'a, 'c> -> 'd)>
Returns: Map<'a, float[]>

Type something to start searching.