Simulation.Aivika.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 a where

Something that can transform the results.

Minimal complete definition

tr

Methods

tr :: a -> ResultTransform

Return the result transform.

Instances

ResultTransformer Operation

Methods

tr :: Operation -> ResultTransform

ResultTransformer Resource

Methods

tr :: Resource -> ResultTransform

ResultTransformer Activity

Methods

tr :: Activity -> ResultTransform

ResultTransformer Server

Methods

tr :: Server -> ResultTransform

ResultTransformer ArrivalTimer

Methods

tr :: ArrivalTimer -> ResultTransform

ResultTransformer Queue

Methods

tr :: Queue -> ResultTransform

ResultTransformer TimingCounter

Methods

tr :: TimingCounter -> ResultTransform

ResultTransformer TimingStats

Methods

tr :: TimingStats -> ResultTransform

ResultTransformer SamplingCounter

Methods

tr :: SamplingCounter -> ResultTransform

ResultTransformer SamplingStats

Methods

tr :: SamplingStats -> ResultTransform

Sampling Statistics

newtype SamplingStats

Represents a statistics based upon observations.

Constructors

SamplingStats ResultTransform

Instances

ResultTransformer SamplingStats

Methods

tr :: SamplingStats -> ResultTransform

samplingStatsCount :: SamplingStats -> ResultTransform

The total number of samples.

samplingStatsMin :: SamplingStats -> ResultTransform

The minimum value among the samples.

samplingStatsMax :: SamplingStats -> ResultTransform

The maximum value among the samples.

samplingStatsMean :: SamplingStats -> ResultTransform

The average value.

samplingStatsMean2 :: SamplingStats -> ResultTransform

The average square value.

samplingStatsVariance :: SamplingStats -> ResultTransform

Return tha variance.

samplingStatsDeviation :: SamplingStats -> ResultTransform

Return the deviation.

Time-dependent Statistics

newtype TimingStats

The time-dependent statistics.

Constructors

TimingStats ResultTransform

Instances

ResultTransformer TimingStats

Methods

tr :: TimingStats -> ResultTransform

timingStatsCount :: TimingStats -> ResultTransform

Return the number of samples.

timingStatsMin :: TimingStats -> ResultTransform

Return the minimum value.

timingStatsMax :: TimingStats -> ResultTransform

Return the maximum value.

timingStatsMean :: TimingStats -> ResultTransform

Return the average value.

timingStatsVariance :: TimingStats -> ResultTransform

Return the variance.

timingStatsDeviation :: TimingStats -> ResultTransform

Return the deviation.

timingStatsMinTime :: TimingStats -> ResultTransform

Return the time at which the minimum is attained.

timingStatsMaxTime :: TimingStats -> ResultTransform

Return the time at which the maximum is attained.

timingStatsStartTime :: TimingStats -> ResultTransform

Return the start time of sampling.

timingStatsLastTime :: TimingStats -> ResultTransform

Return the last time of sampling.

timingStatsSum :: TimingStats -> ResultTransform

Return the sum of values.

timingStatsSum2 :: TimingStats -> ResultTransform

Return the sum of square values.

Sampling-based Counter

newtype SamplingCounter

A counter for which the statistics is collected too.

Constructors

SamplingCounter ResultTransform

Instances

ResultTransformer SamplingCounter

Methods

tr :: SamplingCounter -> ResultTransform

samplingCounterValue :: SamplingCounter -> ResultTransform

The counter value.

samplingCounterStats :: SamplingCounter -> SamplingStats

The counter statistics.

Time-dependent Counter

newtype TimingCounter

A time-dependent counter that collects the statistics too.

Constructors

TimingCounter ResultTransform

Instances

ResultTransformer TimingCounter

Methods

tr :: TimingCounter -> ResultTransform

timingCounterValue :: TimingCounter -> ResultTransform

The counter value.

timingCounterStats :: TimingCounter -> TimingStats

The counter statistics.

Queue

newtype Queue

Represents either finite or infinite queue.

Constructors

Queue ResultTransform

Instances

ResultTransformer Queue

Methods

tr :: Queue -> ResultTransform

enqueueStrategy :: Queue -> ResultTransform

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

enqueueStoringStrategy :: Queue -> ResultTransform

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

dequeueStrategy :: Queue -> ResultTransform

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

queueNull :: Queue -> ResultTransform

Test whether the queue is empty.

queueFull :: Queue -> ResultTransform

Test whether the finite queue is full.

queueMaxCount :: Queue -> ResultTransform

The finite queue capacity.

queueCount :: Queue -> ResultTransform

Return the current queue size.

queueCountStats :: Queue -> TimingStats

