Test (bristlecone) | bristlecone

bristlecone

Test Module

Namespace: Bristlecone
Assembly: Bristlecone.dll

Types and nested modules

Type/Module	Description
Compute
GenerationRules
Noise	Functions for adding background variability into test problems.
ParameterTestResult
TestResult<'date, 'timeunit, 'timespan, 'u>
TestSettings<'stateUnit, 'date, 'yearUnit, 'timespan>

Functions and values

Function or value	Description
`addGenerationRules rules settings` Full Usage: `addGenerationRules rules settings` Parameters: rules : `GenerationRule<'u> list` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`	rules : `GenerationRule<'u> list` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`
`addNoise noiseFn settings` Full Usage: `addNoise noiseFn settings` Parameters: noiseFn : `Random -> ParameterPool -> CodedMap<TimeSeries<float<'u>, 'a, 'b, 'c>> -> Result<CodedMap<TimeSeries<float<'u>, 'a, 'b, 'c>>, string>` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`	Add noise to a particular time-series when generating fake time-series. Built-in noise functions are in the `Noise` module. noiseFn : `Random -> ParameterPool -> CodedMap<TimeSeries<float<'u>, 'a, 'b, 'c>> -> Result<CodedMap<TimeSeries<float<'u>, 'a, 'b, 'c>>, string>` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`
`addStartValue seriesName value settings` Full Usage: `addStartValue seriesName value settings` Parameters: seriesName : `string` value : `float<'u>` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`	Adds a start value for a time-series. seriesName : `string` value : `float<'u>` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`
`addStartValues values settings` Full Usage: `addStartValues values settings` Parameters: values : `(string * float<'u>) seq` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`	Adds start values to the test settings. Overwrites any existing start values that may already exist. values : `(string * float<'u>) seq` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`
`annualSettings` Full Usage: `annualSettings` Returns: `TestSettings<MeasureOne, Annual, int<MeasureProduct<year, MeasureOne>>, int<MeasureProduct<year, MeasureOne>>>`	Returns: `TestSettings<MeasureOne, Annual, int<MeasureProduct<year, MeasureOne>>, int<MeasureProduct<year, MeasureOne>>>`
`defaultSettings` Full Usage: `defaultSettings` Returns: `TestSettings<MeasureOne, DateTime, int<MeasureProduct<year, MeasureOne>>, TimeSpan>`	Returns: `TestSettings<MeasureOne, DateTime, int<MeasureProduct<year, MeasureOne>>, TimeSpan>`
`endWhen goal settings` Full Usage: `endWhen goal settings` Parameters: goal : `EndCondition` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`	goal : `EndCondition` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`
`isValidSettings model testSettings` Full Usage: `isValidSettings model testSettings` Parameters: model : `ModelSystem<'modelTimeUnit>` testSettings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `Result<TestSettings<'u, 'a, 'b, 'c>, string>`	Ensures settings are valid for a test, by ensuring that start values have been set for each equation. model : `ModelSystem<'modelTimeUnit>` testSettings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `Result<TestSettings<'u, 'a, 'b, 'c>, string>`
`useDateMode dateMode startDate settings` Full Usage: `useDateMode dateMode startDate settings` Parameters: dateMode : `DateMode<'a, 'b, 'c>` startDate : `'a` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`	dateMode : `DateMode<'a, 'b, 'c>` startDate : `'a` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`
`useRandom rnd settings` Full Usage: `useRandom rnd settings` Parameters: rnd : `Random` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`	rnd : `Random` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`
`useStartTime time settings` Full Usage: `useStartTime 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>`
`withFixedTemporalResolution res settings` Full Usage: `withFixedTemporalResolution 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>`
`withTimeSeriesLength n settings` Full Usage: `withTimeSeriesLength n settings` Parameters: n : `int` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`	n : `int` settings : `TestSettings<'u, 'a, 'b, 'c>` Returns: `TestSettings<'u, 'a, 'b, 'c>`