R1.2.2

KSLCore/ksl.simulation/StatisticalBatchingElement

StatisticalBatchingElement

class StatisticalBatchingElement @JvmOverloads constructor(model: Model, batchInterval: Double = 0.0, name: String? = null) : ModelElement(source)

When added to a Model, this class will cause batch statistics to be collected for Response and TWResponse variables. It uses the TWBatchingElement and the ResponseBatchingElement to perform this functionality.

Time weighted variables are first discretized using a supplied batch interval. Then, observation-based batching is applied to the discretized batches. Response variables are batched by observation number.

Author

rossetti

Parameters

model

the model for the batching

batchInterval

the discretizing interval for TWResponse variables

name

the name of the model element

Constructors

StatisticalBatchingElement

constructor(model: Model, batchInterval: Double = 0.0, name: String? = null)

Properties

allBatchStatistics

val allBatchStatistics: List<BatchStatisticIfc>

Returns a list of summary statistics on all Response variables The list is a copy of originals.

allResponseBatchStatisticsAsMap

val allResponseBatchStatisticsAsMap: Map<ResponseCIfc, BatchStatisticIfc>

A map of all batch statistics with the ResponseVariable variable as the key

val allStatistics: List<StatisticIfc>

Returns a list of the batch statistics in the form of StatisticIfc

allTimeWeightedBatchStatisticsAsMap

val allTimeWeightedBatchStatisticsAsMap: Map<TWResponseCIfc, BatchStatisticIfc>

A map of all batch statistics with the TimeWeighted variable as the key

statisticReporter

val statisticReporter: StatisticReporter

Returns a StatisticReporter for reporting the statistics across the batches.

Functions

fun asString(): String

batchStatisticFor

fun batchStatisticFor(response: ResponseCIfc): BatchStatisticIfc

Returns a statistical summary BatchStatistic on the Response variable across the observed batches. This returns a view of the summary statistics.

batchStatisticObserverFor

fun batchStatisticObserverFor(response: ResponseCIfc): BatchStatisticObserver?

Look up the BatchStatisticObserver for the ResponseVariable

fun remove(response: ResponseCIfc)

Removes the supplied ResponseVariable variable from the batching

fun removeAll()

Removes all previously added responses from the batching