KSLCore/ksl.utilities.statistic/StringFrequency

StringFrequency

class StringFrequency(data: Collection<String>? = null, name: String? = null, val limitSet: Set<String>? = null) : IdentityIfc

This class tabulates the frequency associated with the strings presented to it via the collect() method. For every unique string presented a count is maintained. There could be space/time performance issues if the number of different strings presented is large. Use the limit set to limit the values that can be observed. If the presented strings are not in the limiting set, then they are counted as "Other".

This class can be useful for tabulating a discrete histogram over the values (strings) presented.

Author

rossetti

Parameters

name

a name for the instance

data

an array of data to tabulate

limitSet

a set of strings that limit what is to be counted. If null, there is no limit. That is, every unique string presented is tabulated.

Constructors

StringFrequency

constructor(data: Collection<String>? = null, name: String? = null, limitSet: Set<String>? = null)

Types

Cell

inner class Cell(val string: String) : Comparable<StringFrequency.Cell>

Holds the values and their counts

Properties

frequencies

val frequencies: IntArray

Returns an array of size numberOfCells containing the frequencies for each string observed. The 0th element is the frequency for the string stored at element 0 of the array returned by the values property

open override val id: Int

label

open override var label: String?

limitSet

val limitSet: Set<String>? = null

name

open override val name: String

numberOfStrings

val numberOfStrings: Int

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

otherCount

var otherCount: Int

proportions

val proportions: DoubleArray

Returns an array of size numberOfCells containing the proportion by value. The 0th element is the proportion for the value stored at element 0 of the array returned by the values property, etc.

stringCumulativeFrequencies

val stringCumulativeFrequencies: Map<String, Int>

Returns Map holding the string and cumulative proportions as elements in the map

stringFrequencies

val stringFrequencies: Map<String, Int>

Returns Map holding the observed strings and frequencies within the map

stringProportions

val stringProportions: Map<String, Double>

Returns Map holding the strings and associated proportions.

strings

val strings: List<String>

Returns a list of size numberOfCells containing the observed strings in the order in which they were observed. The 0th element of the array contains the first string observed, 1st element the next unique string, etc.

totalCount

var totalCount: Int

Functions

cellList

fun cellList(): List<StringFrequency.Cell>

Returns a copy of the cells in a list.

cellsSortedByCount

fun cellsSortedByCount(): List<StringFrequency.Cell>

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

collect

fun collect(thing: Any)

Converts the thing via toString() and tabulates the observed string.

fun collect(strings: Array<String>)

fun collect(strings: Collection<String>)

fun collect(string: String)

Tabulates the count of the number of unique strings presented.

createDEmpiricalList

fun createDEmpiricalList(): DEmpiricalList<String>

cumulativeFrequency

fun cumulativeFrequency(string: String): Double

Returns the cumulative frequency up to an including the string

cumulativeProportion

fun cumulativeProportion(string: String): Double

Returns the cumulative proportion up to an including the supplied string

frequencies

fun frequencies(x: Array<String>): DoubleArray

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

frequency

fun frequency(string: String): Double

Returns the current frequency for the provided string

frequencyData

fun frequencyData(sortedByCount: Boolean = false): List<StringFrequencyData>

Returns the data associated with the tabulation.

frequencyPlot

fun frequencyPlot(proportions: Boolean = false): StringFrequencyPlot

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

proportion

fun proportion(string: String): Double

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

reset

fun reset()

Resets the statistical collection

toString

open override fun toString(): String