Copyright	Copyright (c) 2009-2017 David Sorokin <david.sorokin@gmail.com>
License	BSD3
Maintainer	David Sorokin <david.sorokin@gmail.com>
Stability	experimental
Safe Haskell	Safe
Language	Haskell2010

Simulation.Aivika.Internal.Parameter

Contents

Parameter
Error Handling
Predefined Parameters
Memoization
Utilities

Description

Tested with: GHC 8.0.1

This is an internal implementation module that should never be used directly.

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

In general, this monad is very useful for representing a computation which is external relative to the model itself.

Synopsis

Parameter

newtype Parameter a Source #

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

In general, this monad is very useful for representing a computation which is external relative to the model itself.

Constructors

Parameter (Run -> IO a)

Instances

Monad Parameter Source #
Methods (>>=) :: Parameter a -> (a -> Parameter b) -> Parameter b # (>>) :: Parameter a -> Parameter b -> Parameter b # return :: a -> Parameter a # fail :: String -> Parameter a #
Functor Parameter Source #
Methods fmap :: (a -> b) -> Parameter a -> Parameter b # (<$) :: a -> Parameter b -> Parameter a #
MonadFix Parameter Source #
Methods mfix :: (a -> Parameter a) -> Parameter a #
Applicative Parameter Source #
Methods pure :: a -> Parameter a # (<>) :: Parameter (a -> b) -> Parameter a -> Parameter b # (>) :: Parameter a -> Parameter b -> Parameter b # (<*) :: Parameter a -> Parameter b -> Parameter a #
MonadIO Parameter Source #
Methods liftIO :: IO a -> Parameter a #
ParameterLift Parameter Source #
Methods liftParameter :: Parameter a -> Parameter a Source #
ResultComputing Parameter Source #
Methods computeResultData :: Parameter a -> ResultData a Source # computeResultSignal :: Parameter a -> ResultSignal Source #
Eq (Parameter a) Source #
Methods (==) :: Parameter a -> Parameter a -> Bool # (/=) :: Parameter a -> Parameter a -> Bool #
Floating a => Floating (Parameter a) Source #
Methods pi :: Parameter a # exp :: Parameter a -> Parameter a # log :: Parameter a -> Parameter a # sqrt :: Parameter a -> Parameter a # (**) :: Parameter a -> Parameter a -> Parameter a # logBase :: Parameter a -> Parameter a -> Parameter a # sin :: Parameter a -> Parameter a # cos :: Parameter a -> Parameter a # tan :: Parameter a -> Parameter a # asin :: Parameter a -> Parameter a # acos :: Parameter a -> Parameter a # atan :: Parameter a -> Parameter a # sinh :: Parameter a -> Parameter a # cosh :: Parameter a -> Parameter a # tanh :: Parameter a -> Parameter a # asinh :: Parameter a -> Parameter a # acosh :: Parameter a -> Parameter a # atanh :: Parameter a -> Parameter a # log1p :: Parameter a -> Parameter a # expm1 :: Parameter a -> Parameter a # log1pexp :: Parameter a -> Parameter a # log1mexp :: Parameter a -> Parameter a #
Fractional a => Fractional (Parameter a) Source #
Methods (/) :: Parameter a -> Parameter a -> Parameter a # recip :: Parameter a -> Parameter a # fromRational :: Rational -> Parameter a #
Num a => Num (Parameter a) Source #
Methods (+) :: Parameter a -> Parameter a -> Parameter a # (-) :: Parameter a -> Parameter a -> Parameter a # (*) :: Parameter a -> Parameter a -> Parameter a # negate :: Parameter a -> Parameter a # abs :: Parameter a -> Parameter a # signum :: Parameter a -> Parameter a # fromInteger :: Integer -> Parameter a #
Show (Parameter a) Source #
Methods showsPrec :: Int -> Parameter a -> ShowS # show :: Parameter a -> String # showList :: [Parameter a] -> ShowS #
ResultItemable (ResultValue a) => ResultProvider (Parameter a) Source #
Methods resultSource :: ResultName -> ResultDescription -> Parameter a -> ResultSource Source # resultSource' :: ResultName -> ResultId -> Parameter a -> ResultSource Source #
(Ix i, Show i, ResultItemable (ResultValue [e])) => ResultProvider (Parameter (Array i e)) Source #
Methods resultSource :: ResultName -> ResultDescription -> Parameter (Array i e) -> ResultSource Source # resultSource' :: ResultName -> ResultId -> Parameter (Array i e) -> ResultSource Source #
ResultItemable (ResultValue [e]) => ResultProvider (Parameter (Vector e)) Source #
Methods resultSource :: ResultName -> ResultDescription -> Parameter (Vector e) -> ResultSource Source # resultSource' :: ResultName -> ResultId -> Parameter (Vector e) -> ResultSource Source #
(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Parameter (TimingCounter a)) Source #
Methods resultSource :: ResultName -> ResultDescription -> Parameter (TimingCounter a) -> ResultSource Source # resultSource' :: ResultName -> ResultId -> Parameter (TimingCounter a) -> ResultSource Source #
(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Parameter (SamplingCounter a)) Source #
Methods resultSource :: ResultName -> ResultDescription -> Parameter (SamplingCounter a) -> ResultSource Source # resultSource' :: ResultName -> ResultId -> Parameter (SamplingCounter a) -> ResultSource Source #

class ParameterLift m where Source #

A type class to lift the parameters to other computations.

Minimal complete definition

liftParameter

Methods

liftParameter :: Parameter a -> m a Source #

Lift the specified Parameter computation to another computation.

Instances

ParameterLift Parameter Source #
Methods liftParameter :: Parameter a -> Parameter a Source #
ParameterLift Simulation Source #
Methods liftParameter :: Parameter a -> Simulation a Source #
ParameterLift Dynamics Source #
Methods liftParameter :: Parameter a -> Dynamics a Source #
ParameterLift Event Source #
Methods liftParameter :: Parameter a -> Event a Source #
ParameterLift Composite Source #
Methods liftParameter :: Parameter a -> Composite a Source #
ParameterLift Cont Source #
Methods liftParameter :: Parameter a -> Cont a Source #
ParameterLift Process Source #
Methods liftParameter :: Parameter a -> Process a Source #

invokeParameter :: Run -> Parameter a -> IO a Source #

Invoke the Parameter computation.

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

Run the parameter using the specified specs.

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

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

Error Handling

catchParameter :: Exception e => Parameter a -> (e -> Parameter a) -> Parameter a Source #

Exception handling within Parameter computations.

finallyParameter :: Parameter a -> Parameter b -> Parameter a Source #

A computation with finalization part like the finally function.

throwParameter :: Exception e => e -> Parameter a Source #

Like the standard throw function.

Predefined Parameters

simulationIndex :: Parameter Int Source #

Return the run index for the current simulation.

simulationCount :: Parameter Int Source #

Return the number of simulations currently run.

simulationSpecs :: Parameter Specs Source #

Return the simulation specs.

starttime :: Parameter Double Source #

Computation that returns the start simulation time.

stoptime :: Parameter Double Source #

Computation that returns the final simulation time.

dt :: Parameter Double Source #

Computation that returns the integration time step.

generatorParameter :: Parameter Generator Source #

Return the random number generator for the simulation run.

Memoization

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

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 Source #

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.