Integer
This class tabulates the frequency associated with the integers presented to it based on the attached variable. 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
the parent of this model element
the defined lower limit of the integers, values less than this are not tabulated
the defined upper limit of the integers, values less than this are not tabulated
a name for the instance
Constructors
This class tabulates the frequency associated with the integers presented to it based on the attached variable. 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.
Properties
A flag to control whether the model element reacts to after experiment actions.
A flag to control whether the model element reacts to after replication actions.
A flag to control whether the model element reacts to before experiment actions.
A flag to control whether the model element reacts to before replication actions.
Returns a closed range over the observed integer values
Indicates the current status of the model element for observers of ModelElement.Status
Returns an array of size numberOfCells containing the frequencies for each value observed. The 0th element is the frequency for the value stored at element 0 of the array returned by the values property
A flag to control whether the model element reacts to initialization actions
the left traversal count for pre-order traversal of the model element tree
The lower limit that defines values that will not be observed, but counted as underflow.
Returns a string representation of the model element and its child model elements. Useful for realizing the model element hierarchy.
A flag to control whether the model element participates in monte carlo actions.
Gets the number of model elements contained by this model elements.
Returns the number of cells tabulated This is also the total number of different integers observed
The number of observations that fell past the last bin's upper limit
Indicates the previous status of the model element for observers of ModelElement.Status This allows the transition to be noted by observers
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.
A flag to control whether the model element reacts to end replication actions.
the right traversal count for pre-order traversal of the model element tree
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.
The time interval between TimedUpdate events. The default is zero, indicating no timed update
Specifies whether this model element participates in time update event specified by its parent
Specifies the havingPriority of this model element's timed update event.
The total count associated with the values The total number of values observed
The number of observations that fell below the first bin's lower limit
The upper limit that defines values that will not be observed, but counted as overflow.
Returns Map holding the values and cumulative proportions as arrays with keys "values" and "cumulativeProportions"
Returns Map holding the values and frequencies as arrays with keys "values" and "frequencies"
Returns Map holding the values and proportions as arrays with keys "values" and "proportions"
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
Specifies if this model element will be 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.
Specifies the priority of this model element's warm up event.
Functions
Assigns a string label to each observed integer value. If the integer values in the labels map is not one of the observed values then no assignment occurs and the default label is used. This should be done after collection because cells are created during the collection process.
Cancels the timed update event for this model element.
Cancels the warm-up event for this model element.
Returns a copy of the cells in a list ordered by the value of each cell, 0th element is cell with the smallest value (integer) observed, etc
Returns a sorted list containing the cells
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
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.
Returns the cumulative frequency up to an including i
Returns the cumulative proportion up to an including i
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.
Text output for the frequency without the summary statistics.
Interprets the elements of x[] as values and returns an array representing the frequency for each value
Returns the data associated with the tabulation.
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.
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.
This method returns the planned time for the warm-up for this model element.
Fills a StringBuilder carrying the model element names in the order that they will be initialized
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.
Checks if current status is the supplied status
Checks if a timed update event has been scheduled for this model element
Checks if a warm-up event has been scheduled for this model element
Returns the value of a 1 millisecond time interval in terms of the base time unit
Gets the proportion of the observations that are equal to the supplied integer
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.
Sets the initialization option of all model elements (children) contained by this model element.
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
Sets the timed update option flag of all model elements (children) contained by this model element.
Sets the warm-up option flag of all model elements (children) contained by this model element.
Converts the integer frequency data into a dataframe representation