Epidemic.Types.Time

Documentation

newtype AbsoluteTime

Absolute time.

Constructors

AbsoluteTime Double

Instances

Eq AbsoluteTime

Defined in Epidemic.Types.Time

Methods

(==) :: AbsoluteTime -> AbsoluteTime -> Bool

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

Ord AbsoluteTime

Defined in Epidemic.Types.Time

Methods

compare :: AbsoluteTime -> AbsoluteTime -> Ordering

(<) :: AbsoluteTime -> AbsoluteTime -> Bool

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

(>) :: AbsoluteTime -> AbsoluteTime -> Bool

(>=) :: AbsoluteTime -> AbsoluteTime -> Bool

max :: AbsoluteTime -> AbsoluteTime -> AbsoluteTime

min :: AbsoluteTime -> AbsoluteTime -> AbsoluteTime

Show AbsoluteTime

Defined in Epidemic.Types.Time

Methods

showsPrec :: Int -> AbsoluteTime -> ShowS

show :: AbsoluteTime -> String

showList :: [AbsoluteTime] -> ShowS

Generic AbsoluteTime

Defined in Epidemic.Types.Time

Associated Types

type Rep AbsoluteTime :: Type -> Type

Methods

from :: AbsoluteTime -> Rep AbsoluteTime x

to :: Rep AbsoluteTime x -> AbsoluteTime

ToJSON AbsoluteTime

Defined in Epidemic.Types.Time

Methods

toJSON :: AbsoluteTime -> Value

toEncoding :: AbsoluteTime -> Encoding

toJSONList :: [AbsoluteTime] -> Value

toEncodingList :: [AbsoluteTime] -> Encoding

FromJSON AbsoluteTime

Defined in Epidemic.Types.Time

Methods

parseJSON :: Value -> Parser AbsoluteTime

parseJSONList :: Value -> Parser [AbsoluteTime]

TimeStamp AbsoluteTime

Defined in Epidemic.Types.Time

Methods

absTime :: AbsoluteTime -> AbsoluteTime

isAfter :: AbsoluteTime -> AbsoluteTime -> Bool

isBefore :: AbsoluteTime -> AbsoluteTime -> Bool

type Rep AbsoluteTime

Defined in Epidemic.Types.Time

