Header menu logo bristlecone

Compute Module

Functions and values

Function or value Description

drawParameterSet rnd pool

Full Usage: drawParameterSet rnd pool

Parameters:
Returns: ParameterPool

Draw a random set of parameters

rnd : Random
pool : ParameterPool
Returns: ParameterPool

generateFixedSeries writeOut equations timeMode seriesLength startPoint startDate resolution env theta

Full Usage: generateFixedSeries writeOut equations timeMode seriesLength startPoint startDate resolution env theta

Parameters:
Returns: Map<ShortCode, TimeSeries<'b>>

Generate a fixed-resolution time-series for testing model fits

writeOut : WriteOut
equations : Map<ShortCode, ('a -> ODE)>
timeMode : TimeMode<'b, float>
seriesLength : int
startPoint : CodedMap<'b>
startDate : DateTime
resolution : FixedTemporalResolution
env : CodedMap<TimeIndex<'b>>
theta : 'a
Returns: Map<ShortCode, TimeSeries<'b>>

generateMeasures measures startValues expected

Full Usage: generateMeasures measures startValues expected

Parameters:
Returns: CodedMap<TimeSeries<float>>

A test procedure for computing measures given time series data.

measures : Map<ShortCode, Measurement<float>>
startValues : Map<ShortCode, float>
expected : CodedMap<TimeSeries<float>>
Returns: CodedMap<TimeSeries<float>>

tryGenerateData engine settings model attempts

Full Usage: tryGenerateData engine settings model attempts

Parameters:
Returns: Result<(CodedMap<TimeSeries<float>> * ParameterPool), string>

Generate data and check that it complies with the given ruleset.

engine : EstimationEngine<float, float>
settings : TestSettings<float>
model : ModelSystem
attempts : int
Returns: Result<(CodedMap<TimeSeries<float>> * ParameterPool), string>

tryGenerateData' engine model testSettings theta

Full Usage: tryGenerateData' engine model testSettings theta

Parameters:
Returns: Result<CodedMap<TimeSeries<float>>, string>

Generate data

engine : EstimationEngine<float, float>
model : ModelSystem
testSettings : TestSettings<float>
theta : Pool
Returns: Result<CodedMap<TimeSeries<float>>, string>

Type something to start searching.