Simulation.Aivika.Trans.Results.Transform

Tested with: GHC 8.0.1

The module defines useful result transformations that can be used in simulation experiments.

Basic Class Type

class ResultTransformer t m where

Something that can transform the results.

Minimal complete definition

tr

Methods

tr :: t m -> ResultTransform m

Return the result transform.

Instances

ResultTransformer Operation m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: Operation m -> ResultTransform m

ResultTransformer Resource m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: Resource m -> ResultTransform m

ResultTransformer Activity m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: Activity m -> ResultTransform m

ResultTransformer Server m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: Server m -> ResultTransform m

ResultTransformer ArrivalTimer m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: ArrivalTimer m -> ResultTransform m

ResultTransformer Queue m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: Queue m -> ResultTransform m

ResultTransformer TimingCounter m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: TimingCounter m -> ResultTransform m

ResultTransformer TimingStats m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: TimingStats m -> ResultTransform m

ResultTransformer SamplingCounter m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: SamplingCounter m -> ResultTransform m

ResultTransformer SamplingStats m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: SamplingStats m -> ResultTransform m

Sampling Statistics

newtype SamplingStats m

Represents a statistics based upon observations.

Constructors

SamplingStats (ResultTransform m)

Instances

ResultTransformer SamplingStats m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: SamplingStats m -> ResultTransform m

samplingStatsCount :: MonadDES m => SamplingStats m -> ResultTransform m

The total number of samples.

samplingStatsMin :: MonadDES m => SamplingStats m -> ResultTransform m

The minimum value among the samples.

samplingStatsMax :: MonadDES m => SamplingStats m -> ResultTransform m

The maximum value among the samples.

samplingStatsMean :: MonadDES m => SamplingStats m -> ResultTransform m

The average value.

samplingStatsMean2 :: MonadDES m => SamplingStats m -> ResultTransform m

The average square value.

samplingStatsVariance :: MonadDES m => SamplingStats m -> ResultTransform m

Return tha variance.

samplingStatsDeviation :: MonadDES m => SamplingStats m -> ResultTransform m

Return the deviation.

Time-dependent Statistics

newtype TimingStats m

The time-dependent statistics.

Constructors

TimingStats (ResultTransform m)

Instances

ResultTransformer TimingStats m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: TimingStats m -> ResultTransform m

timingStatsCount :: MonadDES m => TimingStats m -> ResultTransform m

Return the number of samples.

timingStatsMin :: MonadDES m => TimingStats m -> ResultTransform m

Return the minimum value.

timingStatsMax :: MonadDES m => TimingStats m -> ResultTransform m

Return the maximum value.

timingStatsMean :: MonadDES m => TimingStats m -> ResultTransform m

Return the average value.

timingStatsVariance :: MonadDES m => TimingStats m -> ResultTransform m

Return the variance.

timingStatsDeviation :: MonadDES m => TimingStats m -> ResultTransform m

Return the deviation.

timingStatsMinTime :: MonadDES m => TimingStats m -> ResultTransform m

Return the time at which the minimum is attained.

timingStatsMaxTime :: MonadDES m => TimingStats m -> ResultTransform m

Return the time at which the maximum is attained.

timingStatsStartTime :: MonadDES m => TimingStats m -> ResultTransform m

Return the start time of sampling.

timingStatsLastTime :: MonadDES m => TimingStats m -> ResultTransform m

Return the last time of sampling.

timingStatsSum :: MonadDES m => TimingStats m -> ResultTransform m

Return the sum of values.

timingStatsSum2 :: MonadDES m => TimingStats m -> ResultTransform m

Return the sum of square values.

Sampling-based Counter

newtype SamplingCounter m

A counter for which the statistics is collected too.

Constructors

SamplingCounter (ResultTransform m)

Instances

ResultTransformer SamplingCounter m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: SamplingCounter m -> ResultTransform m

samplingCounterValue :: SamplingCounter m -> ResultTransform m

The counter value.

samplingCounterStats :: SamplingCounter m -> SamplingStats m

The counter statistics.

Time-dependent Counter

newtype TimingCounter m

A time-dependent counter that collects the statistics too.

Constructors

TimingCounter (ResultTransform m)

Instances

ResultTransformer TimingCounter m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: TimingCounter m -> ResultTransform m

timingCounterValue :: TimingCounter m -> ResultTransform m

The counter value.

timingCounterStats :: TimingCounter m -> TimingStats m

The counter statistics.

Queue

newtype Queue m

