event-list-0.1.2: Event lists with relative or absolute time stamps

Copyright(c) Henning Thielemann 2007-2010
Maintainerhaskell@henning-thielemann.de
Stabilitystable
PortabilityHaskell 98
Safe HaskellSafe
LanguageHaskell98

Data.EventList.Relative.TimeBody

Description

Event lists starting with a time difference and ending with a body.

The time is stored in differences between the events. Thus there is no increase of time information for long, or even infinite, streams of events. Further on, the time difference is stored in the latter of two neighbouring events. This is necessary for real-time computing where it is not known whether and when the next event happens.

Synopsis

Documentation

data T time body Source #

Instances

Functor (T time) Source # 

Methods

fmap :: (a -> b) -> T time a -> T time b #

(<$) :: a -> T time b -> T time a #

Foldable (T time) Source # 

Methods

fold :: Monoid m => T time m -> m #

foldMap :: Monoid m => (a -> m) -> T time a -> m #

foldr :: (a -> b -> b) -> b -> T time a -> b #

foldr' :: (a -> b -> b) -> b -> T time a -> b #

foldl :: (b -> a -> b) -> b -> T time a -> b #

foldl' :: (b -> a -> b) -> b -> T time a -> b #

foldr1 :: (a -> a -> a) -> T time a -> a #

foldl1 :: (a -> a -> a) -> T time a -> a #

toList :: T time a -> [a] #

null :: T time a -> Bool #

length :: T time a -> Int #

elem :: Eq a => a -> T time a -> Bool #

maximum :: Ord a => T time a -> a #

minimum :: Ord a => T time a -> a #

sum :: Num a => T time a -> a #

product :: Num a => T time a -> a #

Traversable (T time) Source # 

Methods

traverse :: Applicative f => (a -> f b) -> T time a -> f (T time b) #

sequenceA :: Applicative f => T time (f a) -> f (T time a) #

mapM :: Monad m => (a -> m b) -> T time a -> m (T time b) #

sequence :: Monad m => T time (m a) -> m (T time a) #

(Eq body, Eq time) => Eq (T time body) Source # 

Methods

(==) :: T time body -> T time body -> Bool #

(/=) :: T time body -> T time body -> Bool #

(Ord body, Ord time) => Ord (T time body) Source # 

Methods

compare :: T time body -> T time body -> Ordering #

(<) :: T time body -> T time body -> Bool #

(<=) :: T time body -> T time body -> Bool #

(>) :: T time body -> T time body -> Bool #

(>=) :: T time body -> T time body -> Bool #

max :: T time body -> T time body -> T time body #

min :: T time body -> T time body -> T time body #

(Show time, Show body) => Show (T time body) Source # 

Methods

showsPrec :: Int -> T time body -> ShowS #

show :: T time body -> String #

showList :: [T time body] -> ShowS #

Semigroup (T time body) Source # 

Methods

(<>) :: T time body -> T time body -> T time body #

sconcat :: NonEmpty (T time body) -> T time body #

stimes :: Integral b => b -> T time body -> T time body #

Monoid (T time body) Source # 

Methods

mempty :: T time body #

mappend :: T time body -> T time body -> T time body #

mconcat :: [T time body] -> T time body #

(Arbitrary time, Arbitrary body) => Arbitrary (T time body) Source # 

Methods

arbitrary :: Gen (T time body) #

shrink :: T time body -> [T time body] #

empty :: T time body Source #

singleton :: time -> body -> T time body Source #

null :: T time body -> Bool Source #

viewL :: T time body -> Maybe ((time, body), T time body) Source #

viewR :: T time body -> Maybe (T time body, (time, body)) Source #

switchL :: c -> ((time, body) -> T time body -> c) -> T time body -> c Source #

switchR :: c -> (T time body -> (time, body) -> c) -> T time body -> c Source #

cons :: time -> body -> T time body -> T time body Source #

snoc :: T time body -> time -> body -> T time body Source #

fromPairList :: [(a, b)] -> T a b Source #

toPairList :: T a b -> [(a, b)] Source #

getTimes :: T time body -> [time] Source #

getBodies :: T time body -> [body] Source #

duration :: C time => T time body -> time Source #

mapBody :: (body0 -> body1) -> T time body0 -> T time body1 Source #

mapTime :: (time0 -> time1) -> T time0 body -> T time1 body Source #

zipWithBody :: (body0 -> body1 -> body2) -> [body0] -> T time body1 -> T time body2 Source #

zipWithTime :: (time0 -> time1 -> time2) -> [time0] -> T time1 body -> T time2 body Source #

unzip :: T time (body0, body1) -> (T time body0, T time body1) Source #

concatMapMonoid :: Monoid m => (time -> m) -> (body -> m) -> T time body -> m Source #

traverse :: Applicative m => (time0 -> m time1) -> (body0 -> m body1) -> T time0 body0 -> m (T time1 body1) Source #

traverse_ :: Applicative m => (time -> m ()) -> (body -> m ()) -> T time body -> m () Source #

traverseBody :: Applicative m => (body0 -> m body1) -> T time body0 -> m (T time body1) Source #

traverseTime :: Applicative m => (time0 -> m time1) -> T time0 body -> m (T time1 body) Source #

