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

Simulation.Aivika.Internal.Simulation

Contents

Simulation
Error Handling
Utilities
Memoization
Exceptions

Description

Tested with: GHC 8.0.1

This is an internal implementation module that should never be used directly.

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

Synopsis

newtype Simulation a = Simulation (Run -> IO a)
class SimulationLift m where
- liftSimulation :: Simulation a -> m a
invokeSimulation :: Run -> Simulation a -> IO a
runSimulation :: Simulation a -> Specs -> IO a
runSimulations :: Simulation a -> Specs -> Int -> [IO a]
runSimulationByIndex :: Simulation a -> Specs -> Int -> Int -> IO a
catchSimulation :: Exception e => Simulation a -> (e -> Simulation a) -> Simulation a
finallySimulation :: Simulation a -> Simulation b -> Simulation a
throwSimulation :: Exception e => e -> Simulation a
simulationEventQueue :: Simulation EventQueue
memoSimulation :: Simulation a -> Simulation (Simulation a)
data SimulationException = forall e.Exception e => SimulationException e
data SimulationAbort = SimulationAbort String
data SimulationRetry = SimulationRetry String

Simulation

newtype Simulation a Source #

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

Constructors

Simulation (Run -> IO a)

Instances

Instances details

ParameterLift Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods liftParameter :: Parameter a -> Simulation a Source #
SimulationLift Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods liftSimulation :: Simulation a -> Simulation a Source #
ResultComputing Simulation Source #
Instance details Defined in Simulation.Aivika.Results Methods computeResultData :: Simulation a -> ResultData a Source # computeResultSignal :: Simulation a -> ResultSignal Source #
MonadFail Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods fail :: String -> Simulation a #
MonadFix Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods mfix :: (a -> Simulation a) -> Simulation a #
MonadIO Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods liftIO :: IO a -> Simulation a #
Applicative Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation 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 #
Functor Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods fmap :: (a -> b) -> Simulation a -> Simulation b # (<$) :: a -> Simulation b -> Simulation a #
Monad Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods (>>=) :: Simulation a -> (a -> Simulation b) -> Simulation b # (>>) :: Simulation a -> Simulation b -> Simulation b # return :: a -> Simulation a #
MonadCatch Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods catch :: Exception e => Simulation a -> (e -> Simulation a) -> Simulation a #
MonadMask Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation 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) #
MonadThrow Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods throwM :: Exception e => e -> Simulation a #
(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Simulation (SamplingCounter a)) Source #
Instance details Defined in Simulation.Aivika.Results 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 #
(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Simulation (TimingCounter a)) Source #
Instance details Defined in Simulation.Aivika.Results 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 #
(Ix i, Show i, ResultItemable (ResultValue [e])) => ResultProvider (Simulation (Array i e)) Source #
Instance details Defined in Simulation.Aivika.Results 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 #
Instance details Defined in Simulation.Aivika.Results 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) => ResultProvider (Simulation a) Source #
Instance details Defined in Simulation.Aivika.Results 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 #

class SimulationLift m where Source #

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

Methods

liftSimulation :: Simulation a -> m a Source #

Lift the specified Simulation computation to another computation.

Instances

Instances details

SimulationLift Composite Source #
Instance details Defined in Simulation.Aivika.Composite Methods liftSimulation :: Simulation a -> Composite a Source #
SimulationLift Cont Source #
Instance details Defined in Simulation.Aivika.Internal.Cont Methods liftSimulation :: Simulation a -> Cont a Source #
SimulationLift Dynamics Source #
Instance details Defined in Simulation.Aivika.Internal.Dynamics Methods liftSimulation :: Simulation a -> Dynamics a Source #
SimulationLift Event Source #
Instance details Defined in Simulation.Aivika.Internal.Event Methods liftSimulation :: Simulation a -> Event a Source #
SimulationLift Process Source #
Instance details Defined in Simulation.Aivika.Internal.Process Methods liftSimulation :: Simulation a -> Process a Source #
SimulationLift Simulation Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods liftSimulation :: Simulation a -> Simulation a Source #

invokeSimulation :: Run -> Simulation a -> IO a Source #

Invoke the Simulation computation.

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.

Utilities

simulationEventQueue :: Simulation EventQueue Source #

Return the event queue.

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

forall e.Exception e => SimulationException e

A particular simulation exception.

Instances

Instances details

Exception SimulationException Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods toException :: SimulationException -> SomeException # fromException :: SomeException -> Maybe SimulationException # displayException :: SimulationException -> String #
Show SimulationException Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods showsPrec :: Int -> SimulationException -> ShowS # show :: SimulationException -> String # showList :: [SimulationException] -> ShowS #

data SimulationAbort Source #

An exception that signals of aborting the simulation.

Constructors

SimulationAbort String

The exception to abort the simulation.

Instances

Instances details

Exception SimulationAbort Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods toException :: SimulationAbort -> SomeException # fromException :: SomeException -> Maybe SimulationAbort # displayException :: SimulationAbort -> String #
Show SimulationAbort Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods showsPrec :: Int -> SimulationAbort -> ShowS # show :: SimulationAbort -> String # showList :: [SimulationAbort] -> ShowS #

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

Instances details

Exception SimulationRetry Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods toException :: SimulationRetry -> SomeException # fromException :: SomeException -> Maybe SimulationRetry # displayException :: SimulationRetry -> String #
Show SimulationRetry Source #
Instance details Defined in Simulation.Aivika.Internal.Simulation Methods showsPrec :: Int -> SimulationRetry -> ShowS # show :: SimulationRetry -> String # showList :: [SimulationRetry] -> ShowS #