R1.2.2

KSLCore/ksl.utilities.statistic/ExceedanceEstimator

ExceedanceEstimator

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

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.

val frequencies: DoubleArray

the array of counts for each threshold

val numThresholds: Int

val proportions: DoubleArray

the array of proportions for each threshold

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 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 frequency(i: Int): Double

fun proportion(i: Int): Double

open override fun reset()

Resets the collector as if no observations had been collected.

open override fun toString(): String