KSLCore/ksl.utilities.statistic/TimeWeightedStatistic

TimeWeightedStatistic

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

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

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.

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

unWeightedSum

open override val unWeightedSum: Double

updateTimeAtReset

var updateTimeAtReset: Boolean

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

collect

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)

reset

open override fun reset()

Resets the collector as if no observations had been collected.

toString

open override fun toString(): String