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)

Defined in Simulation.Aivika.Statistics

Methods

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

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

Ord a => Ord (SamplingStats a)

Defined in Simulation.Aivika.Statistics

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)

Defined in Simulation.Aivika.Statistics

Methods

showsPrec :: Int -> SamplingStats a -> ShowS

show :: SamplingStats a -> String

showList :: [SamplingStats a] -> ShowS

Generic (SamplingStats a)

Defined in Simulation.Aivika.Statistics

Associated Types

type Rep (SamplingStats a) :: Type -> Type

Methods

from :: SamplingStats a -> Rep (SamplingStats a) x

to :: Rep (SamplingStats a) x -> SamplingStats a

SamplingData a => Semigroup (SamplingStats a)

Defined in Simulation.Aivika.Statistics

Methods

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

sconcat :: NonEmpty (SamplingStats a) -> SamplingStats a

stimes :: Integral b => b -> SamplingStats a -> SamplingStats a

SamplingData a => Monoid (SamplingStats a)

Defined in Simulation.Aivika.Statistics

Methods

mempty :: SamplingStats a

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

mconcat :: [SamplingStats a] -> SamplingStats a

Binary a => Binary (SamplingStats a)

Defined in Simulation.Aivika.Statistics

Methods

put :: SamplingStats a -> Put

get :: Get (SamplingStats a)

putList :: [SamplingStats a] -> Put

NFData a => NFData (SamplingStats a)

Defined in Simulation.Aivika.Statistics

Methods

rnf :: SamplingStats a -> ()

ResultItemable (ResultValue (SamplingStats Double))

Defined in Simulation.Aivika.Results

Methods

resultItemName :: ResultValue (SamplingStats Double) -> ResultName

resultItemNamePath :: ResultValue (SamplingStats Double) -> [ResultName]

resultItemId :: ResultValue (SamplingStats Double) -> ResultId

resultItemIdPath :: 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))

Defined in Simulation.Aivika.Results

Methods

resultItemName :: ResultValue (SamplingStats Int) -> ResultName

resultItemNamePath :: ResultValue (SamplingStats Int) -> [ResultName]

resultItemId :: ResultValue (SamplingStats Int) -> ResultId

resultItemIdPath :: 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)

type Rep (SamplingStats a)

Defined in Simulation.Aivika.Statistics

type Rep (SamplingStats a) = D1 ('MetaData "SamplingStats" "Simulation.Aivika.Statistics" "aivika-5.9.1-4eJa0lWx7j0BhE7rfobwkS" 'False) (C1 ('MetaCons "SamplingStats" 'PrefixI 'True) ((S1 ('MetaSel ('Just "samplingStatsCount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "samplingStatsMin") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)) :*: (S1 ('MetaSel ('Just "samplingStatsMax") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: (S1 ('MetaSel ('Just "samplingStatsMean") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "samplingStatsMean2") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 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

Defined in Simulation.Aivika.Statistics

Methods

emptySamplingStats :: SamplingStats Double

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

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

SamplingData Int

Defined in Simulation.Aivika.Statistics

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)

Defined in Simulation.Aivika.Statistics

Methods

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

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

Ord a => Ord (TimingStats a)

Defined in Simulation.Aivika.Statistics

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)

Defined in Simulation.Aivika.Statistics

Methods

showsPrec :: Int -> TimingStats a -> ShowS

show :: TimingStats a -> String

showList :: [TimingStats a] -> ShowS

Generic (TimingStats a)

Defined in Simulation.Aivika.Statistics

Associated Types

type Rep (TimingStats a) :: Type -> Type

Methods

from :: TimingStats a -> Rep (TimingStats a) x

to :: Rep (TimingStats a) x -> TimingStats a

Binary a => Binary (TimingStats a)

Defined in Simulation.Aivika.Statistics

Methods

put :: TimingStats a -> Put

get :: Get (TimingStats a)

putList :: [TimingStats a] -> Put

NFData a => NFData (TimingStats a)

Defined in Simulation.Aivika.Statistics

Methods

rnf :: TimingStats a -> ()

ResultItemable (ResultValue (TimingStats Double))

Defined in Simulation.Aivika.Results

Methods

resultItemName :: ResultValue (TimingStats Double) -> ResultName

resultItemNamePath :: ResultValue (TimingStats Double) -> [ResultName]

resultItemId :: ResultValue (TimingStats Double) -> ResultId

resultItemIdPath :: 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))

Defined in Simulation.Aivika.Results

Methods

resultItemName :: ResultValue (TimingStats Int) -> ResultName

resultItemNamePath :: ResultValue (TimingStats Int) -> [ResultName]

resultItemId :: ResultValue (TimingStats Int) -> ResultId

resultItemIdPath :: 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)

type Rep (TimingStats a)

Defined in Simulation.Aivika.Statistics

