KSLCore/ksl.utilities.statistic/CollectorIfc/collect

collect

open fun collect(v: GetValueIfc)

Collects on the values returned by the supplied GetValueIfc

Parameters

v

the object that returns the value to be collected

open fun collect(obs: Boolean)

Collects on the boolean value true = 1.0, false = 0.0

Parameters

obs

the observation to collect on

open fun collect(fn: () -> Double)

Collect on the double value return by the function

Parameters

fn

the function to invoke to collect doubles

open fun collect(obs: Int)

Collects on the Int value

Parameters

obs

the observation to collect on

open fun collect(obs: Long)

Collects on the Long value

Parameters

obs

the observation to collect on

abstract fun collect(obs: Double)

Collect on the supplied value. Double.NaN, Double.NEGATIVE_INFINITY, and Double.POSITIVE_INFINITY values are counted as missing. Null values are not permitted.

Parameters

obs

a double representing the observation

open fun collect(observations: DoubleArray)
open fun collect(observations: IntArray)
open fun collect(observations: LongArray)
open fun collect(observations: BooleanArray)

Collects on the values in the supplied array.

Parameters

observations

the values, must not be null

open fun collect(observations: Collection<Double>)

Collects on all the values in the supplied collection.