KSLCore/ksl.utilities.statistic/WeightedStatistic

WeightedStatistic

class WeightedStatistic(name: String? = null) : WeightedCollector, WeightedStatisticIfc, Comparable<WeightedStatistic>

Collects a basic weighted statistical summary. If the observation or the weight is infinite or NaN, then the observation is not recorded and the number of missing observations is incremented. If the observed weight is negative or 0.0, then the observation is not recorded and the number of missing observations is incremented.

Author

rossetti

Constructors

WeightedStatistic

constructor(name: String? = null)

Types

object Companion

Properties

open override val count: Double

Gets the count of the number of the observations.

open override val csvStatistic: String

csvStatisticHeader

open override val csvStatisticHeader: String

The header string for the CVS representation

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

open override val id: Int

open override var label: String?

open override var lastValue: Double

var lastWeight: Double

open override val max: Double

Gets the maximum of the observations.

open override val min: Double

Gets the minimum of the observations.

open override val name: String

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.

val statistics: DoubleArray

Returns an array with the statistics defined by index = statistic

statisticsHeader

val statisticsHeader: Array<String>

s0 = "Count"; s1 = "Average"; s2 = "Minimum"; s3 = "Maximum"; s4 = "Weighted Sum"; s5 = "Sum of Weights"; s6 = "Weighted sum of squares"; s7 = "Last Value"; s8 = "Last Weight"; s9 = "Unweighted Sum"; s10 = "Unweighted Average";

open override val sumOfWeights: Double

Gets the sum of the observed weights.

unWeightedAverage

open val unWeightedAverage: Double

open override val unWeightedSum: Double

open override var value: Double

open override val weight: Double

The last weight collected

weightedAverage

open override val weightedAverage: Double

Gets the weighted average of the collected observations.

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

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

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

fun average(): Double

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)

Collect on the supplied value

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

open operator override fun compareTo(other: WeightedStatistic): Int

Returns a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object.

fun count(): Double

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

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

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

fun instance(): WeightedStatistic

Creates an instance of Statistic that is a copy of this Statistic All internal state is the same except for the id of the returned Statistic

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

Returns true if the observer is already attached

fun max(): Double

fun min(): Double

fun numberMissing(): Double

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

open override fun reset()

Resets the collector as if no observations had been collected.

fun statistics(statistics: DoubleArray)

Fills up the supplied array with the statistics defined by index = statistic

fun sumOfWeights(): Double

open override fun toString(): String

Returns a String representation of the WeightedStatistic

fun unWeightedSum(): Double

fun weightedSum(): Double

weightedSumOfSquares

fun weightedSumOfSquares(): Double