Simulation.Aivika.Statistics

Tested with: GHC 8.0.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)

Methods

(==) :: SamplingStats a -> SamplingStats a -> Bool

(/=) :: SamplingStats a -> SamplingStats a -> Bool

Ord a => Ord (SamplingStats a)

Methods

compare :: SamplingStats a -> SamplingStats a -> Ordering

(<) :: SamplingStats a -> SamplingStats a -> Bool

(<=) :: SamplingStats a -> SamplingStats a -> Bool

(>) :: SamplingStats a -> SamplingStats a -> Bool

(>=) :: SamplingStats a -> SamplingStats a -> Bool

max :: SamplingStats a -> SamplingStats a -> SamplingStats a

min :: SamplingStats a -> SamplingStats a -> SamplingStats a

Show a => Show (SamplingStats a)

Methods

showsPrec :: Int -> SamplingStats a -> ShowS

show :: SamplingStats a -> String

showList :: [SamplingStats a] -> ShowS

SamplingData a => Monoid (SamplingStats a)

Methods

mempty :: SamplingStats a

mappend :: SamplingStats a -> SamplingStats a -> SamplingStats a

mconcat :: [SamplingStats a] -> SamplingStats a

ResultItemable (ResultValue (SamplingStats Double))

Methods

resultItemName :: ResultValue (SamplingStats Double) -> ResultName

resultItemId :: ResultValue (SamplingStats Double) -> ResultId

resultItemSignal :: ResultValue (SamplingStats Double) -> ResultSignal

resultItemExpansion :: ResultValue (SamplingStats Double) -> ResultSource

resultItemSummary :: ResultValue (SamplingStats Double) -> ResultSource

resultItemAsIntValue :: ResultValue (SamplingStats Double) -> Maybe (ResultValue Int)

resultItemAsIntListValue :: ResultValue (SamplingStats Double) -> Maybe (ResultValue [Int])

resultItemAsIntStatsValue :: ResultValue (SamplingStats Double) -> Maybe (ResultValue (SamplingStats Int))

resultItemAsIntTimingStatsValue :: ResultValue (SamplingStats Double) -> Maybe (ResultValue (TimingStats Int))

resultItemAsDoubleValue :: ResultValue (SamplingStats Double) -> Maybe (ResultValue Double)

resultItemAsDoubleListValue :: ResultValue (SamplingStats Double) -> Maybe (ResultValue [Double])

resultItemAsDoubleStatsValue :: ResultValue (SamplingStats Double) -> Maybe (ResultValue (SamplingStats Double))

resultItemAsDoubleTimingStatsValue :: ResultValue (SamplingStats Double) -> Maybe (ResultValue (TimingStats Double))

resultItemAsStringValue :: ResultValue (SamplingStats Double) -> Maybe (ResultValue String)

ResultItemable (ResultValue (SamplingStats Int))

Methods

resultItemName :: ResultValue (SamplingStats Int) -> ResultName

resultItemId :: ResultValue (SamplingStats Int) -> ResultId

resultItemSignal :: ResultValue (SamplingStats Int) -> ResultSignal

resultItemExpansion :: ResultValue (SamplingStats Int) -> ResultSource

resultItemSummary :: ResultValue (SamplingStats Int) -> ResultSource

resultItemAsIntValue :: ResultValue (SamplingStats Int) -> Maybe (ResultValue Int)

resultItemAsIntListValue :: ResultValue (SamplingStats Int) -> Maybe (ResultValue [Int])

resultItemAsIntStatsValue :: ResultValue (SamplingStats Int) -> Maybe (ResultValue (SamplingStats Int))

resultItemAsIntTimingStatsValue :: ResultValue (SamplingStats Int) -> Maybe (ResultValue (TimingStats Int))

resultItemAsDoubleValue :: ResultValue (SamplingStats Int) -> Maybe (ResultValue Double)

resultItemAsDoubleListValue :: ResultValue (SamplingStats Int) -> Maybe (ResultValue [Double])

resultItemAsDoubleStatsValue :: ResultValue (SamplingStats Int) -> Maybe (ResultValue (SamplingStats Double))

resultItemAsDoubleTimingStatsValue :: ResultValue (SamplingStats Int) -> Maybe (ResultValue (TimingStats Double))

resultItemAsStringValue :: ResultValue (SamplingStats Int) -> Maybe (ResultValue String)

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

