Header menu logo bristlecone

Compute Module

Functions and values

Function or value Description

tryGenerateData engine settings model attempts

Full Usage: tryGenerateData engine settings model attempts

Parameters:
Returns: Result<(CodedMap<TimeSeries<float<'state>, 'date, 'timeunit, 'timespan>> * ParameterPool), string>

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

engine : EstimationEngine<'date, 'timespan, 'modelTimeUnit, 'state>
settings : TestSettings<'state, 'date, 'timeunit, 'timespan>
model : ModelSystem<'modelTimeUnit>
attempts : int
Returns: Result<(CodedMap<TimeSeries<float<'state>, 'date, 'timeunit, 'timespan>> * ParameterPool), string>

tryGenerateData' engine model testSettings thetaPool

Full Usage: tryGenerateData' engine model testSettings thetaPool

Parameters:
Returns: Result<CodedMap<TimeSeries<float<'T>, 'date, 'timeunit, 'timespan>>, string>

Generate time-series for a given engine and model, and for a particular point in optim-space.

engine : EstimationEngine<'date, 'timespan, 'modelTimeUnit, 'u>
model : ModelSystem<'modelTimeUnit>
testSettings : TestSettings<'T, 'date, 'timeunit, 'timespan>
thetaPool : ParameterPool
Returns: Result<CodedMap<TimeSeries<float<'T>, 'date, 'timeunit, 'timespan>>, string>

tryMakeDummySeries startDate resolution length eqs dateMode

Full Usage: tryMakeDummySeries startDate resolution length eqs dateMode

Parameters:
Returns: TimeFrame<float<'state>, 'T, 'yearType, 'timespan> option
startDate : 'T
resolution : FixedTemporalResolution<'timespan>
length : int
eqs : ModelForm<'timeunit>
dateMode : DateMode<'T, 'yearType, 'timespan>
Returns: TimeFrame<float<'state>, 'T, 'yearType, 'timespan> option

Type something to start searching.