KSLCore/ksl.utilities.statistic/WeightedStatisticIfc

WeightedStatisticIfc

interface WeightedStatisticIfc : IdentityIfc, GetCSVStatisticIfc

If the observation or the weight is

infinite or NaN, then the observation should not be recorded and the number of missing observations
is incremented. If the observed weight is negative or 0.0, then the observation should not be recorded and
the number of missing observations is incremented.

Author

rossetti

Inheritors

TimeWeightedStatistic

WeightedStatistic

Properties

count

abstract val count: Double

Gets the count of the number of the observations.

csvStatistic

abstract val csvStatistic: String

csvStatisticHeader

abstract val csvStatisticHeader: String

The header string for the CVS representation

abstract val id: Int

label

abstract var label: String?

lastValue

abstract val lastValue: Double

Gets the last observed data point

lastWeight

abstract val lastWeight: Double

Gets the last observed weight

max

abstract val max: Double

Gets the maximum of the observations.

min

abstract val min: Double

Gets the minimum of the observations.

name

abstract val name: String

numberMissing

abstract 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.

sumOfWeights

abstract val sumOfWeights: Double

Gets the sum of the observed weights.

unWeightedAverage

open val unWeightedAverage: Double

unWeightedSum

abstract val unWeightedSum: Double

weightedAverage

abstract val weightedAverage: Double

Gets the weighted average of the collected observations.

weightedSum

abstract val weightedSum: Double