| Copyright | Copyright (c) 2012-2015, David Sorokin <david.sorokin@gmail.com> |
|---|---|
| License | BSD3 |
| Maintainer | David Sorokin <david.sorokin@gmail.com> |
| Stability | experimental |
| Safe Haskell | None |
| Language | Haskell98 |
Simulation.Aivika.Experiment.Types
Description
Tested with: GHC 7.8.3
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.
- data Experiment = Experiment {}
- defaultExperiment :: Experiment
- class ExperimentRendering r where
- data ExperimentContext r :: *
- renderExperiment :: Experiment -> r -> [ExperimentReporter r] -> FilePath -> ExperimentWriter ()
- data ExperimentGenerator r = ExperimentGenerator {
- generateReporter :: Experiment -> r -> FilePath -> ExperimentWriter (ExperimentReporter r)
- class ExperimentRendering r => ExperimentView v r where
- outputView :: v -> ExperimentGenerator r
- data ExperimentData = ExperimentData {}
- data ExperimentReporter r = ExperimentReporter {}
- runExperiment :: ExperimentRendering r => Experiment -> [ExperimentGenerator r] -> r -> Simulation Results -> IO ()
- runExperimentParallel :: ExperimentRendering r => Experiment -> [ExperimentGenerator r] -> r -> Simulation Results -> IO ()
- runExperimentWithExecutor :: ExperimentRendering r => ([IO ()] -> IO ()) -> Experiment -> [ExperimentGenerator r] -> r -> Simulation Results -> IO ()
Documentation
data Experiment Source
It defines the simulation experiment with the specified rendering backend and its bound data.
Constructors
| Experiment | |
Fields
| |
defaultExperiment :: Experiment Source
The default experiment.
class ExperimentRendering r where Source
It allows rendering the simulation results in an arbitrary way.
Associated Types
data ExperimentContext r :: * Source
Defines a context used when rendering the experiment.
Methods
renderExperiment :: Experiment -> r -> [ExperimentReporter r] -> FilePath -> ExperimentWriter () Source
Render the experiment after the simulation is finished, for example,
creating the index.html file in the specified directory.
Instances
| ExperimentRendering (WebPageRenderer a) | Rending a web page with results when running the simulation experiment. |
| ExperimentRendering (FileRenderer a) | Saving the results of simulation in files when running the experiment. |
data ExperimentGenerator r Source
This is a generator of the reporter with the specified rendering backend.
Constructors
| ExperimentGenerator | |
Fields
| |
class ExperimentRendering r => ExperimentView v r where Source
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.
Instances
data ExperimentData Source
It describes the source simulation data used in the experiment.
Constructors
| ExperimentData | |
Fields
| |
data ExperimentReporter r Source
Defines what creates the simulation reports by the specified renderer.
Constructors
| ExperimentReporter | |
Fields
| |
Arguments
| :: ExperimentRendering r | |
| => Experiment | the simulation experiment to run |
| -> [ExperimentGenerator r] | generators used for rendering |
| -> r | the rendering backend |
| -> Simulation Results | the simulation results received from the model |
| -> IO () |
Run the simulation experiment sequentially. For example,
it can be a Monte-Carlo simulation dependentent on the external
Parameter values.
Arguments
| :: ExperimentRendering r | |
| => Experiment | the simulation experiment to run |
| -> [ExperimentGenerator r] | generators used for rendering |
| -> r | the rendering backend |
| -> Simulation Results | the simulation results received from the model |
| -> IO () |
Run the simulation experiment in parallel.
Make sure that you compile with -threaded and supply +RTS -N2 -RTS
to the generated Haskell executable on dual core processor,
or you won't get any parallelism. Generally, the mentioned
N parameter should correspond to the number of cores for
your processor.
In case of need you might want to specify the number of
threads directly with help of experimentNumCapabilities,
although the real number of parallel threads can depend on many
factors.
runExperimentWithExecutor Source
Arguments
| :: ExperimentRendering r | |
| => ([IO ()] -> IO ()) | an executor that allows parallelizing the simulation if required |
| -> Experiment | the simulation experiment to run |
| -> [ExperimentGenerator r] | generators used for rendering |
| -> r | the rendering backend |
| -> Simulation Results | the simulation results received from the model |
| -> IO () |
Run the simulation experiment with the specified executor.