KSLCore/ksl.utilities.statistic/WeightedCollector

WeightedCollector

abstract class WeightedCollector(name: String? = null) : Observable<Pair<Double, Double>> , WeightedCollectorIfc, IdentityIfc, DoublePairEmitterIfc

Inheritors

WeightedStatistic

Constructors

WeightedCollector

constructor(name: String? = null)

Properties

emitter

open override val emitter: Emitter<Pair<Double, Double>>

open override val id: Int

label

open override var label: String?

lastValue

open override var lastValue: Double

lastWeight

var lastWeight: Double

name

open override val name: String

value

open override var value: Double

weight

open override val weight: Double

The last weight collected

Functions

attachObserver

open override fun attachObserver(observer: ObserverIfc<Pair<Double, Double>>)

Allows the adding (attaching) of an observer to the observable

collect

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)

open fun collect(observations: DoubleArray, weights: DoubleArray)

Collects on the values in the supplied array.

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)

open fun collect(v: GetValueIfc, w: GetValueIfc)

Collects on the values returned by the supplied GetValueIfc

open override fun collect(obs: Double, weight: Double)

open override fun collect(obs: Double)

Collect on the supplied value

countObservers

open override fun countObservers(): Int

Returns how many observers are currently attached to the observable

detachAllObservers

open override fun detachAllObservers()

Detaches all the observers from the observable

detachObserver

open override fun detachObserver(observer: ObserverIfc<Pair<Double, Double>>)

Allows the deletion (removing) of an observer from the observable

isAttached

open override fun isAttached(observer: ObserverIfc<Pair<Double, Double>>): Boolean

Returns true if the observer is already attached

observe

fun <T> Observable<T>.observe(block: (T?) -> Unit)

reset

open override fun reset()

Resets the collector as if no observations had been collected.