Test (bristlecone) | bristlecone

bristlecone

Test Module

Namespace: Bristlecone
Assembly: Bristlecone.dll
Parent Module: Language

Terms for designing tests for model systems.

Nested modules

Modules	Description
Error

Functions and values

Function or value	Description
`create` Full Usage: `create` Returns: `TestSettings<MeasureOne, DateTime, int<MeasureProduct<year, MeasureOne>>, TimeSpan>`	Start defining conditions for a new test procedure for a model + estimation engine combination. This default uses modern calendar time as the basis. For other date/time systems, use `createWithTimeMode` instead. Returns: `TestSettings<MeasureOne, DateTime, int<MeasureProduct<year, MeasureOne>>, TimeSpan>`
`createWithTimeMode dateMode resolution startDate` Full Usage: `createWithTimeMode dateMode resolution startDate` Parameters: dateMode : `DateMode<'date, 'year, 'timespan>` resolution : `FixedTemporalResolution<'timespan>` startDate : `'date` Returns: `TestSettings<'state, 'date, 'year, 'timespan>`	Start defining conditions for a new test procedure for a model + estimation engine combination. Specify a `dateMode` and associated temporal resolution and start date that are in compatible time systems. dateMode : `DateMode<'date, 'year, 'timespan>` resolution : `FixedTemporalResolution<'timespan>` startDate : `'date` Returns: `TestSettings<'state, 'date, 'year, 'timespan>`
`resolution res settings` Full Usage: `resolution res settings` Parameters: res : `FixedTemporalResolution<'a>` settings : `TestSettings<'u, 'b, 'c, 'a>` Returns: `TestSettings<'u, 'b, 'c, 'a>`	res : `FixedTemporalResolution<'a>` settings : `TestSettings<'u, 'b, 'c, 'a>` Returns: `TestSettings<'u, 'b, 'c, 'a>`
`rule obs rule settings` Full Usage: `rule obs rule settings` Parameters: obs : `ObsForLikelihood<'s>` rule : `GenerationRule<'u>` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`	obs : `ObsForLikelihood<'s>` rule : `GenerationRule<'u>` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`
`seriesLength n settings` Full Usage: `seriesLength n settings` Parameters: n : `int` settings : `TestSettings<'stateUnit, 'date, 'yearUnit, 'timespan>` Returns: `TestSettings<'stateUnit, 'date, 'yearUnit, 'timespan>`	n : `int` settings : `TestSettings<'stateUnit, 'date, 'yearUnit, 'timespan>` Returns: `TestSettings<'stateUnit, 'date, 'yearUnit, 'timespan>`
`startTime time settings` Full Usage: `startTime time settings` Parameters: time : `'a` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`	time : `'a` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`
`t1 obs value settings` Full Usage: `t1 obs value settings` Parameters: obs : `ObsForLikelihood<'s>` value : `float<'s>` settings : `TestSettings<'stateUnit, 'date, 'yearUnit, 'timespan>` Returns: `TestSettings<'stateUnit, 'date, 'yearUnit, 'timespan>`	Set a start value (at t=1). If a value has already been set, it will be overwritten. obs : `ObsForLikelihood<'s>` value : `float<'s>` settings : `TestSettings<'stateUnit, 'date, 'yearUnit, 'timespan>` Returns: `TestSettings<'stateUnit, 'date, 'yearUnit, 'timespan>`
`withEnvironmentGen obs genFn settings` Full Usage: `withEnvironmentGen obs genFn settings` Parameters: obs : `StateId<'s>` genFn : `float<'date> -> float<'s>` settings : `TestSettings<'state, float<'date>, 'a, 'b>` Returns: `TestSettings<'state, float<'date>, 'a, 'b>`	obs : `StateId<'s>` genFn : `float<'date> -> float<'s>` settings : `TestSettings<'state, float<'date>, 'a, 'b>` Returns: `TestSettings<'state, float<'date>, 'a, 'b>`
`withEnvironmentGenBySpan obs genFn gen2 settings` Full Usage: `withEnvironmentGenBySpan obs genFn gen2 settings` Parameters: obs : `StateId<'s>` genFn : `float<'fnTime> -> float<'s>` gen2 : `'timespan -> float<'fnTime>` settings : `TestSettings<'state, 'date, 'yearUnit, 'timespan>` Returns: `TestSettings<'state, 'date, 'yearUnit, 'timespan>`	obs : `StateId<'s>` genFn : `float<'fnTime> -> float<'s>` gen2 : `'timespan -> float<'fnTime>` settings : `TestSettings<'state, 'date, 'yearUnit, 'timespan>` Returns: `TestSettings<'state, 'date, 'yearUnit, 'timespan>`
`withObservationError obs genErrorFn settings` Full Usage: `withObservationError obs genErrorFn settings` Parameters: obs : `ObsForLikelihood<'s>` - The state or measure to add to (use Require.state or Require.measure) genErrorFn : `Random -> ParameterPool -> float<'u> -> float<'u>` - A function that generates error for any point based on its value. settings : `TestSettings<MeasureOne, 'a, 'b, 'c>` - Current test settings Returns: `TestSettings<MeasureOne, 'a, 'b, 'c>` Updated test settings	Add observation error ('noise') to a particular time-series when generating fake time-series. Built-in noise functions are in the `Noise` module. obs : `ObsForLikelihood<'s>` The state or measure to add to (use Require.state or Require.measure) genErrorFn : `Random -> ParameterPool -> float<'u> -> float<'u>` A function that generates error for any point based on its value. settings : `TestSettings<MeasureOne, 'a, 'b, 'c>` Current test settings Returns: `TestSettings<MeasureOne, 'a, 'b, 'c>` Updated test settings