Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.TimeDomain

Description

This module defines the TimeDomain class. Its instances model time, simulated and realtime. Several instances such as UTCTime, Double and Integer are supplied here.

Synopsis

newtype NumTimeDomain a = NumTimeDomain {
- fromNumTimeDomain :: a
}
class TimeDifference d where
- difference :: d -> d -> d
- add :: d -> d -> d
class TimeDifference (Diff time) => TimeDomain time where
- type Diff time
- diffTime :: time -> time -> Diff time
- addTime :: time -> Diff time -> time
data UTCTime

Documentation

newtype NumTimeDomain a Source #

Any Num can be wrapped to form a TimeDomain.

Constructors

NumTimeDomain
Fields fromNumTimeDomain :: a

Instances

Instances details

Num a => Num (NumTimeDomain a) Source #
Instance details Defined in Data.TimeDomain Methods (+) :: NumTimeDomain a -> NumTimeDomain a -> NumTimeDomain a # (-) :: NumTimeDomain a -> NumTimeDomain a -> NumTimeDomain a # (*) :: NumTimeDomain a -> NumTimeDomain a -> NumTimeDomain a # negate :: NumTimeDomain a -> NumTimeDomain a # abs :: NumTimeDomain a -> NumTimeDomain a # signum :: NumTimeDomain a -> NumTimeDomain a # fromInteger :: Integer -> NumTimeDomain a #
Num a => TimeDifference (NumTimeDomain a) Source #
Instance details Defined in Data.TimeDomain Methods difference :: NumTimeDomain a -> NumTimeDomain a -> NumTimeDomain a Source # add :: NumTimeDomain a -> NumTimeDomain a -> NumTimeDomain a Source #
Num a => TimeDomain (NumTimeDomain a) Source #
Instance details Defined in Data.TimeDomain Associated Types type Diff (NumTimeDomain a) Source # Methods diffTime :: NumTimeDomain a -> NumTimeDomain a -> Diff (NumTimeDomain a) Source # addTime :: NumTimeDomain a -> Diff (NumTimeDomain a) -> NumTimeDomain a Source #
type Diff (NumTimeDomain a) Source #
Instance details Defined in Data.TimeDomain type Diff (NumTimeDomain a) = NumTimeDomain a

class TimeDifference d where Source #

A type of durations, or differences betweens time stamps.

Expected laws:

add is commutative and associative
```
(dt1 difference dt2) add dt2 = dt1
```

Methods

difference :: d -> d -> d Source #

Calculate the difference between two durations, compatibly with diffTime.

add :: d -> d -> d Source #

Add two time differences.

Instances

Instances details

TimeDifference Integer Source #
Instance details Defined in Data.TimeDomain Methods difference :: Integer -> Integer -> Integer Source # add :: Integer -> Integer -> Integer Source #
TimeDifference () Source #
Instance details Defined in Data.TimeDomain Methods difference :: () -> () -> () Source # add :: () -> () -> () Source #
TimeDifference Double Source #
Instance details Defined in Data.TimeDomain Methods difference :: Double -> Double -> Double Source # add :: Double -> Double -> Double Source #
TimeDifference Float Source #
Instance details Defined in Data.TimeDomain Methods difference :: Float -> Float -> Float Source # add :: Float -> Float -> Float Source #
Num a => TimeDifference (NumTimeDomain a) Source #
Instance details Defined in Data.TimeDomain Methods difference :: NumTimeDomain a -> NumTimeDomain a -> NumTimeDomain a Source # add :: NumTimeDomain a -> NumTimeDomain a -> NumTimeDomain a Source #

class TimeDifference (Diff time) => TimeDomain time where Source #

A time domain is an affine space representing a notion of time, such as real time, simulated time, steps, or a completely different notion.

Expected laws:

(t1 diffTime t3) difference (t1 diffTime t2) = t2 diffTime t3

```
(t addTime dt) diffTime t = dt
```

(t addTime dt1) addTime dt2 = t addTime (dt1 add dt2)

Associated Types

type Diff time Source #

The type of differences or durations between two timestamps

Methods

