KSLCore/ksl.utilities.statistic/StateFrequency

StateFrequency

class StateFrequency(numStates: Int, name: String? = null) : IdentityIfc

Parameters

numStates

the number of states to observe

Constructors

constructor(numStates: Int, name: String? = null)

Properties

val cellList: List<IntegerFrequency.Cell>

Returns a copy of the cells in a list ordered by the value of each cell, 0th element is cell with the smallest value, etc

val frequencies: IntArray

Returns an array of size getNumberOfCells() containing the frequencies by value

open override val id: Int

open override var label: String?

var lastState: State?

var lastValue: Int

open override val name: String

val numberOfValues: Int

Returns the number of cells tabulated This is also the total number of different integers observed

val proportions: DoubleArray

Returns an array of size getNumberOfCells() containing the proportion by value

val stateNames: List<String>

val states: List<State>

val totalCount: Double

The total count associated with the values

transitionCounts

val transitionCounts: Array<IntArray>

transitionProportions

val transitionProportions: Array<DoubleArray>

valueCumulativeProportions

val valueCumulativeProportions: Map<String, DoubleArray>

Returns Map holding the values and cumulative proportions as arrays with keys "values" and "cumulativeProportions"

valueFrequencies

val valueFrequencies: Map<String, IntArray>

Returns Map holding the values and frequencies as arrays with keys "values" and "frequencies"

valueProportions

val valueProportions: Map<String, DoubleArray>

Returns Map holding the values and proportions as arrays with keys "values" and "proportions"

val values: IntArray

Returns an array of size getNumberOfCells() containing the values increasing by value

Functions

fun asString(): String

fun collect(states: Array<State>)

fun collect(states: List<State>)

fun collect(state: State)

Tabulate statistics on the state occurrences

createDEmpiricalCDF

fun createDEmpiricalCDF(): DEmpiricalCDF

cumulativeFrequency

fun cumulativeFrequency(i: Int): Double

Returns the cumulative frequency up to an including i

cumulativeProportion

fun cumulativeProportion(i: Int): Double

Returns the cumulative proportion up to an including i

fun frequencies(x: IntArray): DoubleArray

Interprets the elements of x[] as values and returns an array representing the frequency for each value

fun frequency(x: Int): Double

Returns the current frequency for the provided integer

fun frequencyPlot(proportions: Boolean = false): StateFrequencyPlot

Creates a plot for the state frequencies. The parameter, proportions indicates whether proportions (true) or frequencies (false) will be shown on the plot. The default is false.

operator fun get(index: Int): State

fun proportion(x: Int): Double

Gets the proportion of the observations that are equal to the supplied integer

fun reset()

Resets the statistical collection

fun state(index: Int): State

fun statistic(): Statistic

open override fun toString(): String