Represents either finite or infinite queue.

Constructors

Queue (ResultTransform m)

Instances

ResultTransformer Queue m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: Queue m -> ResultTransform m

enqueueStrategy :: Queue m -> ResultTransform m

The strategy applied to the enqueueing (input) processes when the finite queue is full.

enqueueStoringStrategy :: Queue m -> ResultTransform m

The strategy applied when storing (in memory) items in the queue.

dequeueStrategy :: Queue m -> ResultTransform m

The strategy applied to the dequeueing (output) processes when the queue is empty.

queueNull :: Queue m -> ResultTransform m

Test whether the queue is empty.

queueFull :: Queue m -> ResultTransform m

Test whether the finite queue is full.

queueMaxCount :: Queue m -> ResultTransform m

The finite queue capacity.

queueCount :: Queue m -> ResultTransform m

Return the current queue size.

queueCountStats :: Queue m -> TimingStats m

Return the queue size statistics.

enqueueCount :: Queue m -> ResultTransform m

Return the total number of input items that were enqueued in the finite queue.

enqueueLostCount :: Queue m -> ResultTransform m

Return the number of lost items for the finite queue.

enqueueStoreCount :: Queue m -> ResultTransform m

Return the total number of input items that were stored.

dequeueCount :: Queue m -> ResultTransform m

Return the total number of requests for dequeueing the items, not taking into account the failed attempts to dequeue immediately without suspension.

dequeueExtractCount :: Queue m -> ResultTransform m

Return the total number of output items that were actually dequeued.

queueLoadFactor :: Queue m -> ResultTransform m

Return the load factor: the finite queue size divided by its capacity.

enqueueRate :: Queue m -> ResultTransform m

Return the rate of the input items that were enqueued in the finite queue: how many items per time.

enqueueStoreRate :: Queue m -> ResultTransform m

Return the rate of the items that were stored: how many items per time.

dequeueRate :: Queue m -> ResultTransform m

Return the rate of the requests for dequeueing the items: how many requests per time. It does not include the failed attempts to dequeue immediately without suspension.

dequeueExtractRate :: Queue m -> ResultTransform m

Return the rate of the output items that were dequeued: how many items per time.

queueWaitTime :: Queue m -> SamplingStats m

Return the wait time from the time at which the item was stored in the queue to the time at which it was dequeued.

queueTotalWaitTime :: Queue m -> SamplingStats m

Return the total wait time for the finite queue from the time at which the enqueueing operation was initiated to the time at which the item was dequeued.

enqueueWaitTime :: Queue m -> SamplingStats m

Return the wait time from the time at which the item was stored in the queue to the time at which it was dequeued.

dequeueWaitTime :: Queue m -> SamplingStats m

Return the dequeue wait time from the time at which the item was requested for dequeueing to the time at which it was actually dequeued.

queueRate :: Queue m -> ResultTransform m

Return a long-term average queue rate calculated as the average queue size divided by the average wait time.

Arrival Timer

newtype ArrivalTimer m

Accumulates the statistics about that how long the arrived events are processed.

Constructors

ArrivalTimer (ResultTransform m)

Instances

ResultTransformer ArrivalTimer m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: ArrivalTimer m -> ResultTransform m

arrivalProcessingTime :: ArrivalTimer m -> SamplingStats m

Return the statistics about that how long the arrived events were processed.

Server

newtype Server m

It models the server that prodives a service.

Constructors

Server (ResultTransform m)

Instances

ResultTransformer Server m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: Server m -> ResultTransform m

serverInitState :: Server m -> ResultTransform m

The initial state of the server.

serverState :: Server m -> ResultTransform m

Return the current state of the server.

serverTotalInputWaitTime :: Server m -> ResultTransform m

Return the counted total time when the server was locked while awaiting the input.

serverTotalProcessingTime :: Server m -> ResultTransform m

Return the counted total time spent by the server while processing the tasks.

serverTotalOutputWaitTime :: Server m -> ResultTransform m

Return the counted total time when the server was locked while trying to deliver the output.

serverTotalPreemptionTime :: Server m -> ResultTransform m

Return the counted total time spent by the server while it was preempted waiting for the further proceeding.

serverInputWaitTime :: Server m -> SamplingStats m

Return the statistics of the time when the server was locked while awaiting the input.

serverProcessingTime :: Server m -> SamplingStats m

Return the statistics of the time spent by the server while processing the tasks.

serverOutputWaitTime :: Server m -> SamplingStats m

