Header menu logo bristlecone

Noise Module

Functions for adding background variability into test problems.

Functions and values

Function or value Description

tryAddNoise seriesName noiseDistributionFn data

Full Usage: tryAddNoise seriesName noiseDistributionFn data

Parameters:
    seriesName : string
    noiseDistributionFn : unit -> float
    data : CodedMap<TimeSeries<float>>

Returns: Map<ShortCode, TimeSeries<float>> option

Adds noise to a time-series 'seriesName', based on the given distribution function.

seriesName : string
noiseDistributionFn : unit -> float
data : CodedMap<TimeSeries<float>>
Returns: Map<ShortCode, TimeSeries<float>> option

tryAddNormal sdParamCode seriesName rnd pool data

Full Usage: tryAddNormal sdParamCode seriesName rnd pool data

Parameters:
Returns: Result<Map<ShortCode, TimeSeries<float>>, string>

Adds normally-distributed noise around each data point in the selected time-series. Returns `None` if the series or parameter does not exist.

sdParamCode : string
seriesName : string
rnd : Random
pool : ParameterPool
data : CodedMap<TimeSeries<float>>
Returns: Result<Map<ShortCode, TimeSeries<float>>, string>

Type something to start searching.