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.Trans.Internal.Simulation

Contents

Simulation
Error Handling
Exceptions
Orphan instances

Description

Tested with: GHC 8.0.1

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

Synopsis

newtype Simulation m a = Simulation (Run m -> m a)
class SimulationLift t m where
- liftSimulation :: Simulation m a -> t m a
invokeSimulation :: Run m -> Simulation m a -> m a
runSimulation :: MonadDES m => Simulation m a -> Specs m -> m a
runSimulations :: MonadDES m => Simulation m a -> Specs m -> Int -> [m a]
runSimulationByIndex :: MonadDES m => Simulation m a -> Specs m -> Int -> Int -> m a
catchSimulation :: (MonadException m, Exception e) => Simulation m a -> (e -> Simulation m a) -> Simulation m a
finallySimulation :: MonadException m => Simulation m a -> Simulation m b -> Simulation m a
throwSimulation :: (MonadException m, Exception e) => e -> Simulation m a
data SimulationException = Exception e => SimulationException e
data SimulationAbort = SimulationAbort String
data SimulationRetry = SimulationRetry String

Simulation

newtype Simulation m a Source #

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

Constructors

Simulation (Run m -> m a)

Instances

Instances details

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

class SimulationLift t m where Source #

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

Methods

liftSimulation :: Simulation m a -> t m a Source #

Lift the specified Simulation computation into another computation.

Instances

Instances details

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

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

Invoke the Simulation computation.

runSimulation :: MonadDES m => Simulation m a -> Specs m -> m a Source #

Run the simulation using the specified specs.

runSimulations :: MonadDES m => Simulation m a -> Specs m -> Int -> [m a] Source #

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

runSimulationByIndex Source #

Arguments

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

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

Error Handling

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

Exception handling within Simulation computations.

finallySimulation :: MonadException m => Simulation m a -> Simulation m b -> Simulation m a Source #

A computation with finalization part like the finally function.

throwSimulation :: (MonadException m, Exception e) => e -> Simulation m a Source #

Like the standard throw function.

Exceptions

data SimulationException #

The root of simulation exceptions.

Constructors

Exception e => SimulationException e

A particular simulation exception.

Instances

Instances details

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

data SimulationAbort #

An exception that signals of aborting the simulation.

Constructors

SimulationAbort String

The exception to abort the simulation.

Instances

Instances details

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

data SimulationRetry #

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

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

Orphan instances

MonadTrans Simulation Source #
Instance details Methods lift :: Monad m => m a -> Simulation m a #
Monad m => MonadCompTrans Simulation m Source #
Instance details Methods liftComp :: m a -> Simulation m a Source #
Monad m => ParameterLift Simulation m Source #
Instance details Methods liftParameter :: Parameter m a -> Simulation m a Source #
Monad m => Monad (Simulation m) Source #
Instance details Methods (>>=) :: Simulation m a -> (a -> Simulation m b) -> Simulation m b # (>>) :: Simulation m a -> Simulation m b -> Simulation m b # return :: a -> Simulation m a #
Functor m => Functor (Simulation m) Source #
Instance details Methods fmap :: (a -> b) -> Simulation m a -> Simulation m b # (<$) :: a -> Simulation m b -> Simulation m a #
MonadFix m => MonadFix (Simulation m) Source #
Instance details Methods mfix :: (a -> Simulation m a) -> Simulation m a #
Monad m => MonadFail (Simulation m) Source #
Instance details Methods fail :: String -> Simulation m a #
Applicative m => Applicative (Simulation m) Source #
Instance details Methods pure :: a -> Simulation m a # (<>) :: Simulation m (a -> b) -> Simulation m a -> Simulation m b # liftA2 :: (a -> b -> c) -> Simulation m a -> Simulation m b -> Simulation m c # (>) :: Simulation m a -> Simulation m b -> Simulation m b # (<*) :: Simulation m a -> Simulation m b -> Simulation m a #
MonadIO m => MonadIO (Simulation m) Source #
Instance details Methods liftIO :: IO a -> Simulation m a #
MonadException m => MonadThrow (Simulation m) Source #
Instance details Methods throwM :: Exception e => e -> Simulation m a #
MonadException m => MonadCatch (Simulation m) Source #
Instance details Methods catch :: Exception e => Simulation m a -> (e -> Simulation m a) -> Simulation m a #
(MonadException m, MonadMask m) => MonadMask (Simulation m) Source #
Instance details Methods mask :: ((forall a. Simulation m a -> Simulation m a) -> Simulation m b) -> Simulation m b # uninterruptibleMask :: ((forall a. Simulation m a -> Simulation m a) -> Simulation m b) -> Simulation m b # generalBracket :: Simulation m a -> (a -> ExitCase b -> Simulation m c) -> (a -> Simulation m b) -> Simulation m (b, c) #