Simulation.Aivika.Statistics

Tested with: GHC 7.0.3

Represents statistics.

Documentation

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)

(Eq (SamplingStats a), Ord a) => Ord (SamplingStats a)

Show a => Show (SamplingStats a)

class 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.

Instances

SamplingData Double

SamplingData Int

samplingStatsVariance :: SamplingStats a -> Double

Return the variance.

samplingStatsDeviation :: SamplingStats a -> Double

Return the deviation.

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

Show the summary of the statistics with the specified indent.

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.

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)

(Eq (TimingStats a), Ord a) => Ord (TimingStats a)

Show a => Show (TimingStats a)

class 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.

timingStatsVariance :: TimingStats a -> Double

Return the variance.

Instances

TimingData Double

TimingData Int

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

Return the deviation.

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

Show the summary of the statistics with the specified indent.