Simulation.Aivika.Trans.Experiment.Types

Tested with: GHC 8.0.1

The module defines the simulation experiments. They automate the process of generating and analyzing the results. Moreover, this module is open to extensions, allowing you to define your own output views for the simulation results, for example, such views that would allow saving the results in PDF or as charts. To decrease the number of dependencies, such possible extenstions are not included in this package, although simple views are provided.

Documentation

data Experiment m

It defines the simulation experiment with the specified rendering backend and its bound data.

Constructors

Experiment

Fields

• experimentSpecs :: Specs m

  The simulation specs for the experiment.

• experimentTransform :: ResultTransform m

  How the results must be transformed before rendering.

• experimentLocalisation :: ResultLocalisation

  Specifies a localisation applied when rendering the experiment.

• experimentRunCount :: Int

  How many simulation runs should be launched.

• experimentTitle :: String

  The experiment title.

• experimentDescription :: String

  The experiment description.

• experimentVerbose :: Bool

  Whether the process of generating the results is verbose.

• experimentNumCapabilities :: IO Int

  The number of threads used for the Monte-Carlo simulation if the executable was compiled with the support of multi-threading.

defaultExperiment :: Experiment m

The default experiment.

class ExperimentMonadProviding r m

Allows specifying the experiment monad.

Associated Types

type ExperimentMonad r m :: * -> *

Defines the experiment monad type.

type ExperimentMonadTry r m a = ExperimentMonad r m (Either SomeException a)

Defines the experiment computation that tries to perform the calculation.

class ExperimentMonadProviding r m => ExperimentRendering r m where

It allows rendering the simulation results in an arbitrary way.

Minimal complete definition

prepareExperiment, renderExperiment, onExperimentCompleted, onExperimentFailed

Associated Types

data ExperimentContext r m :: *

Defines a context used when rendering the experiment.

type ExperimentEnvironment r m :: *

Defines the experiment environment.

Methods

prepareExperiment :: Experiment m -> r -> ExperimentMonad r m (ExperimentEnvironment r m)

Prepare before rendering the experiment.

renderExperiment :: Experiment m -> r -> [ExperimentReporter r m] -> ExperimentEnvironment r m -> ExperimentMonad r m ()

Render the experiment after the simulation is finished, for example, creating the index.html file in the specified directory.

onExperimentCompleted :: Experiment m -> r -> ExperimentEnvironment r m -> ExperimentMonad r m ()

It is called when the experiment has been completed.

onExperimentFailed :: Exception e => Experiment m -> r -> ExperimentEnvironment r m -> e -> ExperimentMonad r m ()

It is called when the experiment rendering has failed.

data ExperimentGenerator r m

This is a generator of the reporter with the specified rendering backend.

Constructors

ExperimentGenerator

Fields

• generateReporter :: Experiment m -> r -> ExperimentEnvironment r m -> ExperimentMonad r m (ExperimentReporter r m)

  Generate a reporter.

class ExperimentRendering r m => ExperimentView v r m where

Defines a view in which the simulation results should be saved. You should extend this type class to define your own views such as the PDF document.

Minimal complete definition

outputView

Methods

outputView :: v m -> ExperimentGenerator r m

Create a generator of the reporter.

data ExperimentData m

It describes the source simulation data used in the experiment.

Constructors

ExperimentData

Fields

• experimentResults :: Results m

  The simulation results used in the experiment.

• experimentPredefinedSignals :: ResultPredefinedSignals m

  The predefined signals provided by every model.

data ExperimentReporter r m

Defines what creates the simulation reports by the specified renderer.

Constructors

ExperimentReporter

Fields

• reporterInitialise :: ExperimentMonad r m ()

  Initialise the reporting before the simulation runs are started.

• reporterFinalise :: ExperimentMonad r m ()

  Finalise the reporting after all simulation runs are finished.

• reporterSimulate :: ExperimentData m -> Composite m ()

  Start the simulation run in the start time.

• reporterContext :: ExperimentContext r m

  Return a context used by the renderer.

runExperiment_

Arguments

