KSLCore/ksl.utilities.statistic/CollectorIfc

CollectorIfc

interface CollectorIfc : LastValueIfc, ValueIfc

This interface represents a general set of methods for data collection. The collect() method takes in the supplied data and collects it in some manner as specified by the collector.

Author

rossetti

Inheritors

Properties

Link copied to clipboard
abstract val lastValue: Double
Link copied to clipboard
abstract val value: Double

Functions

Link copied to clipboard
open fun collect(obs: Boolean)

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

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

Collects on the values in the supplied array.

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.

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

Collect on the double value return by the function

open fun collect(obs: Int)

Collects on the Int value

open fun collect(obs: Long)

Collects on the Long value

open fun collect(observations: Collection<Double>)

Collects on all the values in the supplied collection.

open fun collect(v: GetValueIfc)

Collects on the values returned by the supplied GetValueIfc

Link copied to clipboard
abstract fun reset()

Resets the collector as if no observations had been collected.