aivika-1.2: A multi-paradigm simulation library

CopyrightCopyright (c) 2009-2013, David Sorokin <david.sorokin@gmail.com>
LicenseBSD3
MaintainerDavid Sorokin <david.sorokin@gmail.com>
Stabilityexperimental
Safe HaskellSafe-Inferred
LanguageHaskell98

Simulation.Aivika.Statistics

Contents

Description

Tested with: GHC 7.6.3

Represents statistics.

Synopsis

Simple Statistics

data SamplingStats a Source

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

class SamplingData a where Source

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

Methods

emptySamplingStats :: SamplingStats a Source

An empty statistics that has no samples.

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

Add a new sample to the statistics.

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

Combine two statistics.

Instances

samplingStatsVariance :: SamplingStats a -> Double Source

Return the variance.

samplingStatsDeviation :: SamplingStats a -> Double Source

Return the deviation.

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

Show the summary of the statistics using the specified indent.

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

Return the statistics by a single sample.

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

Create the statistics by the specified list of data.

fromIntSamplingStats :: SamplingStats Int -> SamplingStats Double Source

Convert the statistics from integer to double values.

Timing Statistics

data TimingStats a Source

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) 
Ord a => Ord (TimingStats a) 
(Show a, TimingData a) => Show (TimingStats a) 

class TimingData a where Source

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

Methods

emptyTimingStats :: TimingStats a Source

An empty statistics that has no samples.

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

Add a sample with the specified time to the statistics.

timingStatsMean :: TimingStats a -> Double Source

Return the average value.

timingStatsVariance :: TimingStats a -> Double Source

Return the variance.

Instances

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

Return the deviation.

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

Show the summary of the statistics using the specified indent.

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

Return the statistics by single timing data.

fromIntTimingStats :: TimingStats Int -> TimingStats Double Source

Convert the statistics from integer to double values.