diffTime :: time -> time -> Diff time Source #

Compute the difference between two timestamps.

Mnemonic: diffTime behaves like the (-) operator:

diffTime earlier later = later `diffTime` earlier is the duration it takes from earlier to later.

addTime :: time -> Diff time -> time Source #

Add a time difference to a timestamp.

Instances

Instances details

TimeDomain UTCTime Source #	Differences between `UTCTime`s are measured in seconds.
Instance details Defined in Data.TimeDomain Associated Types type Diff UTCTime Source # Methods diffTime :: UTCTime -> UTCTime -> Diff UTCTime Source # addTime :: UTCTime -> Diff UTCTime -> UTCTime Source #
TimeDomain Integer Source #
Instance details Defined in Data.TimeDomain Associated Types type Diff Integer Source # Methods diffTime :: Integer -> Integer -> Diff Integer Source # addTime :: Integer -> Diff Integer -> Integer Source #
TimeDomain () Source #
Instance details Defined in Data.TimeDomain Associated Types type Diff () Source # Methods diffTime :: () -> () -> Diff () Source # addTime :: () -> Diff () -> () Source #
TimeDomain Double Source #
Instance details Defined in Data.TimeDomain Associated Types type Diff Double Source # Methods diffTime :: Double -> Double -> Diff Double Source # addTime :: Double -> Diff Double -> Double Source #
TimeDomain Float Source #
Instance details Defined in Data.TimeDomain Associated Types type Diff Float Source # Methods diffTime :: Float -> Float -> Diff Float Source # addTime :: Float -> Diff Float -> Float Source #
Num a => TimeDomain (NumTimeDomain a) Source #
Instance details Defined in Data.TimeDomain Associated Types type Diff (NumTimeDomain a) Source # Methods diffTime :: NumTimeDomain a -> NumTimeDomain a -> Diff (NumTimeDomain a) Source # addTime :: NumTimeDomain a -> Diff (NumTimeDomain a) -> NumTimeDomain a Source #

data UTCTime #

This is the simplest representation of UTC. It consists of the day number, and a time offset from midnight. Note that if a day has a leap second added to it, it will have 86401 seconds.

Instances

Instances details

Data UTCTime
Instance details Defined in Data.Time.Clock.Internal.UTCTime Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UTCTime -> c UTCTime # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UTCTime # toConstr :: UTCTime -> Constr # dataTypeOf :: UTCTime -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UTCTime) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UTCTime) # gmapT :: (forall b. Data b => b -> b) -> UTCTime -> UTCTime # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UTCTime -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UTCTime -> r # gmapQ :: (forall d. Data d => d -> u) -> UTCTime -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UTCTime -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UTCTime -> m UTCTime # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UTCTime -> m UTCTime # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UTCTime -> m UTCTime #
NFData UTCTime
Instance details Defined in Data.Time.Clock.Internal.UTCTime Methods rnf :: UTCTime -> () #
Eq UTCTime
Instance details Defined in Data.Time.Clock.Internal.UTCTime Methods (==) :: UTCTime -> UTCTime -> Bool # (/=) :: UTCTime -> UTCTime -> Bool #
Ord UTCTime
Instance details Defined in Data.Time.Clock.Internal.UTCTime Methods compare :: UTCTime -> UTCTime -> Ordering # (<) :: UTCTime -> UTCTime -> Bool # (<=) :: UTCTime -> UTCTime -> Bool # (>) :: UTCTime -> UTCTime -> Bool # (>=) :: UTCTime -> UTCTime -> Bool # max :: UTCTime -> UTCTime -> UTCTime # min :: UTCTime -> UTCTime -> UTCTime #
TimeDomain UTCTime Source #	Differences between `UTCTime`s are measured in seconds.
Instance details Defined in Data.TimeDomain Associated Types type Diff UTCTime Source # Methods diffTime :: UTCTime -> UTCTime -> Diff UTCTime Source # addTime :: UTCTime -> Diff UTCTime -> UTCTime Source #
type Diff UTCTime Source #
Instance details Defined in Data.TimeDomain type Diff UTCTime = Double