Methods

resultSource :: ResultName -> ResultDescription -> m (SamplingStats Int) -> ResultSource

resultSource' :: ResultName -> ResultId -> m (SamplingStats Int) -> ResultSource

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

Methods

resultSource :: ResultName -> ResultDescription -> m (SamplingStats Double) -> ResultSource

resultSource' :: ResultName -> ResultId -> m (SamplingStats Double) -> ResultSource

class Num a => SamplingData a where

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

Minimal complete definition

emptySamplingStats, addSamplingStats, combineSamplingStats

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

Methods

emptySamplingStats :: SamplingStats Double

addSamplingStats :: Double -> SamplingStats Double -> SamplingStats Double

combineSamplingStats :: SamplingStats Double -> SamplingStats Double -> SamplingStats Double

SamplingData Int

Methods

emptySamplingStats :: SamplingStats Int

addSamplingStats :: Int -> SamplingStats Int -> SamplingStats Int

combineSamplingStats :: SamplingStats Int -> SamplingStats Int -> SamplingStats 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)

Methods

(==) :: TimingStats a -> TimingStats a -> Bool

(/=) :: TimingStats a -> TimingStats a -> Bool

Ord a => Ord (TimingStats a)

Methods

compare :: TimingStats a -> TimingStats a -> Ordering

(<) :: TimingStats a -> TimingStats a -> Bool

(<=) :: TimingStats a -> TimingStats a -> Bool

(>) :: TimingStats a -> TimingStats a -> Bool

(>=) :: TimingStats a -> TimingStats a -> Bool

max :: TimingStats a -> TimingStats a -> TimingStats a

min :: TimingStats a -> TimingStats a -> TimingStats a

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

Methods

showsPrec :: Int -> TimingStats a -> ShowS

show :: TimingStats a -> String

showList :: [TimingStats a] -> ShowS

ResultItemable (ResultValue (TimingStats Double))

Methods

resultItemName :: ResultValue (TimingStats Double) -> ResultName

resultItemId :: ResultValue (TimingStats Double) -> ResultId

resultItemSignal :: ResultValue (TimingStats Double) -> ResultSignal

resultItemExpansion :: ResultValue (TimingStats Double) -> ResultSource

resultItemSummary :: ResultValue (TimingStats Double) -> ResultSource

resultItemAsIntValue :: ResultValue (TimingStats Double) -> Maybe (ResultValue Int)

resultItemAsIntListValue :: ResultValue (TimingStats Double) -> Maybe (ResultValue [Int])

resultItemAsIntStatsValue :: ResultValue (TimingStats Double) -> Maybe (ResultValue (SamplingStats Int))

resultItemAsIntTimingStatsValue :: ResultValue (TimingStats Double) -> Maybe (ResultValue (TimingStats Int))

resultItemAsDoubleValue :: ResultValue (TimingStats Double) -> Maybe (ResultValue Double)

resultItemAsDoubleListValue :: ResultValue (TimingStats Double) -> Maybe (ResultValue [Double])

resultItemAsDoubleStatsValue :: ResultValue (TimingStats Double) -> Maybe (ResultValue (SamplingStats Double))

resultItemAsDoubleTimingStatsValue :: ResultValue (TimingStats Double) -> Maybe (ResultValue (TimingStats Double))

resultItemAsStringValue :: ResultValue (TimingStats Double) -> Maybe (ResultValue String)

ResultItemable (ResultValue (TimingStats Int))

Methods

resultItemName :: ResultValue (TimingStats Int) -> ResultName

resultItemId :: ResultValue (TimingStats Int) -> ResultId

resultItemSignal :: ResultValue (TimingStats Int) -> ResultSignal

resultItemExpansion :: ResultValue (TimingStats Int) -> ResultSource

resultItemSummary :: ResultValue (TimingStats Int) -> ResultSource

resultItemAsIntValue :: ResultValue (TimingStats Int) -> Maybe (ResultValue Int)

resultItemAsIntListValue :: ResultValue (TimingStats Int) -> Maybe (ResultValue [Int])

resultItemAsIntStatsValue :: ResultValue (TimingStats Int) -> Maybe (ResultValue (SamplingStats Int))

resultItemAsIntTimingStatsValue :: ResultValue (TimingStats Int) -> Maybe (ResultValue (TimingStats Int))

