Simulation.Aivika.Trans.Simulation

Tested with: GHC 8.0.1

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

Simulation

data Simulation m a

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

Instances

MonadTrans Simulation

Defined in Simulation.Aivika.Trans.Internal.Simulation

Methods

lift :: Monad m => m a -> Simulation m a

Monad m => MonadCompTrans Simulation m

Defined in Simulation.Aivika.Trans.Internal.Simulation

Methods

liftComp :: m a -> Simulation m a

Monad m => ParameterLift Simulation m

Defined in Simulation.Aivika.Trans.Internal.Simulation

Methods

liftParameter :: Parameter m a -> Simulation m a

Monad m => SimulationLift Simulation m

Defined in Simulation.Aivika.Trans.Internal.Simulation

Methods

liftSimulation :: Simulation m a -> Simulation m a

MonadDES m => ResultComputing Simulation m

Defined in Simulation.Aivika.Trans.Results

Methods

computeResultData :: Simulation m a -> ResultData a m

computeResultSignal :: Simulation m a -> ResultSignal m

Monad m => Monad (Simulation m)

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

fail :: String -> Simulation m a

Functor m => Functor (Simulation m)

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)

Defined in Simulation.Aivika.Trans.Internal.Simulation

Methods

mfix :: (a -> Simulation m a) -> Simulation m a

Monad m => MonadFail (Simulation m)

Defined in Simulation.Aivika.Trans.Internal.Simulation

Methods

fail :: String -> Simulation m a

Applicative m => Applicative (Simulation m)

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)

Defined in Simulation.Aivika.Trans.Internal.Simulation

Methods

liftIO :: IO a -> Simulation m a

MonadException m => MonadThrow (Simulation m)

Defined in Simulation.Aivika.Trans.Internal.Simulation

Methods

throwM :: Exception e => e -> Simulation m a

MonadException m => MonadCatch (Simulation m)

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)

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

Defined in Simulation.Aivika.Trans.Results

Methods

resultSource :: ResultName -> ResultDescription -> Simulation m (Vector e) -> ResultSource m

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Simulation m (Vector e) -> ResultSource m

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Simulation m (Vector e) -> ResultSource m

(Ix i, Show i, MonadDES m, ResultItemable (ResultValue [e])) => ResultProvider (Simulation m (Array i e)) m

Defined in Simulation.Aivika.Trans.Results

Methods

resultSource :: ResultName -> ResultDescription -> Simulation m (Array i e) -> ResultSource m

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Simulation m (Array i e) -> ResultSource m

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Simulation m (Array i e) -> ResultSource m

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

Defined in Simulation.Aivika.Trans.Results

Methods

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

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

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

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

Defined in Simulation.Aivika.Trans.Results

Methods

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

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

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

(MonadDES m, ResultItemable (ResultValue a)) => ResultProvider (Simulation m a) m

Defined in Simulation.Aivika.Trans.Results

Methods

resultSource :: ResultName -> ResultDescription -> Simulation m a -> ResultSource m

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Simulation m a -> ResultSource m

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Simulation m a -> ResultSource m

class SimulationLift t m where

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

Methods

liftSimulation :: Simulation m a -> t m a

Lift the specified Simulation computation into another computation.

Instances

Monad m => SimulationLift Event m

Defined in Simulation.Aivika.Trans.Internal.Event

Methods

liftSimulation :: Simulation m a -> Event m a

Monad m => SimulationLift Dynamics m

Defined in Simulation.Aivika.Trans.Internal.Dynamics

Methods

liftSimulation :: Simulation m a -> Dynamics m a

Monad m => SimulationLift Simulation m

Defined in Simulation.Aivika.Trans.Internal.Simulation

Methods

liftSimulation :: Simulation m a -> Simulation m a

Monad m => SimulationLift Composite m

Defined in Simulation.Aivika.Trans.Composite

Methods

liftSimulation :: Simulation m a -> Composite m a

MonadDES m => SimulationLift Cont m

Defined in Simulation.Aivika.Trans.Internal.Cont

Methods

liftSimulation :: Simulation m a -> Cont m a

MonadDES m => SimulationLift Process m

Defined in Simulation.Aivika.Trans.Internal.Process

Methods

liftSimulation :: Simulation m a -> Process m a

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

Run the simulation using the specified specs.

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

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

runSimulationByIndex

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

Exception handling within Simulation computations.

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

A computation with finalization part like the finally function.

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

Like the standard throw function.

Exceptions

data SimulationException where

The root of simulation exceptions.

Constructors

SimulationException :: forall e. Exception e => e -> SimulationException

A particular simulation exception.

Instances

Show SimulationException

Defined in Simulation.Aivika.Internal.Simulation

Methods

showsPrec :: Int -> SimulationException -> ShowS

show :: SimulationException -> String

showList :: [SimulationException] -> ShowS

Exception SimulationException

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

Show SimulationAbort

Defined in Simulation.Aivika.Internal.Simulation

Methods

showsPrec :: Int -> SimulationAbort -> ShowS

show :: SimulationAbort -> String

showList :: [SimulationAbort] -> ShowS

Exception SimulationAbort

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

Show SimulationRetry

Defined in Simulation.Aivika.Internal.Simulation

Methods

showsPrec :: Int -> SimulationRetry -> ShowS

show :: SimulationRetry -> String

showList :: [SimulationRetry] -> ShowS

Exception SimulationRetry

Defined in Simulation.Aivika.Internal.Simulation

Methods

toException :: SimulationRetry -> SomeException

fromException :: SomeException -> Maybe SimulationRetry

displayException :: SimulationRetry -> String