Simulation.Aivika.Statistics

Tested with: GHC 7.10.1

Represents statistics.

Simple Statistics

data SamplingStats a

Describes when the statistics consists of only samples not bound to the simulation time.

Constructors

SamplingStats

Fields

samplingStatsCount :: !Int

The total number of samples.

samplingStatsMin :: !a

The minimum value among the samples.

samplingStatsMax :: !a

The maximum value among the samples.

samplingStatsMean :: !Double

The average value.

samplingStatsMean2 :: !Double

The average square value.

Instances

Eq a => Eq (SamplingStats a)

Ord a => Ord (SamplingStats a)

Show a => Show (SamplingStats a)

SamplingData a => Monoid (SamplingStats a)

ResultItemable (ResultValue (SamplingStats Double))

ResultItemable (ResultValue (SamplingStats Int))

ResultComputing m => ResultProvider (m (SamplingStats Int))

ResultComputing m => ResultProvider (m (SamplingStats Double))

class Num a => SamplingData a where

Specifies data type from which values we can gather the statistics.

Methods

emptySamplingStats :: SamplingStats a

An empty statistics that has no samples.

addSamplingStats :: a -> SamplingStats a -> SamplingStats a

Add a new sample to the statistics.

combineSamplingStats :: SamplingStats a -> SamplingStats a -> SamplingStats a

Combine two statistics.

Instances

SamplingData Double

SamplingData Int

combineSamplingStatsEither :: SamplingData a => Either a (SamplingStats a) -> SamplingStats a -> SamplingStats a

If allows combining statistics more efficiently if we know that the first argument can be a scalar.

samplingStatsVariance :: SamplingStats a -> Double

Return the variance.

samplingStatsDeviation :: SamplingStats a -> Double

Return the deviation.

samplingStatsSummary :: Show a => SamplingStats a -> Int -> ShowS

Show the summary of the statistics using the specified indent.

returnSamplingStats :: SamplingData a => a -> SamplingStats a

Return the statistics by a single sample.

listSamplingStats :: SamplingData a => [a] -> SamplingStats a

Create the statistics by the specified list of data.

fromIntSamplingStats :: SamplingStats Int -> SamplingStats Double

Convert the statistics from integer to double values.

Timing Statistics

data TimingStats a

This is the timing statistics where data are bound to the time.

Constructors

TimingStats

Fields

timingStatsCount :: !Int

Return the number of samples.

timingStatsMin :: !a

Return the minimum value.

timingStatsMax :: !a

Return the maximum value.

timingStatsLast :: !a

Return the last value.

timingStatsMinTime :: !Double

Return the time at which the minimum is attained.

timingStatsMaxTime :: !Double

Return the time at which the maximum is attained.

timingStatsStartTime :: !Double

Return the start time of sampling.

timingStatsLastTime :: !Double

Return the last time of sampling.

timingStatsSum :: !Double

Return the sum of values.

timingStatsSum2 :: !Double

Return the sum of square values.

Instances

Eq a => Eq (TimingStats a)

Ord a => Ord (TimingStats a)

(Show a, TimingData a) => Show (TimingStats a)

ResultItemable (ResultValue (TimingStats Double))

ResultItemable (ResultValue (TimingStats Int))

ResultComputing m => ResultProvider (m (TimingStats Int))

ResultComputing m => ResultProvider (m (TimingStats Double))

class Num a => TimingData a where

Defines the data type from which values we can gather the timing statistics.

Methods

emptyTimingStats :: TimingStats a

An empty statistics that has no samples.

addTimingStats :: Double -> a -> TimingStats a -> TimingStats a

Add a sample with the specified time to the statistics.

timingStatsMean :: TimingStats a -> Double

Return the average value.

timingStatsMean2 :: TimingStats a -> Double

Return the average square value.

timingStatsVariance :: TimingStats a -> Double

Return the variance.

Instances

TimingData Double

TimingData Int

timingStatsDeviation :: TimingData a => TimingStats a -> Double

Return the deviation.

timingStatsSummary :: (Show a, TimingData a) => TimingStats a -> Int -> ShowS

Show the summary of the statistics using the specified indent.

returnTimingStats :: TimingData a => Double -> a -> TimingStats a

Return the statistics by single timing data.

fromIntTimingStats :: TimingStats Int -> TimingStats Double

Convert the statistics from integer to double values.

normTimingStats :: TimingData a => Int -> TimingStats a -> SamplingStats a

Convert the statistics to its normalised sampling-based representation, where the first argument specifies the number of pseudo-samples.

Simple Counter

data SamplingCounter a

A counter for which the statistics is collected too.

Constructors

SamplingCounter

Fields

samplingCounterValue :: a

The counter value.

samplingCounterStats :: SamplingStats a

The counter statistics.

Instances

Eq a => Eq (SamplingCounter a)

Ord a => Ord (SamplingCounter a)

Show a => Show (SamplingCounter a)

ResultComputing m => ResultProvider (m (SamplingCounter Int))

ResultComputing m => ResultProvider (m (SamplingCounter Double))

emptySamplingCounter :: SamplingData a => SamplingCounter a

An empty counter.

incSamplingCounter :: SamplingData a => a -> SamplingCounter a -> SamplingCounter a

Increase the counter.

decSamplingCounter :: SamplingData a => a -> SamplingCounter a -> SamplingCounter a

Decrease the counter.

setSamplingCounter :: SamplingData a => a -> SamplingCounter a -> SamplingCounter a

Set a new value for the counter.

returnSamplingCounter :: SamplingData a => a -> SamplingCounter a

Create a counter with the specified initial value.

Timing Counter

data TimingCounter a

A counter for which the timing statistics is collected too.

Constructors

TimingCounter

Fields

timingCounterValue :: a

The counter value.

timingCounterStats :: TimingStats a

The counter statistics.

Instances

Eq a => Eq (TimingCounter a)

Ord a => Ord (TimingCounter a)

(Show a, TimingData a) => Show (TimingCounter a)

ResultComputing m => ResultProvider (m (TimingCounter Int))

ResultComputing m => ResultProvider (m (TimingCounter Double))

emptyTimingCounter :: TimingData a => TimingCounter a

An empty counter.

incTimingCounter :: TimingData a => Double -> a -> TimingCounter a -> TimingCounter a

Increase the counter at the specified time.

decTimingCounter :: TimingData a => Double -> a -> TimingCounter a -> TimingCounter a

Decrease the counter at the specified time.

setTimingCounter :: TimingData a => Double -> a -> TimingCounter a -> TimingCounter a

Set a new value for the counter at the specified time.

returnTimingCounter :: TimingData a => Double -> a -> TimingCounter a

Create a timing counter with the specified initial value at the given time.