KSLCore/ksl.utilities.statistic/ExceedanceEstimator

ExceedanceEstimator

class ExceedanceEstimator(thresholds: DoubleArray = doubleArrayOf(1.0), name: String? = null) : Collector

Tabulates the proportion and frequency for a random variable X > a(i) where a(i) are thresholds.

Author

rossetti

Parameters

name

the name of the estimator

thresholds

the thresholds

Constructors

ExceedanceEstimator

constructor(vararg thresholds: Double)

constructor(thresholds: DoubleArray = doubleArrayOf(1.0), name: String? = null)

Properties

val count: Double

Gets the count of the number of the observations.

open override val emitter: Emitter<Double>

val frequencies: DoubleArray

the array of counts for each threshold

open override val id: Int

open override var label: String?

open override var lastValue: Double

open override val name: String

val numThresholds: Int

val proportions: DoubleArray

the array of proportions for each threshold

open override var value: Double

valueFrequencies

val valueFrequencies: Array<DoubleArray>

2-d array with 2 rows and numThreshold columns row0 holds the thresholds row1 holds the frequencies

valueProportions

val valueProportions: Array<DoubleArray>

2-d array with 2 rows and numThreshold columns row0 holds the thresholds row1 holds the proportions

Functions

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

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

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.

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<Double>)

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

fun frequency(i: Int): Double

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

Returns true if the observer is already attached

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

fun proportion(i: Int): Double

open override fun reset()

Resets the collector as if no observations had been collected.

open override fun toString(): String