RandomEmpiricalMap

class RandomEmpiricalMap<K, V>(parent: ModelElement, rMap: REmpiricalMap<K, V>, name: String? = null) : ModelElement, Map<K, V> , RElementIfc<V>

Allows random selection of elements from the map. The supplied map must have at least one element. The supplied array must represent a valid cumulative distribution function over the same number of elements as in the map.

Constructors

Link copied to clipboard
constructor(parent: ModelElement, map: Map<K, V>, theCDF: DoubleArray, streamNum: Int = 0, name: String? = null)
constructor(parent: ModelElement, rMap: REmpiricalMap<K, V>, name: String? = null)

Properties

Link copied to clipboard

If true, the stream will automatically participate in having its stream advanced to the next sub-stream via stream managers

Link copied to clipboard

A flag to control if the model element reacts to after experiment actions.

Link copied to clipboard

A flag to control whether the model element reacts to after replication actions.

Link copied to clipboard
open override var antithetic: Boolean

Tells the stream to start producing antithetic variates

Link copied to clipboard

A flag to control if the model element reacts to before experiment actions.

Link copied to clipboard

A flag to control if the model element reacts to before replication actions.

Link copied to clipboard

Indicates the current status of the model element for observers of ModelElement.Status

Link copied to clipboard
open override val entries: Set<Map.Entry<K, V>>
Link copied to clipboard
open override val id: Int
Link copied to clipboard

A flag to control if the model element reacts to initialization actions

Link copied to clipboard
open override val keys: Set<K>
Link copied to clipboard
open override var label: String?
Link copied to clipboard

the left traversal count for pre-order traversal of the model element tree

Link copied to clipboard

the model that contains this element

Link copied to clipboard

Returns a string representation of the model element and its child model elements. Useful for realizing the model element hierarchy.

Link copied to clipboard

A flag to control if the model element participates in monte carlo actions.

Link copied to clipboard
override val name: String
Link copied to clipboard

Gets the number of model elements contained by the model element.

Link copied to clipboard
open override val parentName: String?
Link copied to clipboard

Indicates the previous status of the model element for observers of ModelElement.Status This allows the transition to be noted by observers

Link copied to clipboard
open override val randomElement: V

Returns an element randomly selected from the list

Link copied to clipboard

A flag to control if the model element reacts to end replication actions.

Link copied to clipboard
open override var resetStartStreamOption: Boolean

If true, the stream will automatically participate in having its stream reset to its start stream via stream managers

Link copied to clipboard

the right traversal count for pre-order traversal of the model element tree

Link copied to clipboard
open override val size: Int
Link copied to clipboard

The spatial model associated with this model element. By default, each model element uses its parent model element's spatial model unless changed via this property. This changes the spatial model for this model element and no others.

Link copied to clipboard
open override val streamNumber: Int
Link copied to clipboard
Link copied to clipboard
override val time: Double
Link copied to clipboard

The time interval between TimedUpdate events. The default is zero, indicating no timed update

Link copied to clipboard

Specifies whether this model element participates in time update event specified by its parent

Link copied to clipboard

Specifies the havingPriority of this model element's timed update event.

Link copied to clipboard
open override val values: Collection<V>
Link copied to clipboard

Indicates whether the warm-up action occurred sometime during the simulation for this model element. False indicates that the warm-up action has not occurred

Link copied to clipboard

Specifies if this model element is warmed up when the warmup action occurs for its parent. The warm-up flag indicates whether this model element will be warmed up when its parent warm-up event/action occurs. The default value for all model elements is true. A value of true implies that the model element allows its parent's warm up event to call the warm-up action. A value of false implies that the model element does not allow its parent's warm up event to call the warm-up action. False does not necessarily mean that the model element will not be warmed up. It may, through the use of the lengthOfWarmUp property, have its own warm-up event and action.

Link copied to clipboard

Specifies the priority of this model element's warm up event.

Functions

Link copied to clipboard
open override fun advanceToNextSubStream()

Positions the RNG at the beginning of its next substream

Link copied to clipboard
fun <T> BernoulliPicker(successProbability: Double, successOption: T, failureOption: T, streamNum: Int = 0): BernoulliPicker<T>
Link copied to clipboard
fun BernoulliRV(probOfSuccess: Double, streamNum: Int = 0, name: String? = null): BernoulliRV
Link copied to clipboard
fun BetaRV(alpha1: Double, alpha2: Double, streamNum: Int = 0, name: String? = null): BetaRV
Link copied to clipboard
fun BinomialRV(pSuccess: Double, numTrials: Int, streamNum: Int = 0, name: String? = null): BinomialRV
Link copied to clipboard

Computes the box plot summaries for the data within the map

Link copied to clipboard

Cancels the timed update event for this model element.

Link copied to clipboard

Cancels the warm-up event for this model element.

Link copied to clipboard

