IntegerFrequencyResponse

class IntegerFrequencyResponse @JvmOverloads constructor(parent: ModelElement, name: String? = null, lowerLimit: Int = Int.MIN_VALUE, upperLimit: Int = Int.MAX_VALUE) : ModelElement, FrequencyResponseCIfc(source)

This class tabulates the frequency associated with the integers presented to it. Every value presented is interpreted as an integer For every value presented a count is maintained. There could be space/time performance issues if the number of different values presented is large. Use lowerLimit and upperLimit to limit the values that can be observed. Values lower than the lower limit are counted as underflow, and values greater than the upper limit are counted as overflow.

The frequency tabulates all within replication observations regardless of replication. That is, the frequency is based on every observation for every replication. It observes observations that may have been within a warmup period even if the modeler specifies a warmup period.

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

Author

rossetti

Parameters

parent

the parent of this model element

lowerLimit

the defined lower limit of the integers, values less than this are not tabulated

upperLimit

the defined upper limit of the integers, values less than this are not tabulated

name

a name for the instance

Constructors

Link copied to clipboard
constructor(parent: ModelElement, name: String? = null, intRange: IntRange = Int.MIN_VALUE..Int.MAX_VALUE)

This class tabulates the frequency associated with the integers presented to it. Every value presented is interpreted as an integer For every value presented a count is maintained. There could be space/time performance issues if the number of different values presented is large. Use intRange to limit the values within the specified range that can be observed. Values lower than the lower limit are counted as underflow, and values greater than the upper limit are counted as overflow.

constructor(parent: ModelElement, name: String? = null, lowerLimit: Int = Int.MIN_VALUE, upperLimit: Int = Int.MAX_VALUE)

Properties

Link copied to clipboard
@set:KSLControl(controlType = ControlType.BOOLEAN)
var collectionOn: Boolean
Link copied to clipboard
Link copied to clipboard
var value: Int

Functions

Link copied to clipboard
fun collect(value: Double)

Converts the double to an integer by truncating (toInt()) before the collection

fun collect(value: Int)
Link copied to clipboard
open override fun toString(): String

Includes the model name, the id, the model element name, the parent name, and parent id