Simulation.Aivika.Internal.Simulation

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.

Simulation

newtype Simulation a

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

Constructors

Simulation (Run -> IO a)

Instances

Monad Simulation

Methods

(>>=) :: Simulation a -> (a -> Simulation b) -> Simulation b

(>>) :: Simulation a -> Simulation b -> Simulation b

return :: a -> Simulation a

fail :: String -> Simulation a

Functor Simulation

Methods

fmap :: (a -> b) -> Simulation a -> Simulation b

(<$) :: a -> Simulation b -> Simulation a

MonadFix Simulation

Methods

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

Applicative Simulation

Methods

pure :: a -> Simulation a

(<*>) :: Simulation (a -> b) -> Simulation a -> Simulation b

(*>) :: Simulation a -> Simulation b -> Simulation b

(<*) :: Simulation a -> Simulation b -> Simulation a

MonadIO Simulation

Methods

liftIO :: IO a -> Simulation a

ParameterLift Simulation

Methods

liftParameter :: Parameter a -> Simulation a

SimulationLift Simulation

Methods

liftSimulation :: Simulation a -> Simulation a

ResultComputing Simulation

Methods

computeResultData :: Simulation a -> ResultData a

computeResultSignal :: Simulation a -> ResultSignal

ResultItemable (ResultValue a) => ResultProvider (Simulation a)

Methods

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

resultSource' :: ResultName -> ResultId -> Simulation a -> ResultSource

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

Methods

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

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

ResultItemable (ResultValue [e]) => ResultProvider (Simulation (Vector e))

Methods

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

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

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

Methods

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

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

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

Methods

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

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

class SimulationLift m where

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

Minimal complete definition

liftSimulation

Methods

liftSimulation :: Simulation a -> m a

Lift the specified Simulation computation to another computation.

Instances

SimulationLift Simulation

Methods

liftSimulation :: Simulation a -> Simulation a

SimulationLift Dynamics

Methods

liftSimulation :: Simulation a -> Dynamics a

SimulationLift Event

Methods

liftSimulation :: Simulation a -> Event a

SimulationLift Composite

Methods

liftSimulation :: Simulation a -> Composite a

SimulationLift Cont

Methods

liftSimulation :: Simulation a -> Cont a

SimulationLift Process

Methods

liftSimulation :: Simulation a -> Process a

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

Invoke the Simulation computation.

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

Run the simulation using the specified specs.

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

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

runSimulationByIndex

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

Exception handling within Simulation computations.

finallySimulation :: Simulation a -> Simulation b -> Simulation a

A computation with finalization part like the finally function.

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

Like the standard throw function.

Utilities

simulationEventQueue :: Simulation EventQueue

Return the event queue.

Memoization

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

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

Exceptions

data SimulationException

The root of simulation exceptions.

Constructors

Exception e => SimulationException e

A particular simulation exception.

Instances

Show SimulationException

Methods

showsPrec :: Int -> SimulationException -> ShowS

show :: SimulationException -> String

showList :: [SimulationException] -> ShowS

Exception SimulationException

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

Methods

showsPrec :: Int -> SimulationAbort -> ShowS

show :: SimulationAbort -> String

showList :: [SimulationAbort] -> ShowS

Exception SimulationAbort

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

Methods

showsPrec :: Int -> SimulationRetry -> ShowS

show :: SimulationRetry -> String

showList :: [SimulationRetry] -> ShowS

Exception SimulationRetry

Methods

toException :: SimulationRetry -> SomeException

fromException :: SomeException -> Maybe SimulationRetry

displayException :: SimulationRetry -> String