resultItemAsDoubleValue :: ResultValue (TimingStats Int) -> Maybe (ResultValue Double)

resultItemAsDoubleListValue :: ResultValue (TimingStats Int) -> Maybe (ResultValue [Double])

resultItemAsDoubleStatsValue :: ResultValue (TimingStats Int) -> Maybe (ResultValue (SamplingStats Double))

resultItemAsDoubleTimingStatsValue :: ResultValue (TimingStats Int) -> Maybe (ResultValue (TimingStats Double))

resultItemAsStringValue :: ResultValue (TimingStats Int) -> Maybe (ResultValue String)

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

Methods

resultSource :: ResultName -> ResultDescription -> m (TimingStats Int) -> ResultSource

resultSource' :: ResultName -> ResultId -> m (TimingStats Int) -> ResultSource

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

Methods

resultSource :: ResultName -> ResultDescription -> m (TimingStats Double) -> ResultSource

resultSource' :: ResultName -> ResultId -> m (TimingStats Double) -> ResultSource

class Num a => TimingData a where

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

Minimal complete definition

emptyTimingStats, addTimingStats, timingStatsMean, timingStatsMean2, timingStatsVariance

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

Methods

emptyTimingStats :: TimingStats Double

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

timingStatsMean :: TimingStats Double -> Double

timingStatsMean2 :: TimingStats Double -> Double

timingStatsVariance :: TimingStats Double -> Double

TimingData Int

Methods

emptyTimingStats :: TimingStats Int

addTimingStats :: Double -> Int -> TimingStats Int -> TimingStats Int

timingStatsMean :: TimingStats Int -> Double

timingStatsMean2 :: TimingStats Int -> Double

timingStatsVariance :: TimingStats Int -> Double

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)

Methods

(==) :: SamplingCounter a -> SamplingCounter a -> Bool

(/=) :: SamplingCounter a -> SamplingCounter a -> Bool

Ord a => Ord (SamplingCounter a)

Methods

compare :: SamplingCounter a -> SamplingCounter a -> Ordering

(<) :: SamplingCounter a -> SamplingCounter a -> Bool

(<=) :: SamplingCounter a -> SamplingCounter a -> Bool

(>) :: SamplingCounter a -> SamplingCounter a -> Bool

(>=) :: SamplingCounter a -> SamplingCounter a -> Bool

max :: SamplingCounter a -> SamplingCounter a -> SamplingCounter a

min :: SamplingCounter a -> SamplingCounter a -> SamplingCounter a

Show a => Show (SamplingCounter a)

Methods

showsPrec :: Int -> SamplingCounter a -> ShowS

show :: SamplingCounter a -> String

showList :: [SamplingCounter a] -> ShowS

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

Methods

resultSource :: ResultName -> ResultDescription -> m (SamplingCounter Int) -> ResultSource

resultSource' :: ResultName -> ResultId -> m (SamplingCounter Int) -> ResultSource

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

Methods

resultSource :: ResultName -> ResultDescription -> m (SamplingCounter Double) -> ResultSource

resultSource' :: ResultName -> ResultId -> m (SamplingCounter Double) -> ResultSource

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)

Methods

(==) :: TimingCounter a -> TimingCounter a -> Bool

(/=) :: TimingCounter a -> TimingCounter a -> Bool

Ord a => Ord (TimingCounter a)

Methods

compare :: TimingCounter a -> TimingCounter a -> Ordering

(<) :: TimingCounter a -> TimingCounter a -> Bool

(<=) :: TimingCounter a -> TimingCounter a -> Bool

(>) :: TimingCounter a -> TimingCounter a -> Bool

(>=) :: TimingCounter a -> TimingCounter a -> Bool

max :: TimingCounter a -> TimingCounter a -> TimingCounter a

min :: TimingCounter a -> TimingCounter a -> TimingCounter a

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

Methods

showsPrec :: Int -> TimingCounter a -> ShowS

show :: TimingCounter a -> String

showList :: [TimingCounter a] -> ShowS

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

Methods

resultSource :: ResultName -> ResultDescription -> m (TimingCounter Int) -> ResultSource

resultSource' :: ResultName -> ResultId -> m (TimingCounter Int) -> ResultSource

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

Methods

resultSource :: ResultName -> ResultDescription -> m (TimingCounter Double) -> ResultSource

resultSource' :: ResultName -> ResultId -> m (TimingCounter Double) -> ResultSource

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.