Copyright	Copyright (c) 2009-2017 David Sorokin <david.sorokin@gmail.com>
License	BSD3
Maintainer	David Sorokin <david.sorokin@gmail.com>
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Simulation.Aivika.Simulation

Contents

Simulation
Error Handling
Memoization
Exceptions

Description

Tested with: GHC 8.0.1

The module defines the Simulation monad that represents a computation within the simulation run.

Synopsis

Simulation

data Simulation a Source #

A value in the Simulation monad represents a computation within the simulation run.

Instances

Monad Simulation Source #
Methods (>>=) :: Simulation a -> (a -> Simulation b) -> Simulation b # (>>) :: Simulation a -> Simulation b -> Simulation b # return :: a -> Simulation a # fail :: String -> Simulation a #
Functor Simulation Source #
Methods fmap :: (a -> b) -> Simulation a -> Simulation b # (<$) :: a -> Simulation b -> Simulation a #
MonadFix Simulation Source #
Methods mfix :: (a -> Simulation a) -> Simulation a #
Applicative Simulation Source #
Methods pure :: a -> Simulation a # (<>) :: Simulation (a -> b) -> Simulation a -> Simulation b # liftA2 :: (a -> b -> c) -> Simulation a -> Simulation b -> Simulation c # (>) :: Simulation a -> Simulation b -> Simulation b # (<*) :: Simulation a -> Simulation b -> Simulation a #
MonadIO Simulation Source #
Methods liftIO :: IO a -> Simulation a #
MonadThrow Simulation Source #
Methods throwM :: Exception e => e -> Simulation a #
MonadCatch Simulation Source #
Methods catch :: Exception e => Simulation a -> (e -> Simulation a) -> Simulation a #
MonadMask Simulation Source #
Methods mask :: ((forall a. Simulation a -> Simulation a) -> Simulation b) -> Simulation b # uninterruptibleMask :: ((forall a. Simulation a -> Simulation a) -> Simulation b) -> Simulation b # generalBracket :: Simulation a -> (a -> ExitCase b -> Simulation c) -> (a -> Simulation b) -> Simulation (b, c) #
ParameterLift Simulation Source #
Methods liftParameter :: Parameter a -> Simulation a Source #
SimulationLift Simulation Source #
Methods liftSimulation :: Simulation a -> Simulation a Source #
ResultComputing Simulation Source #
Methods computeResultData :: Simulation a -> ResultData a Source # computeResultSignal :: Simulation a -> ResultSignal Source #
ResultItemable (ResultValue a) => ResultProvider (Simulation a) Source #
Methods resultSource :: ResultName -> ResultDescription -> Simulation a -> ResultSource Source # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Simulation a -> ResultSource Source # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Simulation a -> ResultSource Source #
(Ix i, Show i, ResultItemable (ResultValue [e])) => ResultProvider (Simulation (Array i e)) Source #
Methods resultSource :: ResultName -> ResultDescription -> Simulation (Array i e) -> ResultSource Source # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Simulation (Array i e) -> ResultSource Source # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Simulation (Array i e) -> ResultSource Source #
ResultItemable (ResultValue [e]) => ResultProvider (Simulation (Vector e)) Source #
Methods resultSource :: ResultName -> ResultDescription -> Simulation (Vector e) -> ResultSource Source # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Simulation (Vector e) -> ResultSource Source # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Simulation (Vector e) -> ResultSource Source #
(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Simulation (TimingCounter a)) Source #
Methods resultSource :: ResultName -> ResultDescription -> Simulation (TimingCounter a) -> ResultSource Source # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Simulation (TimingCounter a) -> ResultSource Source # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Simulation (TimingCounter a) -> ResultSource Source #
(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Simulation (SamplingCounter a)) Source #
Methods resultSource :: ResultName -> ResultDescription -> Simulation (SamplingCounter a) -> ResultSource Source # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Simulation (SamplingCounter a) -> ResultSource Source # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Simulation (SamplingCounter a) -> ResultSource Source #

class SimulationLift m where Source #

A type class to lift the simulation computations to other computations.

Minimal complete definition

liftSimulation

Methods

liftSimulation :: Simulation a -> m a Source #

Lift the specified Simulation computation to another computation.

Instances

SimulationLift Simulation Source #
Methods liftSimulation :: Simulation a -> Simulation a Source #
SimulationLift Dynamics Source #
Methods liftSimulation :: Simulation a -> Dynamics a Source #
SimulationLift Event Source #
Methods liftSimulation :: Simulation a -> Event a Source #
SimulationLift Composite Source #
Methods liftSimulation :: Simulation a -> Composite a Source #
SimulationLift Cont Source #
Methods liftSimulation :: Simulation a -> Cont a Source #
SimulationLift Process Source #
Methods liftSimulation :: Simulation a -> Process a Source #

runSimulation :: Simulation a -> Specs -> IO a Source #

Run the simulation using the specified specs.

runSimulations :: Simulation a -> Specs -> Int -> [IO a] Source #

Run the given number of simulations using the specified specs, where each simulation is distinguished by its index simulationIndex.

runSimulationByIndex Source #

Arguments

:: Simulation a	the simulation model
-> Specs	the simulation specs
-> Int	the number of runs in series
-> Int	the index of the current run (started from 1)
-> IO a

Run the simulation by the specified specs and run index in series.

Error Handling

catchSimulation :: Exception e => Simulation a -> (e -> Simulation a) -> Simulation a Source #

Exception handling within Simulation computations.

finallySimulation :: Simulation a -> Simulation b -> Simulation a Source #

A computation with finalization part like the finally function.

throwSimulation :: Exception e => e -> Simulation a Source #

Like the standard throw function.

Memoization

memoSimulation :: Simulation a -> Simulation (Simulation a) Source #

Memoize the Simulation computation, always returning the same value within a simulation run.

Exceptions

data SimulationException Source #

The root of simulation exceptions.

Constructors

Exception e => SimulationException e

A particular simulation exception.

Instances

Show SimulationException Source #
Methods showsPrec :: Int -> SimulationException -> ShowS # show :: SimulationException -> String # showList :: [SimulationException] -> ShowS #
Exception SimulationException Source #
Methods toException :: SimulationException -> SomeException # fromException :: SomeException -> Maybe SimulationException # displayException :: SimulationException -> String #

data SimulationAbort Source #

An exception that signals of aborting the simulation.

Constructors

SimulationAbort String

The exception to abort the simulation.

Instances

Show SimulationAbort Source #
Methods showsPrec :: Int -> SimulationAbort -> ShowS # show :: SimulationAbort -> String # showList :: [SimulationAbort] -> ShowS #
Exception SimulationAbort Source #
Methods toException :: SimulationAbort -> SomeException # fromException :: SomeException -> Maybe SimulationAbort # displayException :: SimulationAbort -> String #

data SimulationRetry Source #

An exception that signals that the current computation should be retried as possible, which feature may be supported by the simulation engine or not.

Constructors

SimulationRetry String

The exception to retry the computation.

Instances

Show SimulationRetry Source #
Methods showsPrec :: Int -> SimulationRetry -> ShowS # show :: SimulationRetry -> String # showList :: [SimulationRetry] -> ShowS #
Exception SimulationRetry Source #
Methods toException :: SimulationRetry -> SomeException # fromException :: SomeException -> Maybe SimulationRetry # displayException :: SimulationRetry -> String #