Simulation.Aivika.Parameter

Tested with: GHC 7.6.3

The module defines the Parameter monad that allows representing the model parameters. For example, they can be used when running the Monte-Carlo simulation.

Parameter

data Parameter a

The Parameter monad that allows specifying the model parameters. For example, they can be used when running the Monte-Carlo simulation.

Instances

Monad Parameter

Functor Parameter

MonadFix Parameter

MonadIO Parameter

ParameterLift Parameter

Eq (Parameter a)

Floating a => Floating (Parameter a)

Fractional a => Fractional (Parameter a)

Num a => Num (Parameter a)

Show (Parameter a)

class ParameterLift m where

A type class to lift the parameters to other computations.

Methods

liftParameter :: Parameter a -> m a

Lift the specified Parameter computation to another computation.

Instances

ParameterLift Parameter

ParameterLift Simulation

ParameterLift Dynamics

ParameterLift Event

ParameterLift Cont

ParameterLift Process

runParameter :: Parameter a -> Specs -> IO a

Run the parameter using the specified specs.

runParameters :: Parameter a -> Specs -> Int -> [IO a]

Run the given number of parameters using the specified specs, where each parameter is distinguished by its index parameterIndex.

Error Handling

catchParameter :: Parameter a -> (IOException -> Parameter a) -> Parameter a

Exception handling within Parameter computations.

finallyParameter :: Parameter a -> Parameter b -> Parameter a

A computation with finalization part like the finally function.

throwParameter :: IOException -> Parameter a

Like the standard throw function.

Predefined Parameters

simulationIndex :: Parameter Int

Return the run index for the current simulation.

simulationCount :: Parameter Int

Return the number of simulations currently run.

simulationSpecs :: Parameter Specs

Return the simulation specs.

generatorParameter :: Parameter Generator

Return the random number generator for the simulation run.

starttime :: Parameter Double

Computation that returns the start simulation time.

stoptime :: Parameter Double

Computation that returns the final simulation time.

dt :: Parameter Double

Computation that returns the integration time step.

Memoization

memoParameter :: Parameter a -> IO (Parameter a)

Memoize the Parameter computation, always returning the same value within a simulation run. However, the value will be recalculated for other simulation runs. Also it is thread-safe when different simulation runs are executed in parallel on physically different operating system threads.

Utilities

tableParameter :: Array Int a -> Parameter a

Return a parameter which value is taken consequently from the specified table based on the run index of the current simulation starting from zero. After all values from the table are used, it takes again the first value of the table, then the second one and so on.