type Rep AbsoluteTime = D1 ('MetaData "AbsoluteTime" "Epidemic.Types.Time" "epi-sim-0.7.0-DViI2uXntfg6JZVuToo6fh" 'True) (C1 ('MetaCons "AbsoluteTime" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

newtype TimeDelta

Duration of time between two absolute times.

Constructors

TimeDelta Double

Instances

Eq TimeDelta

Defined in Epidemic.Types.Time

Methods

(==) :: TimeDelta -> TimeDelta -> Bool

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

Ord TimeDelta

Defined in Epidemic.Types.Time

Methods

compare :: TimeDelta -> TimeDelta -> Ordering

(<) :: TimeDelta -> TimeDelta -> Bool

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

(>) :: TimeDelta -> TimeDelta -> Bool

(>=) :: TimeDelta -> TimeDelta -> Bool

max :: TimeDelta -> TimeDelta -> TimeDelta

min :: TimeDelta -> TimeDelta -> TimeDelta

Show TimeDelta

Defined in Epidemic.Types.Time

Methods

showsPrec :: Int -> TimeDelta -> ShowS

show :: TimeDelta -> String

showList :: [TimeDelta] -> ShowS

Generic TimeDelta

Defined in Epidemic.Types.Time

Associated Types

type Rep TimeDelta :: Type -> Type

Methods

from :: TimeDelta -> Rep TimeDelta x

to :: Rep TimeDelta x -> TimeDelta

ToJSON TimeDelta

Defined in Epidemic.Types.Time

Methods

toJSON :: TimeDelta -> Value

toEncoding :: TimeDelta -> Encoding

toJSONList :: [TimeDelta] -> Value

toEncodingList :: [TimeDelta] -> Encoding

FromJSON TimeDelta

Defined in Epidemic.Types.Time

Methods

parseJSON :: Value -> Parser TimeDelta

parseJSONList :: Value -> Parser [TimeDelta]

type Rep TimeDelta

Defined in Epidemic.Types.Time

type Rep TimeDelta = D1 ('MetaData "TimeDelta" "Epidemic.Types.Time" "epi-sim-0.7.0-DViI2uXntfg6JZVuToo6fh" 'True) (C1 ('MetaCons "TimeDelta" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

data TimeInterval

An interval of time

Constructors

TimeInterval

Fields

• timeIntEndPoints :: (AbsoluteTime, AbsoluteTime)
• timeIntDuration :: TimeDelta

Instances

Eq TimeInterval

Defined in Epidemic.Types.Time

Methods

(==) :: TimeInterval -> TimeInterval -> Bool

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

Show TimeInterval

Defined in Epidemic.Types.Time

Methods

showsPrec :: Int -> TimeInterval -> ShowS

show :: TimeInterval -> String

showList :: [TimeInterval] -> ShowS

Generic TimeInterval

Defined in Epidemic.Types.Time

Associated Types

type Rep TimeInterval :: Type -> Type

Methods

from :: TimeInterval -> Rep TimeInterval x

to :: Rep TimeInterval x -> TimeInterval

ToJSON TimeInterval

Defined in Epidemic.Types.Time

Methods

toJSON :: TimeInterval -> Value

toEncoding :: TimeInterval -> Encoding

toJSONList :: [TimeInterval] -> Value

toEncodingList :: [TimeInterval] -> Encoding

FromJSON TimeInterval

Defined in Epidemic.Types.Time

Methods

parseJSON :: Value -> Parser TimeInterval

parseJSONList :: Value -> Parser [TimeInterval]

type Rep TimeInterval

Defined in Epidemic.Types.Time

type Rep TimeInterval = D1 ('MetaData "TimeInterval" "Epidemic.Types.Time" "epi-sim-0.7.0-DViI2uXntfg6JZVuToo6fh" 'False) (C1 ('MetaCons "TimeInterval" 'PrefixI 'True) (S1 ('MetaSel ('Just "timeIntEndPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AbsoluteTime, AbsoluteTime)) :*: S1 ('MetaSel ('Just "timeIntDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TimeDelta)))

newtype Timed a

Type containing values at times. The times are increasing as required by asTimed.

Constructors

Timed [(AbsoluteTime, a)]

Instances

Eq a => Eq (Timed a)

Defined in Epidemic.Types.Time

Methods

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

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

Show a => Show (Timed a)

Defined in Epidemic.Types.Time

Methods

showsPrec :: Int -> Timed a -> ShowS

show :: Timed a -> String

showList :: [Timed a] -> ShowS

Generic (Timed a)

Defined in Epidemic.Types.Time

Associated Types

type Rep (Timed a) :: Type -> Type

Methods

from :: Timed a -> Rep (Timed a) x

to :: Rep (Timed a) x -> Timed a

Semigroup (Timed a)

Defined in Epidemic.Types.Time

Methods

(<>) :: Timed a -> Timed a -> Timed a

sconcat :: NonEmpty (Timed a) -> Timed a

stimes :: Integral b => b -> Timed a -> Timed a

ToJSON a => ToJSON (Timed a)

Defined in Epidemic.Types.Time

Methods

toJSON :: Timed a -> Value

toEncoding :: Timed a -> Encoding

toJSONList :: [Timed a] -> Value

toEncodingList :: [Timed a] -> Encoding

FromJSON a => FromJSON (Timed a)

Defined in Epidemic.Types.Time

Methods

parseJSON :: Value -> Parser (Timed a)

parseJSONList :: Value -> Parser [Timed a]

type Rep (Timed a)

Defined in Epidemic.Types.Time

type Rep (Timed a) = D1 ('MetaData "Timed" "Epidemic.Types.Time" "epi-sim-0.7.0-DViI2uXntfg6JZVuToo6fh" 'True) (C1 ('MetaCons "Timed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(AbsoluteTime, a)])))

class TimeStamp a where

A type that has an absolute time associated with it and can be treated as having a temporal ordering.

a = AbsoluteTime 1
b = AbsoluteTime 2
a `isBefore` b

Minimal complete definition

absTime

Methods

absTime :: a -> AbsoluteTime

isAfter :: a -> a -> Bool

isBefore :: a -> a -> Bool

Instances

TimeStamp AbsoluteTime

Defined in Epidemic.Types.Time

Methods

absTime :: AbsoluteTime -> AbsoluteTime

isAfter :: AbsoluteTime -> AbsoluteTime -> Bool

isBefore :: AbsoluteTime -> AbsoluteTime -> Bool

TimeStamp EpidemicEvent

Defined in Epidemic.Types.Events

Methods

absTime :: EpidemicEvent -> AbsoluteTime

isAfter :: EpidemicEvent -> EpidemicEvent -> Bool

isBefore :: EpidemicEvent -> EpidemicEvent -> Bool

TimeStamp Observation

Defined in Epidemic.Types.Observations

Methods

absTime :: Observation -> AbsoluteTime

isAfter :: Observation -> Observation -> Bool

isBefore :: Observation -> Observation -> Bool

allTimes :: Timed a -> [AbsoluteTime]

Return a list of the (finite) absolute times that the step function changes value.

>>> let demoMaybeTimed = asTimed [(AbsoluteTime 1,2),(AbsoluteTime 1.5,1)]
>>> liftM allTimes demoMaybeTimed
Just [AbsoluteTime 1.0,AbsoluteTime 1.5]

allValues :: Timed a -> [a]

The values that the timed variable takes. NOTE that it is safe to use fromJust here because allTimes only returns times for which there is a cadlag value anyway.

>>> (Just tx) = asTimed [(AbsoluteTime 1,2),(AbsoluteTime 1.5,1)]
>>> allValues tx
[2,1]

asConsecutiveIntervals1 :: [AbsoluteTime] -> [TimeInterval]

Construct a list of consecutive intervals divided by the given absolute times.

asTimed

Arguments

:: Num a

=> [(AbsoluteTime, a)]

list of ascending times and values

-> Maybe (Timed a)

Construct a timed list if possible.

cadlagValue :: Timed a -> AbsoluteTime -> Maybe a

Evaluate the timed object treating it as a cadlag function

diracDeltaValue :: Timed a -> AbsoluteTime -> Maybe a

Evaluate the timed object treating it as a direct delta function

hasTime :: Timed a -> AbsoluteTime -> Bool

Check if there exists a pair with a particular time index.

inInterval :: TimeStamp a => TimeInterval -> a -> Bool

Check if an AbsoluteTime sits within a TimeInterval.

isAscending :: Ord a => [a] -> Bool

Predicate to check if a list of orderable objects is in ascending order.

maybeNextTimed :: Timed a -> Timed b -> AbsoluteTime -> Maybe (AbsoluteTime, Either a b)

Look at both of the timed objects and, if possible, return the time that the first one changes along with the value it changes to.

>>> (Just tA) = asTimed [(AbsoluteTime 1, (1.1 :: Double)), (AbsoluteTime 3, 2.3)]
>>> (Just tB) = asTimed [(AbsoluteTime 2, (1 :: Int))]
>>> maybeNextTimed tA tB (AbsoluteTime 0.5)
Just (AbsoluteTime 1.0,Left 1.1)
>>> maybeNextTimed tA tB (AbsoluteTime 1.5)
Just (AbsoluteTime 2.0,Right 1)
>>> maybeNextTimed tA tB (AbsoluteTime 3.5)
Nothing

nextTime :: Timed a -> AbsoluteTime -> Maybe AbsoluteTime

Return the value of the next time if possible or an exact match if it exists.

timeAfterDelta :: AbsoluteTime -> TimeDelta -> AbsoluteTime

The time after a given delay

>>> timeAfterDelta (AbsoluteTime 1) (TimeDelta 2.5)
AbsoluteTime 3.5

timeDelta

Arguments

:: AbsoluteTime

start

-> AbsoluteTime

finish

-> TimeDelta

The duration of time between two absolute times

>>> timeDelta (AbsoluteTime 1) (AbsoluteTime 2.5)
TimeDelta 1.5

timeInterval1 :: AbsoluteTime -> AbsoluteTime -> TimeInterval

Construct a TimeInterval from the end points.

timeInterval2 :: AbsoluteTime -> TimeDelta -> TimeInterval

Construct a TimeInterval from the start time and the duration.