mapM :: Monad m => (time0 -> m time1) -> (body0 -> m body1) -> T time0 body0 -> m (T time1 body1) Source #

mapM_ :: Monad m => (time -> m ()) -> (body -> m ()) -> T time body -> m () Source #

mapBodyM :: Monad m => (body0 -> m body1) -> T time body0 -> m (T time body1) Source #

mapTimeM :: Monad m => (time0 -> m time1) -> T time0 body -> m (T time1 body) Source #

foldr :: (time -> a -> b) -> (body -> b -> a) -> b -> T time body -> b Source #

foldrPair :: (time -> body -> a -> a) -> a -> T time body -> a Source #

merge :: (C time, Ord body) => T time body -> T time body -> T time body Source #

This function merges the events of two lists into a new event list. Note that merge compares entire events rather than just start times. This is to ensure that it is commutative, one of the properties we test for.

mergeBy :: C time => (body -> body -> Bool) -> T time body -> T time body -> T time body Source #

mergeBy is like merge but does not simply use the methods of the Ord class but allows a custom comparison function. If in event lists xs and ys there are coinciding elements x and y, and cmp x y is True, then x comes before y in mergeBy cmp xs ys.

EventList> EventList.mergeBy (\_ _ -> True) (0 /. 'a' ./ empty) (0 /. 'b' ./ empty)
0 /. 'a' ./ 0 /. 'b' ./ empty

EventList> EventList.mergeBy (\_ _ -> False) (0 /. 'a' ./ empty) (0 /. 'b' ./ empty)
0 /. 'b' ./ 0 /. 'a' ./ empty

insert :: (C time, Ord body) => time -> body -> T time body -> T time body Source #

insert inserts an event into an event list at the given time.

insertBy :: C time => (body -> body -> Bool) -> time -> body -> T time body -> T time body Source #

moveForward :: (Ord time, Num time) => T time (time, body) -> T time body Source #

Move events towards the front of the event list. You must make sure, that no event is moved before time zero. This works only for finite lists.

decreaseStart :: C time => time -> T time body -> T time body Source #

delay :: C time => time -> T time body -> T time body Source #

filter :: C time => (body -> Bool) -> T time body -> T time body Source #

Keep only events that match a predicate while preserving absolute times.

partition :: C time => (body -> Bool) -> T time body -> (T time body, T time body) Source #

partitionMaybe :: C time => (body0 -> Maybe body1) -> T time body0 -> (T time body1, T time body0) Source #

slice :: (Eq a, C time) => (body -> a) -> T time body -> [(a, T time body)] Source #

Using a classification function we splice the event list into lists, each containing the same class. Absolute time stamps are preserved.

span :: (body -> Bool) -> T time body -> (T time body, T time body) Source #

mapMaybe :: C time => (body0 -> Maybe body1) -> T time body0 -> T time body1 Source #

catMaybes :: C time => T time (Maybe body) -> T time body Source #

Adds times in a left-associative fashion. Use this if the time is a strict data type.

normalize :: (C time, Ord body) => T time body -> T time body Source #

sort sorts a list of coinciding events, that is all events but the first one have time difference 0. normalize sorts all coinciding events in a list thus yielding a canonical representation of a time ordered list.

isNormalized :: (C time, Ord body) => T time body -> Bool Source #

collectCoincident :: C time => T time body -> T time [body] Source #

Group events that have equal start times (that is zero time differences).

flatten :: C time => T time [body] -> T time body Source #

Reverse to collectCoincident: Turn each body into a separate event.

  xs  ==  flatten (collectCoincident xs)

mapCoincident :: C time => ([a] -> [b]) -> T time a -> T time b Source #

Apply a function to the lists of coincident events.

append :: T time body -> T time body -> T time body Source #

concat :: [T time body] -> T time body Source #

cycle :: T time body -> T time body Source #

discretize :: (C time, RealFrac time, C i, Integral i) => T time body -> T i body Source #

We provide discretize and resample for discretizing the time information. When converting the precise relative event times to the integer relative event times we have to prevent accumulation of rounding errors. We avoid this problem with a stateful conversion which remembers each rounding error we make. This rounding error is used to correct the next rounding. Given the relative time and duration of an event the function floorDiff creates a State which computes the rounded relative time. It is corrected by previous rounding errors.

The resulting event list may have differing time differences which were equal before discretization, but the overall timing is uniformly close to the original.

We use floorDiff rather than roundDiff in order to compute exclusively with non-negative numbers.

resample :: (C time, RealFrac time, C i, Integral i) => time -> T time body -> T i body Source #

toAbsoluteEventList :: Num time => time -> T time body -> T time body Source #

We tried hard to compute everything with respect to relative times. However sometimes we need absolute time values.

fromAbsoluteEventList :: Num time => T time body -> T time body Source #

toAbsoluteEventListGen :: (absTime -> relTime -> absTime) -> absTime -> T relTime body -> T absTime body Source #

Convert from relative time stamps to absolute time stamps using a custom accumulator function (like (+)).

fromAbsoluteEventListGen :: (absTime -> absTime -> relTime) -> absTime -> T absTime body -> T relTime body Source #

Convert from absolute time stamps to relative time stamps using custom subtraction (like (-)) and zero.