Simulation.Aivika.Event

Tested with: GHC 8.0.1

The module defines the Event monad which is very similar to the Dynamics monad but only now the computation is strongly synchronized with the event queue.

The Dynamics computation is defined in all time points simultaneously, while the Event computation can be described in every time point differently and can change in discrete steps. Therefore, the former is destined for differential and difference equations of System Dynamics, while the latter is destined for discrete event simulation, being its core actually.

Event Monad

data Event a

A value in the Event monad represents a polymorphic time varying function which is strongly synchronized with the event queue.

Instances

Monad Event

Methods

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

(>>) :: Event a -> Event b -> Event b

return :: a -> Event a

fail :: String -> Event a

Functor Event

Methods

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

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

MonadFix Event

Methods

mfix :: (a -> Event a) -> Event a

Applicative Event

Methods

pure :: a -> Event a

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

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

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

MonadIO Event

Methods

liftIO :: IO a -> Event a

ParameterLift Event

Methods

liftParameter :: Parameter a -> Event a

SimulationLift Event

Methods

liftSimulation :: Simulation a -> Event a

DynamicsLift Event

Methods

liftDynamics :: Dynamics a -> Event a

EventLift Event

Methods

liftEvent :: Event a -> Event a

ResultComputing Event

Methods

computeResultData :: Event a -> ResultData a

computeResultSignal :: Event a -> ResultSignal

class EventLift m where

A type class to lift the Event computation to other computations.

Minimal complete definition

liftEvent

Methods

liftEvent :: Event a -> m a

Lift the specified Event computation to another computation.

Instances

EventLift Event

Methods

liftEvent :: Event a -> Event a

EventLift Cont

Methods

liftEvent :: Event a -> Cont a

EventLift Process

Methods

liftEvent :: Event a -> Process a

EventLift Composite

Methods

liftEvent :: Event a -> Composite a

data EventProcessing

Defines how the events are processed.

Constructors

CurrentEvents

either process all earlier and then current events, or raise an error if the current simulation time is less than the actual time of the event queue (safe within the Event computation as this is protected by the type system)

EarlierEvents

either process all earlier events not affecting the events at the current simulation time, or raise an error if the current simulation time is less than the actual time of the event queue (safe within the Event computation as this is protected by the type system)

CurrentEventsOrFromPast

either process all earlier and then current events, or do nothing if the current simulation time is less than the actual time of the event queue (do not use unless the documentation states the opposite)

EarlierEventsOrFromPast

either process all earlier events, or do nothing if the current simulation time is less than the actual time of the event queue (do not use unless the documentation states the opposite)

Instances

Eq EventProcessing

Methods

(==) :: EventProcessing -> EventProcessing -> Bool

(/=) :: EventProcessing -> EventProcessing -> Bool

Ord EventProcessing

Methods

compare :: EventProcessing -> EventProcessing -> Ordering

(<) :: EventProcessing -> EventProcessing -> Bool

(<=) :: EventProcessing -> EventProcessing -> Bool

(>) :: EventProcessing -> EventProcessing -> Bool

(>=) :: EventProcessing -> EventProcessing -> Bool

max :: EventProcessing -> EventProcessing -> EventProcessing

min :: EventProcessing -> EventProcessing -> EventProcessing

Show EventProcessing

Methods

showsPrec :: Int -> EventProcessing -> ShowS

show :: EventProcessing -> String

showList :: [EventProcessing] -> ShowS

runEvent :: Event a -> Dynamics a

Run the Event computation in the current simulation time within the Dynamics computation involving all pending CurrentEvents in the processing too.

runEventWith :: EventProcessing -> Event a -> Dynamics a

Run the Event computation in the current simulation time within the Dynamics computation specifying what pending events should be involved in the processing.

runEventInStartTime :: Event a -> Simulation a

Run the Event computation in the start time involving all pending CurrentEvents in the processing too.

runEventInStopTime :: Event a -> Simulation a

Run the Event computation in the stop time involving all pending CurrentEvents in the processing too.

Event Queue

enqueueEvent :: Double -> Event () -> Event ()

Enqueue the event which must be actuated at the specified time.

enqueueEventWithCancellation :: Double -> Event () -> Event EventCancellation

Enqueue the event with an ability to cancel it.

enqueueEventWithStartTime :: Event () -> Event ()

Actuate the event handler in the start time point.

enqueueEventWithStopTime :: Event () -> Event ()

Actuate the event handler in the final time point.

enqueueEventWithTimes :: [Double] -> Event () -> Event ()

Actuate the event handler in the specified time points.

enqueueEventWithIntegTimes :: Event () -> Event ()

Actuate the event handler in the integration time points.

yieldEvent :: Event () -> Event ()

Enqueue the event which must be actuated with the current modeling time but later.

eventQueueCount :: Event Int

Return the number of pending events that should be yet actuated.

Cancelling Event

data EventCancellation

It allows cancelling the event.

cancelEvent :: EventCancellation -> Event ()

Cancel the event.

eventCancelled :: EventCancellation -> Event Bool

Test whether the event was cancelled.

eventFinished :: EventCancellation -> Event Bool

Test whether the event was processed and finished.

Error Handling

catchEvent :: Exception e => Event a -> (e -> Event a) -> Event a

Exception handling within Event computations.

finallyEvent :: Event a -> Event b -> Event a

A computation with finalization part like the finally function.

throwEvent :: Exception e => e -> Event a

Like the standard throw function.

Memoization

memoEvent :: Event a -> Simulation (Event a)

Memoize the Event computation, always returning the same value within a simulation run.

memoEventInTime :: Event a -> Simulation (Event a)

Memoize the Event computation, always returning the same value in the same modeling time. After the time changes, the value is recalculated by demand.

It is possible to implement this function efficiently, for the Event computation is always synchronized with the event queue which time flows in one direction only. This synchronization is a key difference between the Event and Dynamics computations.

Disposable

newtype DisposableEvent

Defines a computation disposing some entity.

Constructors

DisposableEvent

Fields

• disposeEvent :: Event ()

  Dispose something within the Event computation.

Instances

Monoid DisposableEvent

Methods

mempty :: DisposableEvent

mappend :: DisposableEvent -> DisposableEvent -> DisposableEvent

mconcat :: [DisposableEvent] -> DisposableEvent

Retrying Computation

retryEvent :: String -> Event a

Retry the current computation as possible, using the specified argument as a SimulationRetry exception message in case of failure.

Debugging

traceEvent :: String -> Event a -> Event a

Show the debug message with the current simulation time.