Return the queue size statistics.

enqueueCount :: Queue -> ResultTransform

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

enqueueLostCount :: Queue -> ResultTransform

Return the number of lost items for the finite queue.

enqueueStoreCount :: Queue -> ResultTransform

Return the total number of input items that were stored.

dequeueCount :: Queue -> ResultTransform

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

dequeueExtractCount :: Queue -> ResultTransform

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

queueLoadFactor :: Queue -> ResultTransform

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

enqueueRate :: Queue -> ResultTransform

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

enqueueStoreRate :: Queue -> ResultTransform

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

dequeueRate :: Queue -> ResultTransform

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 -> ResultTransform

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

queueWaitTime :: Queue -> SamplingStats

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 -> SamplingStats

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 -> SamplingStats

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 -> SamplingStats

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 -> ResultTransform

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

Arrival Timer

newtype ArrivalTimer

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

Constructors

ArrivalTimer ResultTransform

Instances

ResultTransformer ArrivalTimer

Methods

tr :: ArrivalTimer -> ResultTransform

arrivalProcessingTime :: ArrivalTimer -> SamplingStats

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

Server

newtype Server

It models the server that prodives a service.

Constructors

Server ResultTransform

Instances

ResultTransformer Server

Methods

tr :: Server -> ResultTransform

serverInitState :: Server -> ResultTransform

The initial state of the server.

serverState :: Server -> ResultTransform

Return the current state of the server.

serverTotalInputWaitTime :: Server -> ResultTransform

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

serverTotalProcessingTime :: Server -> ResultTransform

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

serverTotalOutputWaitTime :: Server -> ResultTransform

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

serverTotalPreemptionTime :: Server -> ResultTransform

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

serverInputWaitTime :: Server -> SamplingStats

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

serverProcessingTime :: Server -> SamplingStats

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

serverOutputWaitTime :: Server -> SamplingStats

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

serverPreemptionTime :: Server -> SamplingStats

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

serverInputWaitFactor :: Server -> ResultTransform

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

serverProcessingFactor :: Server -> ResultTransform

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

serverOutputWaitFactor :: Server -> ResultTransform

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 -> ResultTransform

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

It models an activity that can be utilised.

Constructors

Activity ResultTransform

Instances

ResultTransformer Activity

Methods

tr :: Activity -> ResultTransform

activityInitState :: Activity -> ResultTransform

The initial state of the activity.

activityState :: Activity -> ResultTransform

Return the current state of the activity.

activityTotalUtilisationTime :: Activity -> ResultTransform

Return the counted total time when the activity was utilised.

activityTotalIdleTime :: Activity -> ResultTransform

Return the counted total time when the activity was idle.

activityTotalPreemptionTime :: Activity -> ResultTransform

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

activityUtilisationTime :: Activity -> SamplingStats

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

activityIdleTime :: Activity -> SamplingStats

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

activityPreemptionTime :: Activity -> SamplingStats

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

activityUtilisationFactor :: Activity -> ResultTransform

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

activityIdleFactor :: Activity -> ResultTransform

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

activityPreemptionFactor :: Activity -> ResultTransform

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

The resource which can be acquired and then released.

Constructors

Resource ResultTransform

Instances

ResultTransformer Resource

Methods

tr :: Resource -> ResultTransform

resourceCount :: Resource -> ResultTransform

Return the current available count of the resource.

resourceCountStats :: Resource -> TimingStats

Return the statistics for the available count of the resource.

resourceUtilisationCount :: Resource -> ResultTransform

Return the current utilisation count of the resource.

resourceUtilisationCountStats :: Resource -> TimingStats

Return the statistics for the utilisation count of the resource.

resourceQueueCount :: Resource -> ResultTransform

Return the current queue length of the resource.

resourceQueueCountStats :: Resource -> TimingStats

Return the statistics for the queue length of the resource.

resourceTotalWaitTime :: Resource -> ResultTransform

Return the total wait time of the resource.

resourceWaitTime :: Resource -> SamplingStats

Return the statistics for the wait time of the resource.

Operation

newtype Operation

It models an opreation which actvity can be utilised.

Constructors

Operation ResultTransform

Instances

ResultTransformer Operation

Methods

tr :: Operation -> ResultTransform

operationTotalUtilisationTime :: Operation -> ResultTransform

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

operationTotalPreemptionTime :: Operation -> ResultTransform

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

operationUtilisationTime :: Operation -> SamplingStats

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

operationPreemptionTime :: Operation -> SamplingStats

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

operationUtilisationFactor :: Operation -> ResultTransform

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

operationPreemptionFactor :: Operation -> ResultTransform

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