Data.Interval.Time

This module defines datatypes for closed intervals with end points on the UTCTime axis.

Time intervals of statically known length

data MinuteInterval (n :: Nat)

Closed time intervals of statically known length in minutes. Although such intervals are completely determined by the end time of type ZonedTime that was used for construction, we cache lb and ub als lazy fields of type UTCTime to speed up Interval queries.

Since: 0.2.1

Instances

Interval UTCTime (MinuteInterval n)

Defined in Data.Interval.Time

Methods

lb :: MinuteInterval n -> UTCTime

ub :: MinuteInterval n -> UTCTime

endPoints :: MinuteInterval n -> (UTCTime, UTCTime)

Show (MinuteInterval 10)

Defined in Data.Interval.Time

Methods

showsPrec :: Int -> MinuteInterval 10 -> ShowS

show :: MinuteInterval 10 -> String

showList :: [MinuteInterval 10] -> ShowS

Show (MinuteInterval 15)

Defined in Data.Interval.Time

Methods

showsPrec :: Int -> MinuteInterval 15 -> ShowS

show :: MinuteInterval 15 -> String

showList :: [MinuteInterval 15] -> ShowS

Eq (MinuteInterval n)

Time intervals of equal length are considered equal if they describe the same interval on the UTCTime axis, regardless of time zone.

Defined in Data.Interval.Time

Methods

(==) :: MinuteInterval n -> MinuteInterval n -> Bool

(/=) :: MinuteInterval n -> MinuteInterval n -> Bool

Ord (MinuteInterval n)

Intervals of fixed length are ordered by their end time. Hence you can put them into a Set or use as keys in a Map.

Defined in Data.Interval.Time

Methods

compare :: MinuteInterval n -> MinuteInterval n -> Ordering

(<) :: MinuteInterval n -> MinuteInterval n -> Bool

(<=) :: MinuteInterval n -> MinuteInterval n -> Bool

(>) :: MinuteInterval n -> MinuteInterval n -> Bool

(>=) :: MinuteInterval n -> MinuteInterval n -> Bool

max :: MinuteInterval n -> MinuteInterval n -> MinuteInterval n

min :: MinuteInterval n -> MinuteInterval n -> MinuteInterval n

fromEndTime :: KnownNat n => Proxy n -> ZonedTime -> MinuteInterval n

Smart constructor.

ub      (fromEndTime p z) == zonedTimeToUTC z
ubZoned (fromEndTime p z) == z

ubZoned :: MinuteInterval n -> ZonedTime

Retrieve the upper bound that was used in construction, see fromEndTime.

Time intervals of length 10 minutes

type Min10 = MinuteInterval 10

Time intervals of length 10 minutes. In logging applications, aggregate values (e.g. averages, sums, ...) are often taken over a period of 10 minutes and associated with the time when the aggregation was computed.

To create your custom aggregate data type, pair this time interval with the aggregate value, like follows.

data SumOver10Minutes s = Aggregate {
 aggregateValue :: s,
 aggregatedOver :: Min10
 }

instance Interval UTCTime (SumOver10Minutes s) where 
 lb = lb.aggregatedOver
 ub = ub.aggregatedOver

compositeAggregate :: (Interval UTCTime i, Monoid s, Foldable f, IntersectionQuery f UTCTime t) =>
 i -> t (SumOver10Minutes s) -> s
compositeAggregate i = foldMap aggregateValue . getProperIntersects i

Since: 0.2.1

until10 :: ZonedTime -> Min10

smart constructor

Time intervals of length 15 minutes

type Min15 = MinuteInterval 15

Time intervals comprising quarter of an hour.

Since: 0.2.1

until15 :: ZonedTime -> Min15

smart constructor