Checks if this model element or any model element directly above this model element in the hierarchy of model elements all the way until the top Model participates in the warm-up action.

Link copied to clipboard

Computes the confidence intervals for the data in the map

Link copied to clipboard
fun ConstantRV(value: Double, name: String? = null): ConstantRV
Link copied to clipboard
open override fun containsKey(key: K): Boolean
Link copied to clipboard
open override fun containsValue(value: V): Boolean
Link copied to clipboard
fun day(): Double

Returns the value of a 1-day time interval in terms of the base time unit

Link copied to clipboard
fun <T> DEmpiricalList(elements: List<T>, theCDF: DoubleArray, streamNum: Int = 0): DEmpiricalList<T>
Link copied to clipboard
fun DEmpiricalRV(values: DoubleArray, cdf: DoubleArray, streamNum: Int = 0, name: String? = null): DEmpiricalRV
Link copied to clipboard
fun DPopulation(elements: DoubleArray, streamNum: Int = 0): DPopulation
Link copied to clipboard
fun <T> DUniformList(elements: MutableList<T> = mutableListOf(), streamNum: Int = 0): DUniformList<T>
Link copied to clipboard
fun DUniformRV(range: IntRange, streamNum: Int = 0, name: String? = null): DUniformRV
fun DUniformRV(min: Int, max: Int, streamNum: Int = 0, name: String? = null): DUniformRV
Link copied to clipboard
fun EmpiricalRV(data: DoubleArray, streamNum: Int = 0, name: String? = null): EmpiricalRV
fun EmpiricalRV(interval: Interval, numPoints: Int, streamNum: Int = 0, name: String? = null): EmpiricalRV
fun EmpiricalRV(lowerLimit: Double, numPoints: Int, width: Double, streamNum: Int = 0, name: String? = null): EmpiricalRV
Link copied to clipboard
fun ExponentialRV(mean: Double, streamNum: Int = 0, name: String? = null): ExponentialRV
Link copied to clipboard

Find the first parent that has its own warm-up event this guarantees that all elements below the found model element do not have their own warm-up event. A model element that has its own warm-up event also opts out of the warm-up action. If the returned parent is the Model, then all are controlled by the model (unless they opt out). Elements can opt out and not have their own warm-up event. Thus, they have no warm-up at all.

Link copied to clipboard
fun GammaRV(shape: Double, scale: Double, streamNum: Int = 0, name: String? = null): GammaRV
Link copied to clipboard
fun GeneralizedBetaRV(alpha: Double, beta: Double, min: Double, max: Double, streamNum: Int = 0, name: String? = null): GeneralizedBetaRV
Link copied to clipboard
fun GeometricRV(probOfSuccess: Double, streamNum: Int = 0, name: String? = null): GeometricRV
Link copied to clipboard
open operator override fun get(key: K): V?
Link copied to clipboard

Fills up the supplied StringBuilder carrying a string representation of the model element and its child model elements Useful for realizing the model element hierarchy.

Link copied to clipboard

This method returns the planned time for the warm-up for this model element.

Link copied to clipboard
fun hour(): Double

Returns the value of a 1-hour time interval in terms of the base time unit

Link copied to clipboard
fun Hyper2ExponentialRV(mixingProb: Double, mean1: Double, mean2: Double, streamNum: Int = 0, name: String? = null): Hyper2ExponentialRV
Link copied to clipboard

Fills a StringBuilder carrying the model element names in the order that they will be initialized

Link copied to clipboard

Checks if a warm-up event is scheduled for any model element directly above this model element in the hierarchy of model elements all the way until the top Model.

Link copied to clipboard
open override fun isEmpty(): Boolean
Link copied to clipboard

The map of arrays is considered rectangular if all arrays in the map have the same number of elements (same size).

Link copied to clipboard

Checks if current status is the supplied status

Link copied to clipboard

Checks if a timed update event has been scheduled for this model element

Link copied to clipboard

Checks if a warm-up event has been scheduled for this model element

Link copied to clipboard
fun JohnsonBRV(alpha: Double, beta: Double, min: Double, max: Double, streamNum: Int = 0, name: String? = null): JohnsonBRV
Link copied to clipboard
fun LaplaceRV(location: Double, scale: Double, streamNum: Int = 0, name: String? = null): LaplaceRV
Link copied to clipboard
fun LogisticRV(location: Double, scale: Double, streamNum: Int = 0, name: String? = null): LogisticRV
Link copied to clipboard
fun LogLogisticRV(shape: Double, scale: Double, streamNum: Int = 0, name: String? = null): LogLogisticRV
Link copied to clipboard
fun LognormalRV(mean: Double, variance: Double, streamNum: Int = 0, name: String? = null): LognormalRV
Link copied to clipboard

Returns the value of a 1-millisecond time interval in terms of the base time unit

Link copied to clipboard
fun minute(): Double

