Simulation.Aivika.Internal.Parameter

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.

Parameter

newtype Parameter a

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

ParameterLift Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

liftParameter :: Parameter a -> Parameter a

ResultComputing Parameter

Defined in Simulation.Aivika.Results

Methods

computeResultData :: Parameter a -> ResultData a

computeResultSignal :: Parameter a -> ResultSignal

MonadFail Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

fail :: String -> Parameter a

MonadFix Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

mfix :: (a -> Parameter a) -> Parameter a

MonadIO Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

liftIO :: IO a -> Parameter a

Applicative Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

pure :: a -> Parameter a

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

liftA2 :: (a -> b -> c) -> Parameter a -> Parameter b -> Parameter c

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

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

Functor Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

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

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

Monad Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

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

(>>) :: Parameter a -> Parameter b -> Parameter b

return :: a -> Parameter a

MonadCatch Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

catch :: Exception e => Parameter a -> (e -> Parameter a) -> Parameter a

MonadMask Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

mask :: ((forall a. Parameter a -> Parameter a) -> Parameter b) -> Parameter b

uninterruptibleMask :: ((forall a. Parameter a -> Parameter a) -> Parameter b) -> Parameter b

generalBracket :: Parameter a -> (a -> ExitCase b -> Parameter c) -> (a -> Parameter b) -> Parameter (b, c)

MonadThrow Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

throwM :: Exception e => e -> Parameter a

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

Defined in Simulation.Aivika.Results

Methods

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

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Parameter (SamplingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Parameter (SamplingCounter a) -> ResultSource

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

Defined in Simulation.Aivika.Results

Methods

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

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Parameter (TimingCounter a) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Parameter (TimingCounter a) -> ResultSource

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

Defined in Simulation.Aivika.Results

Methods

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

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Parameter (Array i e) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Parameter (Array i e) -> ResultSource

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

Defined in Simulation.Aivika.Results

Methods

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

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Parameter (Vector e) -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Parameter (Vector e) -> ResultSource

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

Defined in Simulation.Aivika.Results

Methods

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

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Parameter a -> ResultSource

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Parameter a -> ResultSource

Floating a => Floating (Parameter a)

Defined in Simulation.Aivika.Internal.Parameter

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

Num a => Num (Parameter a)

Defined in Simulation.Aivika.Internal.Parameter

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

Fractional a => Fractional (Parameter a)

Defined in Simulation.Aivika.Internal.Parameter

Methods

(/) :: Parameter a -> Parameter a -> Parameter a

recip :: Parameter a -> Parameter a

fromRational :: Rational -> Parameter a

Show (Parameter a)

Defined in Simulation.Aivika.Internal.Parameter

Methods

showsPrec :: Int -> Parameter a -> ShowS

show :: Parameter a -> String

showList :: [Parameter a] -> ShowS

Eq (Parameter a)

Defined in Simulation.Aivika.Internal.Parameter

Methods

(==) :: Parameter a -> Parameter a -> Bool

(/=) :: Parameter a -> Parameter a -> Bool

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 Composite

Defined in Simulation.Aivika.Composite

Methods

liftParameter :: Parameter a -> Composite a

ParameterLift Cont

Defined in Simulation.Aivika.Internal.Cont

Methods

liftParameter :: Parameter a -> Cont a

ParameterLift Dynamics

Defined in Simulation.Aivika.Internal.Dynamics

Methods

liftParameter :: Parameter a -> Dynamics a

ParameterLift Event

Defined in Simulation.Aivika.Internal.Event

Methods

liftParameter :: Parameter a -> Event a

ParameterLift Parameter

Defined in Simulation.Aivika.Internal.Parameter

Methods

liftParameter :: Parameter a -> Parameter a

ParameterLift Process

Defined in Simulation.Aivika.Internal.Process

Methods

liftParameter :: Parameter a -> Process a

ParameterLift Simulation

Defined in Simulation.Aivika.Internal.Simulation

Methods

liftParameter :: Parameter a -> Simulation a

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

Invoke the Parameter computation.

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 :: Exception e => Parameter a -> (e -> 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 :: Exception e => e -> 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.

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.

generatorParameter :: Parameter Generator

Return the random number generator for the simulation run.

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.