Return the statistics of the time when the server was locked while trying to deliver the output.

serverPreemptionTime :: Server m -> SamplingStats m

Return the statistics of the time spent by the server while it was preempted waiting for the further proceeding.

serverInputWaitFactor :: Server m -> ResultTransform m

It returns the factor changing from 0 to 1, which estimates how often the server was awaiting for the next input task.

serverProcessingFactor :: Server m -> ResultTransform m

It returns the factor changing from 0 to 1, which estimates how often the server was busy with direct processing its tasks.

serverOutputWaitFactor :: Server m -> ResultTransform m

It returns the factor changing from 0 to 1, which estimates how often the server was locked trying to deliver the output after the task is finished.

serverPreemptionFactor :: Server m -> ResultTransform m

It returns the factor changing from 0 to 1, which estimates how often the server was preempted waiting for the further proceeding.

Activity

newtype Activity m

It models an activity that can be utilised.

Constructors

Activity (ResultTransform m)

Instances

ResultTransformer Activity m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: Activity m -> ResultTransform m

activityInitState :: Activity m -> ResultTransform m

The initial state of the activity.

activityState :: Activity m -> ResultTransform m

Return the current state of the activity.

activityTotalUtilisationTime :: Activity m -> ResultTransform m

Return the counted total time when the activity was utilised.

activityTotalIdleTime :: Activity m -> ResultTransform m

Return the counted total time when the activity was idle.

activityTotalPreemptionTime :: Activity m -> ResultTransform m

Return the counted total time when the activity was preemted waiting for the further proceeding.

activityUtilisationTime :: Activity m -> SamplingStats m

Return the statistics for the time when the activity was utilised.

activityIdleTime :: Activity m -> SamplingStats m

Return the statistics for the time when the activity was idle.

activityPreemptionTime :: Activity m -> SamplingStats m

Return the statistics for the time when the activity was preempted waiting for the further proceeding.

activityUtilisationFactor :: Activity m -> ResultTransform m

It returns the factor changing from 0 to 1, which estimates how often the activity was utilised.

activityIdleFactor :: Activity m -> ResultTransform m

It returns the factor changing from 0 to 1, which estimates how often the activity was idle.

activityPreemptionFactor :: Activity m -> ResultTransform m

It returns the factor changing from 0 to 1, which estimates how often the activity was preempted waiting for the further proceeding.

Resource

newtype Resource m

The resource which can be acquired and then released.

Constructors

Resource (ResultTransform m)

Instances

ResultTransformer Resource m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: Resource m -> ResultTransform m

resourceCount :: Resource m -> ResultTransform m

Return the current available count of the resource.

resourceCountStats :: Resource m -> TimingStats m

Return the statistics for the available count of the resource.

resourceUtilisationCount :: Resource m -> ResultTransform m

Return the current utilisation count of the resource.

resourceUtilisationCountStats :: Resource m -> TimingStats m

Return the statistics for the utilisation count of the resource.

resourceQueueCount :: Resource m -> ResultTransform m

Return the current queue length of the resource.

resourceQueueCountStats :: Resource m -> TimingStats m

Return the statistics for the queue length of the resource.

resourceTotalWaitTime :: Resource m -> ResultTransform m

Return the total wait time of the resource.

resourceWaitTime :: Resource m -> SamplingStats m

Return the statistics for the wait time of the resource.

Operation

newtype Operation m

It models an opreation which actvity can be utilised.

Constructors

Operation (ResultTransform m)

Instances

ResultTransformer Operation m

Defined in Simulation.Aivika.Trans.Results.Transform

Methods

tr :: Operation m -> ResultTransform m

operationTotalUtilisationTime :: Operation m -> ResultTransform m

Return the counted total time when the operation activity was utilised.

operationTotalPreemptionTime :: Operation m -> ResultTransform m

Return the counted total time when the operation activity was preemted waiting for the further proceeding.

operationUtilisationTime :: Operation m -> SamplingStats m

Return the statistics for the time when the operation activity was utilised.

operationPreemptionTime :: Operation m -> SamplingStats m

Return the statistics for the time when the operation activity was preempted waiting for the further proceeding.

operationUtilisationFactor :: Operation m -> ResultTransform m

It returns the factor changing from 0 to 1, which estimates how often the operation activity was utilised.

operationPreemptionFactor :: Operation m -> ResultTransform m

It returns the factor changing from 0 to 1, which estimates how often the operation activity was preempted waiting for the further proceeding.