Returns the value of a 1-minute time interval in terms of the base time unit. For example, if the time unit is set to hours, then minute() should return 0.0166 (TIME_UNIT_MINUTE/TIME_UNIT_HOUR)

Link copied to clipboard
fun MixtureRV(list: List<RVariableIfc>, cdf: DoubleArray, streamNum: Int = 0, name: String? = null): MixtureRV
Link copied to clipboard
fun NormalRV(mean: Double, variance: Double, streamNum: Int = 0, name: String? = null): NormalRV
Link copied to clipboard
fun PearsonType5RV(shape: Double, scale: Double, streamNum: Int = 0, name: String? = null): PearsonType5RV
Link copied to clipboard
fun PearsonType6RV(alpha1: Double, alpha2: Double, beta: Double, streamNum: Int = 0, name: String? = null): PearsonType6RV
Link copied to clipboard
fun PoissonRV(mean: Double, streamNum: Int = 0, name: String? = null): PoissonRV
Link copied to clipboard
fun PWCEmpiricalRV(histogram: HistogramIfc, streamNum: Int = 0, name: String? = null): PWCEmpiricalRV
fun PWCEmpiricalRV(breakPoints: DoubleArray, proportions: DoubleArray = DoubleArray(breakPoints.size - 1) { 1.0 / (breakPoints.size - 1) }, streamNum: Int = 0, name: String? = null): PWCEmpiricalRV
Link copied to clipboard
open override fun resetStartStream()

The resetStartStream method will position the RNG at the beginning of its stream. This is the same location in the stream as assigned when the RNG was created and initialized.

Link copied to clipboard
open override fun resetStartSubStream()

Resets the position of the RNG at the start of the current substream

Link copied to clipboard
open override fun sample(): V

Returns an element randomly selected from the list

open override fun sample(size: Int): List<V>

Returns sample of size from the list

Link copied to clipboard
fun second(): Double

Returns the value of a 1-second time interval in terms of the base time unit

Link copied to clipboard

Sets the after experiment option of all model elements (children) contained by this model element.

Sets the after replication flag of all model elements (children) contained by this model element.

Sets the before experiment option of all model elements (children) contained by this model element.

Sets the before replication flag of all model elements (children) contained by this model element.

Link copied to clipboard

Sets the initialization option of all model elements (children) contained by this model element.

Link copied to clipboard

Sets the monte carlo option flag of all model elements (children) contained by this model element.

Sets the end replication option flag of all model elements (children) contained by this model element. Determines whether the replicationEnded() method will be called

Link copied to clipboard

Sets the timed update option flag of all model elements (children) contained by this model element.

Link copied to clipboard

Sets the warm-up option flag of all model elements (children) contained by this model element.

Link copied to clipboard
fun ShiftedGeometricRV(probOfSuccess: Double, streamNum: Int = 0, name: String? = null): ShiftedGeometricRV
Link copied to clipboard
fun ShiftedRV(shift: Double, rv: RVariableIfc, streamNum: Int = 0, name: String? = null): ShiftedRV
Link copied to clipboard
fun <K, V : Comparable<V>> Map<K, V>.sortMapByValue(): Map<K, V>
Link copied to clipboard
Link copied to clipboard

Computes the statistical summaries for the data within the map

Link copied to clipboard
open override fun time(): Double
Link copied to clipboard

Converts the data map to a 2-D array. The values of the map are extracted

Link copied to clipboard
fun Map<String, DoubleArray>.toDataFrame(): AnyFrame

Converts the data stored in each array to columns within a DataFrame, with the column names as the key from the map and the columns holding the data. Each array must have the same size.

Link copied to clipboard
Link copied to clipboard

Converts the inner DoubleArray to List

Link copied to clipboard
fun Map<String, DoubleArray>.toObservationData(tableName: String = "tblObservations", context: String? = null, subject: String? = null): List<ObservationDataDb>

Converts the data map to a long format view of the observations.

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

Link copied to clipboard
fun TriangularRV(min: Double, mode: Double, max: Double, streamNum: Int = 0, name: String? = null): TriangularRV
Link copied to clipboard
fun TruncatedNormalRV(mean: Double, variance: Double, interval: Interval, streamNum: Int = 0, name: String? = null): TruncatedNormalRV
Link copied to clipboard
fun TruncatedRV(distribution: InvertibleCDFIfc, cdfLL: Double, cdfUL: Double, lowerLimit: Double, upperLimit: Double, streamNum: Int = 0, name: String? = null): TruncatedRV
Link copied to clipboard
fun UniformRV(interval: Interval, streamNum: Int = 0, name: String? = null): UniformRV
fun UniformRV(min: Double, max: Double, streamNum: Int = 0, name: String? = null): UniformRV
Link copied to clipboard
fun week(): Double

Returns the value of a 1-week time interval in terms of the base time unit

Link copied to clipboard
fun WeibullRV(shape: Double, scale: Double, streamNum: Int = 0, name: String? = null): WeibullRV