KSLCore/ksl.utilities.statistic/TimeWeightedStatistic

TimeWeightedStatistic

class TimeWeightedStatistic(var timeGetter: GetTimeIfc = DefaultTimeGetter(), initialValue: Double = 0.0, initialTime: Double = 0.0) : Collector, WeightedStatisticIfc

Collects time weighted statistics that are presented to the collect() method. The property, timeGetter, must provide values for each observed value that appears in the collect method.

Parameters

initialTime

assumed to be 0.0 by default

initialValue

assumed to be 0.0 by default

Constructors

TimeWeightedStatistic

constructor(values: DoubleArray, times: DoubleArray, initialValue: Double = 0.0, initialTime: Double = 0.0)

constructor(timeGetter: GetTimeIfc = DefaultTimeGetter(), initialValue: Double = 0.0, initialTime: Double = 0.0)

Properties

count

open override val count: Double

Gets the count of the number of the observations.

csvStatistic

open override val csvStatistic: String

csvStatisticHeader

open override val csvStatisticHeader: String

The header string for the CVS representation

emitter

open override val emitter: Emitter<Double>

open override val id: Int

label

open override var label: String?

lastValue

open override var lastValue: Double

lastWeight

open override val lastWeight: Double

Gets the last observed weight

max

open override val max: Double

Gets the maximum of the observations.

min

open override val min: Double

Gets the minimum of the observations.

name

open override val name: String

numberMissing

open override val numberMissing: Double

When a data point having the value of (Double.NaN, Double.POSITIVE_INFINITY, Double.NEGATIVE_INFINITY) are presented it is excluded from the summary statistics and the number of missing points is noted. If the weight is infinite or less than or equal to zero, then the data point should not be recorded. This method reports the number of missing points that occurred during the collection.

statistics

val statistics: DoubleArray

sumOfWeights

open override val sumOfWeights: Double

Gets the sum of the observed weights.

timeGetter

var timeGetter: GetTimeIfc

unWeightedAverage

open val unWeightedAverage: Double

unWeightedSum

open override val unWeightedSum: Double

updateTimeAtReset

var updateTimeAtReset: Boolean

value

open override var value: Double

weightedAverage

open override val weightedAverage: Double

Gets the weighted average of the collected observations.

weightedSum

open override val weightedSum: Double

Gets the weighted sum of observations observed.

weightedSumOfSquares

open override val weightedSumOfSquares: Double

Gets the weighted sum of squares for observations observed.

Functions

attachObserver

open override fun attachObserver(observer: ObserverIfc<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)

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)

Collects on the values returned by the supplied GetValueIfc

open override 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.

fun collect(obs: Double, time: Double)

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