type Rep (TimingStats a) = D1 ('MetaData "TimingStats" "Simulation.Aivika.Statistics" "aivika-5.9.1-4eJa0lWx7j0BhE7rfobwkS" 'False) (C1 ('MetaCons "TimingStats" 'PrefixI 'True) (((S1 ('MetaSel ('Just "timingStatsCount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "timingStatsMin") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)) :*: (S1 ('MetaSel ('Just "timingStatsMax") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: (S1 ('MetaSel ('Just "timingStatsLast") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "timingStatsMinTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Double)))) :*: ((S1 ('MetaSel ('Just "timingStatsMaxTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "timingStatsStartTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "timingStatsLastTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "timingStatsSum") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "timingStatsSum2") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 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

Defined in Simulation.Aivika.Statistics

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

Defined in Simulation.Aivika.Statistics

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)

Defined in Simulation.Aivika.Statistics

Methods

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

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

Ord a => Ord (SamplingCounter a)

Defined in Simulation.Aivika.Statistics

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)

Defined in Simulation.Aivika.Statistics

Methods

showsPrec :: Int -> SamplingCounter a -> ShowS

show :: SamplingCounter a -> String

showList :: [SamplingCounter a] -> ShowS

Generic (SamplingCounter a)

Defined in Simulation.Aivika.Statistics

Associated Types

type Rep (SamplingCounter a) :: Type -> Type

Methods

from :: SamplingCounter a -> Rep (SamplingCounter a) x

to :: Rep (SamplingCounter a) x -> SamplingCounter a

Binary a => Binary (SamplingCounter a)

Defined in Simulation.Aivika.Statistics

Methods

put :: SamplingCounter a -> Put

get :: Get (SamplingCounter a)

putList :: [SamplingCounter a] -> Put

NFData a => NFData (SamplingCounter a)

Defined in Simulation.Aivika.Statistics

Methods

rnf :: SamplingCounter a -> ()

(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Parameter (SamplingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Parameter (SamplingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Parameter (SamplingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Parameter (SamplingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Simulation (SamplingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Simulation (SamplingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Simulation (SamplingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Simulation (SamplingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Dynamics (SamplingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Dynamics (SamplingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Dynamics (SamplingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Dynamics (SamplingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Event (SamplingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Event (SamplingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Event (SamplingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Event (SamplingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Ref (SamplingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Ref (SamplingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref (SamplingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref (SamplingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Signalable (SamplingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Signalable (SamplingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Signalable (SamplingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Signalable (SamplingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Ref (SamplingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Ref (SamplingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref (SamplingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref (SamplingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Var (SamplingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Var (SamplingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Var (SamplingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Var (SamplingCounter a) -> ResultSource

type Rep (SamplingCounter a)

Defined in Simulation.Aivika.Statistics

type Rep (SamplingCounter a) = D1 ('MetaData "SamplingCounter" "Simulation.Aivika.Statistics" "aivika-5.9.1-4eJa0lWx7j0BhE7rfobwkS" 'False) (C1 ('MetaCons "SamplingCounter" 'PrefixI 'True) (S1 ('MetaSel ('Just "samplingCounterValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "samplingCounterStats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SamplingStats a))))

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)

Defined in Simulation.Aivika.Statistics

Methods

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

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

Ord a => Ord (TimingCounter a)

Defined in Simulation.Aivika.Statistics

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

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

Defined in Simulation.Aivika.Statistics

Methods

showsPrec :: Int -> TimingCounter a -> ShowS

show :: TimingCounter a -> String

showList :: [TimingCounter a] -> ShowS

Generic (TimingCounter a)

Defined in Simulation.Aivika.Statistics

Associated Types

type Rep (TimingCounter a) :: Type -> Type

Methods

from :: TimingCounter a -> Rep (TimingCounter a) x

to :: Rep (TimingCounter a) x -> TimingCounter a

Binary a => Binary (TimingCounter a)

Defined in Simulation.Aivika.Statistics

Methods

put :: TimingCounter a -> Put

get :: Get (TimingCounter a)

putList :: [TimingCounter a] -> Put

NFData a => NFData (TimingCounter a)

Defined in Simulation.Aivika.Statistics

Methods

rnf :: TimingCounter a -> ()

(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Parameter (TimingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Parameter (TimingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Parameter (TimingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Parameter (TimingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Simulation (TimingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Simulation (TimingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Simulation (TimingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Simulation (TimingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Dynamics (TimingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Dynamics (TimingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Dynamics (TimingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Dynamics (TimingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Event (TimingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Event (TimingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Event (TimingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Event (TimingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Ref (TimingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Ref (TimingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref (TimingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref (TimingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Signalable (TimingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Signalable (TimingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Signalable (TimingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Signalable (TimingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Ref (TimingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Ref (TimingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref (TimingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref (TimingCounter a) -> ResultSource

(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Var (TimingCounter a))

Defined in Simulation.Aivika.Results

Methods

resultSource :: ResultName -> ResultDescription -> Var (TimingCounter a) -> ResultSource

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Var (TimingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Var (TimingCounter a) -> ResultSource

type Rep (TimingCounter a)

Defined in Simulation.Aivika.Statistics

type Rep (TimingCounter a) = D1 ('MetaData "TimingCounter" "Simulation.Aivika.Statistics" "aivika-5.9.1-4eJa0lWx7j0BhE7rfobwkS" 'False) (C1 ('MetaCons "TimingCounter" 'PrefixI 'True) (S1 ('MetaSel ('Just "timingCounterValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "timingCounterStats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TimingStats a))))

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.