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]

type Rep AbsoluteTime

Defined in Epidemic.Types.Time

type Rep AbsoluteTime = D1 ('MetaData "AbsoluteTime" "Epidemic.Types.Time" "epi-sim-0.4.2-4l1mCHWa7vKLa54bgYWgDR" '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.4.2-4l1mCHWa7vKLa54bgYWgDR" 'True) (C1 ('MetaCons "TimeDelta" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

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.4.2-4l1mCHWa7vKLa54bgYWgDR" 'True) (C1 ('MetaCons "Timed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(AbsoluteTime, a)])))

timeDelta

Arguments

:: AbsoluteTime

start

-> AbsoluteTime

finish

-> TimeDelta

The duration of time between two absolute times

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

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

Evaluate the timed object treating it as a direct delta function

timeAfterDelta :: AbsoluteTime -> TimeDelta -> AbsoluteTime

The time after a given delay

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

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

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

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

Evaluate the timed object treating it as a cadlag function

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

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

hasTime :: Timed a -> AbsoluteTime -> Bool

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

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]

asTimed

Arguments

:: Num a

=> [(AbsoluteTime, a)]

list of ascending times and values

-> Maybe (Timed a)

Construct a timed list if possible.