:: (MonadDES m, ExperimentRendering r m, Monad (ExperimentMonad r m), MonadException (ExperimentMonad r m))

=> (m () -> ExperimentMonad r m a)

the function that actually starts the simulation run

-> Experiment m

the simulation experiment to run

-> [ExperimentGenerator r m]

generators used for rendering

-> r

the rendering backend

-> Simulation m (Results m)

the simulation results received from the model

-> ExperimentMonadTry r m ()

Run the simulation experiment sequentially.

runExperiment

Arguments

:: (MonadDES m, ExperimentRendering r m, Monad (ExperimentMonad r m), MonadException (ExperimentMonad r m))

=> (m () -> ExperimentMonad r m a)

the function that actually starts the simulation run

-> Experiment m

the simulation experiment to run

-> [ExperimentGenerator r m]

generators used for rendering

-> r

the rendering backend

-> Simulation m (Results m)

the simulation results received from the model

-> ExperimentMonadTry r m [a]

Run the simulation experiment sequentially.

runExperimentWithExecutor

Arguments

:: (MonadDES m, ExperimentRendering r m, Monad (ExperimentMonad r m), MonadException (ExperimentMonad r m))

=> ([m ()] -> ExperimentMonad r m a)

an executor that allows parallelizing the simulation if required

-> Experiment m

the simulation experiment to run

-> [ExperimentGenerator r m]

generators used for rendering

-> r

the rendering backend

-> Simulation m (Results m)

the simulation results received from the model

-> ExperimentMonadTry r m a

Run the simulation experiment with the specified executor.

runExperimentByIndex

Arguments

:: (MonadDES m, ExperimentRendering r m, Monad (ExperimentMonad r m), MonadException (ExperimentMonad r m))

=> (m () -> ExperimentMonad r m a)

the function that actually starts the simulation run

-> Experiment m

the simulation experiment to run

-> [ExperimentGenerator r m]

generators used for rendering

-> r

the rendering backend

-> Simulation m (Results m)

the simulation results received from the model

-> Int

the index of the current run (started from 1)

-> ExperimentMonadTry r m a

Run the simulation experiment by the specified run index in series.

runExperimentByIndex_

Arguments

:: (MonadDES m, ExperimentRendering r m, Monad (ExperimentMonad r m), MonadException (ExperimentMonad r m))

=> (m () -> ExperimentMonad r m a)

the function that actually starts the simulation run

-> Experiment m

the simulation experiment to run

-> [ExperimentGenerator r m]

generators used for rendering

-> r

the rendering backend

-> Simulation m (Results m)

the simulation results received from the model

-> Int

the index of the current run (started from 1)

-> ExperimentMonadTry r m ()

Run the simulation experiment by the specified run index in series.

runExperimentContByIndex

Arguments

:: (MonadDES m, ExperimentRendering r m, Monad (ExperimentMonad r m), MonadException (ExperimentMonad r m))

=> (m () -> ExperimentMonad r m (a, ExperimentMonad r m b))

the function that actually starts the simulation run and returns the corresponding continuation

-> Experiment m

the simulation experiment to run

-> [ExperimentGenerator r m]

generators used for rendering

-> r

the rendering backend

-> Simulation m (Results m)

the simulation results received from the model

-> Int

the index of the current run (started from 1)

-> ExperimentMonadTry r m (a, ExperimentMonadTry r m b)

Run the simulation experiment by the specified run index in series returning the continuation of the actual computation.

runExperimentContByIndex_

Arguments

:: (MonadDES m, ExperimentRendering r m, Monad (ExperimentMonad r m), MonadException (ExperimentMonad r m))

=> (m () -> ExperimentMonad r m (a, ExperimentMonad r m b))

the function that actually starts the simulation run and returns the corresponding continuation

-> Experiment m

the simulation experiment to run

-> [ExperimentGenerator r m]

generators used for rendering

-> r

the rendering backend

-> Simulation m (Results m)

the simulation results received from the model

-> Int

the index of the current run (started from 1)

-> ExperimentMonadTry r m (a, ExperimentMonadTry r m ())

Run the simulation experiment by the specified run index in series returning the continuation of the actual computation.