aivika-transformers-4.3.5: Transformers for the Aivika simulation library

CopyrightCopyright (c) 2009-2015, David Sorokin <david.sorokin@gmail.com>
LicenseBSD3
MaintainerDavid Sorokin <david.sorokin@gmail.com>
Stabilityexperimental
Safe HaskellSafe
LanguageHaskell2010

Simulation.Aivika.Trans.Simulation

Contents

Description

Tested with: GHC 7.10.1

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

Synopsis

Simulation

data Simulation m a Source

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

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.

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 :: * where

The root of simulation exceptions.

Constructors

SimulationException :: Exception e => e -> SimulationException

A particular simulation exception.

data SimulationAbort :: *

An exception that signals of aborting the simulation.

Constructors

SimulationAbort String

The exception to abort the simulation.

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.