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
TestSettings<'a>

Functions and values

Function or value	Description
`addGenerationRules rules settings` Full Usage: `addGenerationRules rules settings` Parameters: rules : `GenerationRule list` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`	rules : `GenerationRule list` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`
`addNoise noiseFn settings` Full Usage: `addNoise noiseFn settings` Parameters: noiseFn : `Random -> Pool -> CodedMap<TimeSeries<'a>> -> Result<CodedMap<TimeSeries<'a>>, string>` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`	Add noise to a particular time-series when generating fake time-series. Built-in noise functions are in the `Noise` module. noiseFn : `Random -> Pool -> CodedMap<TimeSeries<'a>> -> Result<CodedMap<TimeSeries<'a>>, string>` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`
`addStartValue seriesName value settings` Full Usage: `addStartValue seriesName value settings` Parameters: seriesName : `string` value : `'a` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`	Adds a start value for a time-series. seriesName : `string` value : `'a` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`
`addStartValues values settings` Full Usage: `addStartValues values settings` Parameters: values : `(string * 'a) seq` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`	Adds start values to the test settings. Overwrites any existing start values that may already exist. values : `(string * 'a) seq` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`
`create` Full Usage: `create` Returns: `TestSettings<float>`	Returns: `TestSettings<float>`
`endWhen goal settings` Full Usage: `endWhen goal settings` Parameters: goal : `EndCondition<'a>` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`	goal : `EndCondition<'a>` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`
`isValidSettings model testSettings` Full Usage: `isValidSettings model testSettings` Parameters: model : `ModelSystem` testSettings : `TestSettings<'a>` Returns: `Result<TestSettings<'a>, string>`	Ensures settings are valid for a test, by ensuring that start values have been set for each equation. model : `ModelSystem` testSettings : `TestSettings<'a>` Returns: `Result<TestSettings<'a>, string>`
`useRandom rnd settings` Full Usage: `useRandom rnd settings` Parameters: rnd : `Random` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`	rnd : `Random` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`
`useStartTime time settings` Full Usage: `useStartTime time settings` Parameters: time : `DateTime` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`	time : `DateTime` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`
`withFixedTemporalResolution res settings` Full Usage: `withFixedTemporalResolution res settings` Parameters: res : `FixedTemporalResolution` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`	res : `FixedTemporalResolution` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`
`withTimeSeriesLength n settings` Full Usage: `withTimeSeriesLength n settings` Parameters: n : `int` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`	n : `int` settings : `TestSettings<'a>` Returns: `TestSettings<'a>`