IntervalAlgebra

The IntervalAlgebra module provides data types and related classes for the interval-based temporal logic described in Allen (1983) and axiomatized in Allen and Hayes (1987).

A good primer on Allen's algebra can be found here.

Design

The module is built around four typeclasses designed to separate concerns of constructing, relating, and combining types that contain Intervals:

1. Intervallic provides an interface to the data structures which contain an Interval.
2. IntervalAlgebraic provides an interface to the IntervalRelations, the workhorse of Allen's temporal logic.
3. IntervalCombinable provides an interface to methods of combining two Intervals.
4. IntervalSizeable provides methods for measuring and modifying the size of an interval.

An advantage of nested typeclass design is that developers can define an Interval of type a with just the amount of structure that they need.

Total Ordering of Intervals

The modules makes the (opinionated) choice of a total ordering for Intervallic Intervals. Namely, the ordering is based on first ordering the begins then the ends.

Development

This module is under development and the API may change in the future.

Classes

class Ord a => Intervallic i a where

The Intervallic typeclass defines how to get and set the Interval content of a data structure. It also includes functions for getting the begin and end this data.

Minimal complete definition

getInterval, setInterval

Methods

getInterval :: i a -> Interval a

Get the interval from an i a

setInterval :: i a -> Interval a -> i a

Set the interval in an i a

begin :: i a -> a

Access the ends of an i a .

end :: i a -> a

Access the ends of an i a .

Instances

(Ord a, Show a) => Intervallic Interval a

Defined in IntervalAlgebra

Methods

getInterval :: Interval a -> Interval a

setInterval :: Interval a -> Interval a -> Interval a

begin :: Interval a -> a

end :: Interval a -> a

Ord a => Intervallic (PairedInterval b) a

Defined in IntervalAlgebra.PairedInterval

Methods

getInterval :: PairedInterval b a -> Interval a

setInterval :: PairedInterval b a -> Interval a -> PairedInterval b a

begin :: PairedInterval b a -> a

end :: PairedInterval b a -> a

class (Eq (i a), Intervallic i a) => IntervalAlgebraic i a where

The IntervalAlgebraic typeclass specifies the functions and relational operators for interval-based temporal logic. The typeclass defines the relational operators for types that contain an 'Interval a', plus other useful utilities such as disjoint, within, and unionPredicates.

Minimal complete definition

Nothing

Methods

relate :: i a -> i a -> IntervalRelation (i a)

Compare two i a to determine their IntervalRelation.

predicate' :: IntervalRelation (i a) -> ComparativePredicateOf (i a)

Maps an IntervalRelation to its corresponding predicate function.

predicates :: Set (IntervalRelation (i a)) -> [ComparativePredicateOf (i a)]

Given a set of IntervalRelations return a list of predicate functions corresponding to each relation.

predicate :: Set (IntervalRelation (i a)) -> ComparativePredicateOf (i a)

Forms a predicate function from the union of a set of IntervalRelations.

toSet :: [IntervalRelation (i a)] -> Set (IntervalRelation (i a))

Shortcut to creating a 'Set IntervalRelation' from a list.

compose :: IntervalRelation (i a) -> IntervalRelation (i a) -> Set (IntervalRelation (i a))

Compose two interval relations according to the rules of the algebra. The rules are enumerated according to this table.

complement :: Set (IntervalRelation (i a)) -> Set (IntervalRelation (i a))

Finds the complement of a 'Set IntervalRelation'.

intersection :: Set (IntervalRelation (i a)) -> Set (IntervalRelation (i a)) -> Set (IntervalRelation (i a))

Find the intersection of two Sets of IntervalRelations.

union :: Set (IntervalRelation (i a)) -> Set (IntervalRelation (i a)) -> Set (IntervalRelation (i a))

Find the union of two Sets of IntervalRelations.

converse :: Set (IntervalRelation (i a)) -> Set (IntervalRelation (i a))

Find the converse of a 'Set IntervalRelation'.

equals :: ComparativePredicateOf (i a)

Does x equal y?

meets :: ComparativePredicateOf (i a)

Does x meet y? Is y metBy x?

metBy :: ComparativePredicateOf (i a)

Does x meet y? Is y metBy x?

before :: ComparativePredicateOf (i a)

Is x before y? Is x after y?

after :: ComparativePredicateOf (i a)

Is x before y? Is x after y?

overlaps :: ComparativePredicateOf (i a)

Does x overlap y? Is x overlapped by y?

overlappedBy :: ComparativePredicateOf (i a)

Does x overlap y? Is x overlapped by y?

starts :: ComparativePredicateOf (i a)

Does x start y? Is x started by y?

startedBy :: ComparativePredicateOf (i a)

Does x start y? Is x started by y?

precedes :: ComparativePredicateOf (i a)

Synonyms for starts and startedBy

precededBy :: ComparativePredicateOf (i a)

Synonyms for starts and startedBy

finishes :: ComparativePredicateOf (i a)

Does x finish y? Is x finished by y?

finishedBy :: ComparativePredicateOf (i a)

Does x finish y? Is x finished by y?

during :: ComparativePredicateOf (i a)

Is x during y? Does x contain y?

contains :: ComparativePredicateOf (i a)

Is x during y? Does x contain y?

unionPredicates :: [ComparativePredicateOf (i a)] -> ComparativePredicateOf (i a)

Compose a list of interval relations with _or_ to create a new ComparativePredicateOf i a. For example, unionPredicates [before, meets] creates a predicate function determining if one interval is either before or meets another interval.

(<|>) :: ComparativePredicateOf (i a) -> ComparativePredicateOf (i a) -> ComparativePredicateOf (i a)

Operator for composing the union of two predicates

disjointRelations :: Set (IntervalRelation (i a))

withinRelations :: Set (IntervalRelation (i a))

disjoint :: ComparativePredicateOf (i a)

Are x and y disjoint (before, after, meets, or metBy)?

notDisjoint :: ComparativePredicateOf (i a)

Are x and y not disjoint; i.e. do they share any support?

concur :: ComparativePredicateOf (i a)

A synonym for notDisjoint.

within :: ComparativePredicateOf (i a)

Is x entirely *within* the endpoints of y? That is, during, starts, finishes, or equals?

enclose :: ComparativePredicateOf (i a)

Does x enclose y? That is, is y within x?

enclosedBy :: ComparativePredicateOf (i a)

Synonym for within.

Instances

IntervalAlgebraic Interval Int

Defined in IntervalAlgebra

Methods

relate :: Interval Int -> Interval Int -> IntervalRelation (Interval Int)

predicate' :: IntervalRelation (Interval Int) -> ComparativePredicateOf (Interval Int)

predicates :: Set (IntervalRelation (Interval Int)) -> [ComparativePredicateOf (Interval Int)]

predicate :: Set (IntervalRelation (Interval Int)) -> ComparativePredicateOf (Interval Int)

toSet :: [IntervalRelation (Interval Int)] -> Set (IntervalRelation (Interval Int))

compose :: IntervalRelation (Interval Int) -> IntervalRelation (Interval Int) -> Set (IntervalRelation (Interval Int))

complement :: Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int))

intersection :: Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int))

union :: Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int))

converse :: Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int))

equals :: ComparativePredicateOf (Interval Int)

meets :: ComparativePredicateOf (Interval Int)

metBy :: ComparativePredicateOf (Interval Int)

before :: ComparativePredicateOf (Interval Int)

after :: ComparativePredicateOf (Interval Int)

overlaps :: ComparativePredicateOf (Interval Int)

overlappedBy :: ComparativePredicateOf (Interval Int)

starts :: ComparativePredicateOf (Interval Int)

startedBy :: ComparativePredicateOf (Interval Int)

precedes :: ComparativePredicateOf (Interval Int)

precededBy :: ComparativePredicateOf (Interval Int)

finishes :: ComparativePredicateOf (Interval Int)

finishedBy :: ComparativePredicateOf (Interval Int)

during :: ComparativePredicateOf (Interval Int)

contains :: ComparativePredicateOf (Interval Int)

unionPredicates :: [ComparativePredicateOf (Interval Int)] -> ComparativePredicateOf (Interval Int)

(<|>) :: ComparativePredicateOf (Interval Int) -> ComparativePredicateOf (Interval Int) -> ComparativePredicateOf (Interval Int)

disjointRelations :: Set (IntervalRelation (Interval Int))

withinRelations :: Set (IntervalRelation (Interval Int))

disjoint :: ComparativePredicateOf (Interval Int)

notDisjoint :: ComparativePredicateOf (Interval Int)

concur :: ComparativePredicateOf (Interval Int)

within :: ComparativePredicateOf (Interval Int)

enclose :: ComparativePredicateOf (Interval Int)

enclosedBy :: ComparativePredicateOf (Interval Int)

IntervalAlgebraic Interval Integer

Defined in IntervalAlgebra

Methods

relate :: Interval Integer -> Interval Integer -> IntervalRelation (Interval Integer)

predicate' :: IntervalRelation (Interval Integer) -> ComparativePredicateOf (Interval Integer)

predicates :: Set (IntervalRelation (Interval Integer)) -> [ComparativePredicateOf (Interval Integer)]

predicate :: Set (IntervalRelation (Interval Integer)) -> ComparativePredicateOf (Interval Integer)

toSet :: [IntervalRelation (Interval Integer)] -> Set (IntervalRelation (Interval Integer))

compose :: IntervalRelation (Interval Integer) -> IntervalRelation (Interval Integer) -> Set (IntervalRelation (Interval Integer))

complement :: Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer))

intersection :: Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer))

union :: Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer))

converse :: Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer))

equals :: ComparativePredicateOf (Interval Integer)

meets :: ComparativePredicateOf (Interval Integer)

metBy :: ComparativePredicateOf (Interval Integer)

before :: ComparativePredicateOf (Interval Integer)

after :: ComparativePredicateOf (Interval Integer)

overlaps :: ComparativePredicateOf (Interval Integer)

overlappedBy :: ComparativePredicateOf (Interval Integer)

starts :: ComparativePredicateOf (Interval Integer)

startedBy :: ComparativePredicateOf (Interval Integer)

precedes :: ComparativePredicateOf (Interval Integer)

precededBy :: ComparativePredicateOf (Interval Integer)

finishes :: ComparativePredicateOf (Interval Integer)

finishedBy :: ComparativePredicateOf (Interval Integer)

during :: ComparativePredicateOf (Interval Integer)

contains :: ComparativePredicateOf (Interval Integer)

unionPredicates :: [ComparativePredicateOf (Interval Integer)] -> ComparativePredicateOf (Interval Integer)

(<|>) :: ComparativePredicateOf (Interval Integer) -> ComparativePredicateOf (Interval Integer) -> ComparativePredicateOf (Interval Integer)

disjointRelations :: Set (IntervalRelation (Interval Integer))

withinRelations :: Set (IntervalRelation (Interval Integer))

disjoint :: ComparativePredicateOf (Interval Integer)

notDisjoint :: ComparativePredicateOf (Interval Integer)

concur :: ComparativePredicateOf (Interval Integer)

within :: ComparativePredicateOf (Interval Integer)

enclose :: ComparativePredicateOf (Interval Integer)

enclosedBy :: ComparativePredicateOf (Interval Integer)

IntervalAlgebraic Interval Day

Defined in IntervalAlgebra

Methods

relate :: Interval Day -> Interval Day -> IntervalRelation (Interval Day)

predicate' :: IntervalRelation (Interval Day) -> ComparativePredicateOf (Interval Day)

predicates :: Set (IntervalRelation (Interval Day)) -> [ComparativePredicateOf (Interval Day)]

predicate :: Set (IntervalRelation (Interval Day)) -> ComparativePredicateOf (Interval Day)

toSet :: [IntervalRelation (Interval Day)] -> Set (IntervalRelation (Interval Day))

compose :: IntervalRelation (Interval Day) -> IntervalRelation (Interval Day) -> Set (IntervalRelation (Interval Day))

complement :: Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day))

intersection :: Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day))

union :: Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day))

converse :: Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day))

equals :: ComparativePredicateOf (Interval Day)

meets :: ComparativePredicateOf (Interval Day)

metBy :: ComparativePredicateOf (Interval Day)

before :: ComparativePredicateOf (Interval Day)

after :: ComparativePredicateOf (Interval Day)

overlaps :: ComparativePredicateOf (Interval Day)

overlappedBy :: ComparativePredicateOf (Interval Day)

starts :: ComparativePredicateOf (Interval Day)

startedBy :: ComparativePredicateOf (Interval Day)

precedes :: ComparativePredicateOf (Interval Day)

precededBy :: ComparativePredicateOf (Interval Day)

finishes :: ComparativePredicateOf (Interval Day)

finishedBy :: ComparativePredicateOf (Interval Day)

during :: ComparativePredicateOf (Interval Day)

contains :: ComparativePredicateOf (Interval Day)

unionPredicates :: [ComparativePredicateOf (Interval Day)] -> ComparativePredicateOf (Interval Day)

(<|>) :: ComparativePredicateOf (Interval Day) -> ComparativePredicateOf (Interval Day) -> ComparativePredicateOf (Interval Day)

disjointRelations :: Set (IntervalRelation (Interval Day))

withinRelations :: Set (IntervalRelation (Interval Day))

disjoint :: ComparativePredicateOf (Interval Day)

notDisjoint :: ComparativePredicateOf (Interval Day)

concur :: ComparativePredicateOf (Interval Day)

within :: ComparativePredicateOf (Interval Day)

enclose :: ComparativePredicateOf (Interval Day)

enclosedBy :: ComparativePredicateOf (Interval Day)

Eq b => IntervalAlgebraic (PairedInterval b) Int

Defined in IntervalAlgebra.PairedInterval

Methods

relate :: PairedInterval b Int -> PairedInterval b Int -> IntervalRelation (PairedInterval b Int)

predicate' :: IntervalRelation (PairedInterval b Int) -> ComparativePredicateOf (PairedInterval b Int)

predicates :: Set (IntervalRelation (PairedInterval b Int)) -> [ComparativePredicateOf (PairedInterval b Int)]

predicate :: Set (IntervalRelation (PairedInterval b Int)) -> ComparativePredicateOf (PairedInterval b Int)

toSet :: [IntervalRelation (PairedInterval b Int)] -> Set (IntervalRelation (PairedInterval b Int))

compose :: IntervalRelation (PairedInterval b Int) -> IntervalRelation (PairedInterval b Int) -> Set (IntervalRelation (PairedInterval b Int))

complement :: Set (IntervalRelation (PairedInterval b Int)) -> Set (IntervalRelation (PairedInterval b Int))

intersection :: Set (IntervalRelation (PairedInterval b Int)) -> Set (IntervalRelation (PairedInterval b Int)) -> Set (IntervalRelation (PairedInterval b Int))

union :: Set (IntervalRelation (PairedInterval b Int)) -> Set (IntervalRelation (PairedInterval b Int)) -> Set (IntervalRelation (PairedInterval b Int))

converse :: Set (IntervalRelation (PairedInterval b Int)) -> Set (IntervalRelation (PairedInterval b Int))

equals :: ComparativePredicateOf (PairedInterval b Int)

meets :: ComparativePredicateOf (PairedInterval b Int)

metBy :: ComparativePredicateOf (PairedInterval b Int)

before :: ComparativePredicateOf (PairedInterval b Int)

after :: ComparativePredicateOf (PairedInterval b Int)

overlaps :: ComparativePredicateOf (PairedInterval b Int)

overlappedBy :: ComparativePredicateOf (PairedInterval b Int)

starts :: ComparativePredicateOf (PairedInterval b Int)

startedBy :: ComparativePredicateOf (PairedInterval b Int)

precedes :: ComparativePredicateOf (PairedInterval b Int)

precededBy :: ComparativePredicateOf (PairedInterval b Int)

finishes :: ComparativePredicateOf (PairedInterval b Int)

finishedBy :: ComparativePredicateOf (PairedInterval b Int)

during :: ComparativePredicateOf (PairedInterval b Int)

contains :: ComparativePredicateOf (PairedInterval b Int)

unionPredicates :: [ComparativePredicateOf (PairedInterval b Int)] -> ComparativePredicateOf (PairedInterval b Int)

(<|>) :: ComparativePredicateOf (PairedInterval b Int) -> ComparativePredicateOf (PairedInterval b Int) -> ComparativePredicateOf (PairedInterval b Int)

disjointRelations :: Set (IntervalRelation (PairedInterval b Int))

withinRelations :: Set (IntervalRelation (PairedInterval b Int))

disjoint :: ComparativePredicateOf (PairedInterval b Int)

notDisjoint :: ComparativePredicateOf (PairedInterval b Int)

concur :: ComparativePredicateOf (PairedInterval b Int)

within :: ComparativePredicateOf (PairedInterval b Int)

enclose :: ComparativePredicateOf (PairedInterval b Int)

enclosedBy :: ComparativePredicateOf (PairedInterval b Int)

class (IntervalAlgebraic Interval a, Show a) => IntervalCombinable a where

The IntervalCombinable typeclass provides methods for (possibly) combining two Intervals.

Minimal complete definition

Nothing

Methods

(.+.) :: Interval a -> Interval a -> Maybe (Interval a)

Maybe form a new Interval by the union of two Intervals that meets.

(><) :: Interval a -> Interval a -> Maybe (Interval a)

If x is before y, then form a new Just Interval a from the interval in the "gap" between x and y from the end of x to the begin of y. Otherwise, Nothing.

(<+>) :: (Semigroup (f (Interval a)), Applicative f) => Interval a -> Interval a -> f (Interval a)

If x is before y, return f x appended to f y. Otherwise, return extenterval of x and y (wrapped in f). This is useful for (left) folding over an *ordered* container of Intervals and combining intervals when x is *not* before y.

intersect :: Interval a -> Interval a -> Maybe (Interval a)

Forms a Just new interval from the intersection of two intervals, provided the intervals are not disjoint.

Instances

IntervalCombinable Int

Defined in IntervalAlgebra

Methods

(.+.) :: Interval Int -> Interval Int -> Maybe (Interval Int)

(><) :: Interval Int -> Interval Int -> Maybe (Interval Int)

(<+>) :: (Semigroup (f (Interval Int)), Applicative f) => Interval Int -> Interval Int -> f (Interval Int)

intersect :: Interval Int -> Interval Int -> Maybe (Interval Int)

IntervalCombinable Integer

Defined in IntervalAlgebra

Methods

(.+.) :: Interval Integer -> Interval Integer -> Maybe (Interval Integer)

(><) :: Interval Integer -> Interval Integer -> Maybe (Interval Integer)

(<+>) :: (Semigroup (f (Interval Integer)), Applicative f) => Interval Integer -> Interval Integer -> f (Interval Integer)

intersect :: Interval Integer -> Interval Integer -> Maybe (Interval Integer)

IntervalCombinable Day

Defined in IntervalAlgebra

Methods

(.+.) :: Interval Day -> Interval Day -> Maybe (Interval Day)

(><) :: Interval Day -> Interval Day -> Maybe (Interval Day)

(<+>) :: (Semigroup (f (Interval Day)), Applicative f) => Interval Day -> Interval Day -> f (Interval Day)

intersect :: Interval Day -> Interval Day -> Maybe (Interval Day)

class (Show a, Ord a, Num b, Ord b) => IntervalSizeable a b | a -> b where

The IntervalSizeable typeclass provides functions to determine the size of an Intervallic type and to resize an 'Interval a'.

Minimal complete definition

add, diff

Methods

moment :: b

The smallest duration for an 'Interval a'.

moment' :: Intervallic i a => i a -> b

Gives back a moment based on the input's type.

duration :: Intervallic i a => i a -> b

Determine the duration of an 'i a'.

add :: b -> a -> a

Shifts an a. Most often, the b will be the same type as a. But for example, if a is Day then b could be Int.

diff :: a -> a -> b

Takes the difference between two a to return a b.

Instances

IntervalSizeable Int Int

Defined in IntervalAlgebra

Methods

moment :: Int

moment' :: Intervallic i Int => i Int -> Int

duration :: Intervallic i Int => i Int -> Int

add :: Int -> Int -> Int

diff :: Int -> Int -> Int

IntervalSizeable Integer Integer

Defined in IntervalAlgebra

Methods

moment :: Integer

moment' :: Intervallic i Integer => i Integer -> Integer

duration :: Intervallic i Integer => i Integer -> Integer

add :: Integer -> Integer -> Integer

diff :: Integer -> Integer -> Integer

IntervalSizeable Day Integer

Defined in IntervalAlgebra

Methods

moment :: Integer

moment' :: Intervallic i Day => i Day -> Integer

duration :: Intervallic i Day => i Day -> Integer

add :: Integer -> Day -> Day

diff :: Day -> Day -> Integer

Types

data Interval a

An Interval a is a pair of as \( (x, y) \text{ where } x < y\). The Intervallic class provides a safe parseInterval function that returns a Left error if \(y < x\) and unsafeInterval as constructor for creating an interval that may not be valid.

Instances

IntervalAlgebraic Interval Int

Defined in IntervalAlgebra

Methods

relate :: Interval Int -> Interval Int -> IntervalRelation (Interval Int)

predicate' :: IntervalRelation (Interval Int) -> ComparativePredicateOf (Interval Int)

predicates :: Set (IntervalRelation (Interval Int)) -> [ComparativePredicateOf (Interval Int)]

predicate :: Set (IntervalRelation (Interval Int)) -> ComparativePredicateOf (Interval Int)

toSet :: [IntervalRelation (Interval Int)] -> Set (IntervalRelation (Interval Int))

compose :: IntervalRelation (Interval Int) -> IntervalRelation (Interval Int) -> Set (IntervalRelation (Interval Int))

complement :: Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int))

intersection :: Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int))

union :: Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int))

converse :: Set (IntervalRelation (Interval Int)) -> Set (IntervalRelation (Interval Int))

equals :: ComparativePredicateOf (Interval Int)

meets :: ComparativePredicateOf (Interval Int)

metBy :: ComparativePredicateOf (Interval Int)

before :: ComparativePredicateOf (Interval Int)

after :: ComparativePredicateOf (Interval Int)

overlaps :: ComparativePredicateOf (Interval Int)

overlappedBy :: ComparativePredicateOf (Interval Int)

starts :: ComparativePredicateOf (Interval Int)

startedBy :: ComparativePredicateOf (Interval Int)

precedes :: ComparativePredicateOf (Interval Int)

precededBy :: ComparativePredicateOf (Interval Int)

finishes :: ComparativePredicateOf (Interval Int)

finishedBy :: ComparativePredicateOf (Interval Int)

during :: ComparativePredicateOf (Interval Int)

contains :: ComparativePredicateOf (Interval Int)

unionPredicates :: [ComparativePredicateOf (Interval Int)] -> ComparativePredicateOf (Interval Int)

(<|>) :: ComparativePredicateOf (Interval Int) -> ComparativePredicateOf (Interval Int) -> ComparativePredicateOf (Interval Int)

disjointRelations :: Set (IntervalRelation (Interval Int))

withinRelations :: Set (IntervalRelation (Interval Int))

disjoint :: ComparativePredicateOf (Interval Int)

notDisjoint :: ComparativePredicateOf (Interval Int)

concur :: ComparativePredicateOf (Interval Int)

within :: ComparativePredicateOf (Interval Int)

enclose :: ComparativePredicateOf (Interval Int)

enclosedBy :: ComparativePredicateOf (Interval Int)

IntervalAlgebraic Interval Integer

Defined in IntervalAlgebra

Methods

relate :: Interval Integer -> Interval Integer -> IntervalRelation (Interval Integer)

predicate' :: IntervalRelation (Interval Integer) -> ComparativePredicateOf (Interval Integer)

predicates :: Set (IntervalRelation (Interval Integer)) -> [ComparativePredicateOf (Interval Integer)]

predicate :: Set (IntervalRelation (Interval Integer)) -> ComparativePredicateOf (Interval Integer)

toSet :: [IntervalRelation (Interval Integer)] -> Set (IntervalRelation (Interval Integer))

compose :: IntervalRelation (Interval Integer) -> IntervalRelation (Interval Integer) -> Set (IntervalRelation (Interval Integer))

complement :: Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer))

intersection :: Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer))

union :: Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer))

converse :: Set (IntervalRelation (Interval Integer)) -> Set (IntervalRelation (Interval Integer))

equals :: ComparativePredicateOf (Interval Integer)

meets :: ComparativePredicateOf (Interval Integer)

metBy :: ComparativePredicateOf (Interval Integer)

before :: ComparativePredicateOf (Interval Integer)

after :: ComparativePredicateOf (Interval Integer)

overlaps :: ComparativePredicateOf (Interval Integer)

overlappedBy :: ComparativePredicateOf (Interval Integer)

starts :: ComparativePredicateOf (Interval Integer)

startedBy :: ComparativePredicateOf (Interval Integer)

precedes :: ComparativePredicateOf (Interval Integer)

precededBy :: ComparativePredicateOf (Interval Integer)

finishes :: ComparativePredicateOf (Interval Integer)

finishedBy :: ComparativePredicateOf (Interval Integer)

during :: ComparativePredicateOf (Interval Integer)

contains :: ComparativePredicateOf (Interval Integer)

unionPredicates :: [ComparativePredicateOf (Interval Integer)] -> ComparativePredicateOf (Interval Integer)

(<|>) :: ComparativePredicateOf (Interval Integer) -> ComparativePredicateOf (Interval Integer) -> ComparativePredicateOf (Interval Integer)

disjointRelations :: Set (IntervalRelation (Interval Integer))

withinRelations :: Set (IntervalRelation (Interval Integer))

disjoint :: ComparativePredicateOf (Interval Integer)

notDisjoint :: ComparativePredicateOf (Interval Integer)

concur :: ComparativePredicateOf (Interval Integer)

within :: ComparativePredicateOf (Interval Integer)

enclose :: ComparativePredicateOf (Interval Integer)

enclosedBy :: ComparativePredicateOf (Interval Integer)

IntervalAlgebraic Interval Day

Defined in IntervalAlgebra

Methods

relate :: Interval Day -> Interval Day -> IntervalRelation (Interval Day)

predicate' :: IntervalRelation (Interval Day) -> ComparativePredicateOf (Interval Day)

predicates :: Set (IntervalRelation (Interval Day)) -> [ComparativePredicateOf (Interval Day)]

predicate :: Set (IntervalRelation (Interval Day)) -> ComparativePredicateOf (Interval Day)

toSet :: [IntervalRelation (Interval Day)] -> Set (IntervalRelation (Interval Day))

compose :: IntervalRelation (Interval Day) -> IntervalRelation (Interval Day) -> Set (IntervalRelation (Interval Day))

complement :: Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day))

intersection :: Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day))

union :: Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day))

converse :: Set (IntervalRelation (Interval Day)) -> Set (IntervalRelation (Interval Day))

equals :: ComparativePredicateOf (Interval Day)

meets :: ComparativePredicateOf (Interval Day)

metBy :: ComparativePredicateOf (Interval Day)

before :: ComparativePredicateOf (Interval Day)

after :: ComparativePredicateOf (Interval Day)

overlaps :: ComparativePredicateOf (Interval Day)

overlappedBy :: ComparativePredicateOf (Interval Day)

starts :: ComparativePredicateOf (Interval Day)

startedBy :: ComparativePredicateOf (Interval Day)

precedes :: ComparativePredicateOf (Interval Day)

precededBy :: ComparativePredicateOf (Interval Day)

finishes :: ComparativePredicateOf (Interval Day)

finishedBy :: ComparativePredicateOf (Interval Day)

during :: ComparativePredicateOf (Interval Day)

contains :: ComparativePredicateOf (Interval Day)

unionPredicates :: [ComparativePredicateOf (Interval Day)] -> ComparativePredicateOf (Interval Day)

(<|>) :: ComparativePredicateOf (Interval Day) -> ComparativePredicateOf (Interval Day) -> ComparativePredicateOf (Interval Day)

disjointRelations :: Set (IntervalRelation (Interval Day))

withinRelations :: Set (IntervalRelation (Interval Day))

disjoint :: ComparativePredicateOf (Interval Day)

notDisjoint :: ComparativePredicateOf (Interval Day)

concur :: ComparativePredicateOf (Interval Day)

within :: ComparativePredicateOf (Interval Day)

enclose :: ComparativePredicateOf (Interval Day)

enclosedBy :: ComparativePredicateOf (Interval Day)

(Ord a, Show a) => Intervallic Interval a

Defined in IntervalAlgebra

Methods

getInterval :: Interval a -> Interval a

setInterval :: Interval a -> Interval a -> Interval a

begin :: Interval a -> a

end :: Interval a -> a

Eq a => Eq (Interval a)

Defined in IntervalAlgebra

Methods

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

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

(Eq (Interval a), Intervallic Interval a) => Ord (Interval a)

Imposes a total ordering on Interval a based on first ordering the begins then the ends.

Defined in IntervalAlgebra

Methods

compare :: Interval a -> Interval a -> Ordering

(<) :: Interval a -> Interval a -> Bool

(<=) :: Interval a -> Interval a -> Bool

(>) :: Interval a -> Interval a -> Bool

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

max :: Interval a -> Interval a -> Interval a

min :: Interval a -> Interval a -> Interval a

(Intervallic Interval a, Show a) => Show (Interval a)

Defined in IntervalAlgebra

Methods

showsPrec :: Int -> Interval a -> ShowS

show :: Interval a -> String

showList :: [Interval a] -> ShowS

Arbitrary (Interval Int)

Defined in IntervalAlgebra.Arbitrary

Methods

arbitrary :: Gen (Interval Int)

shrink :: Interval Int -> [Interval Int]

Arbitrary (Interval Day)

Defined in IntervalAlgebra.Arbitrary

Methods

arbitrary :: Gen (Interval Day)

shrink :: Interval Day -> [Interval Day]

parseInterval :: (Show a, Ord a) => a -> a -> Either String (Interval a)

Safely parse a pair of as to create an Interval a.

unsafeInterval :: a -> a -> Interval a

Create a new Interval a. This function is not safe as it does not enforce that \(x < y\). Use with caution. It is meant to be helper function in early prototyping of this package. This function may be deprecated in future releases.

data IntervalRelation a

The IntervalRelation type enumerates the thirteen possible ways that two Interval a objects can relate according to the interval algebra.

Meets, Metby

x `meets` y
y `metBy` x

x: |-----|
y:       |-----| 

Before, After

x `before` y
y `after` x

x: |-----|  
y:          |-----|

Overlaps, OverlappedBy

x `overlaps` y
y `overlappedBy` x

x: |-----|
y:     |-----|

Starts, StartedBy

x `starts` y
y `startedBy` x

x: |---| 
y: |-----|

Finishes, FinishedBy

x `finishes` y
y `finishedBy` x

x:   |---| 
y: |-----|

During, Contains

x `during` y
y `contains` x

x:   |-| 
y: |-----|

Equal

x `equal` y
y `equal` x

x: |-----| 
y: |-----|

Constructors

Meets

MetBy

Before

After

Overlaps

OverlappedBy

Starts

StartedBy

Finishes

FinishedBy

During

Contains

Equals

Instances

Bounded (IntervalRelation a)

Defined in IntervalAlgebra

Methods

minBound :: IntervalRelation a

maxBound :: IntervalRelation a

Enum (IntervalRelation a)

Defined in IntervalAlgebra

Methods

succ :: IntervalRelation a -> IntervalRelation a

pred :: IntervalRelation a -> IntervalRelation a

toEnum :: Int -> IntervalRelation a

fromEnum :: IntervalRelation a -> Int

enumFrom :: IntervalRelation a -> [IntervalRelation a]

enumFromThen :: IntervalRelation a -> IntervalRelation a -> [IntervalRelation a]

enumFromTo :: IntervalRelation a -> IntervalRelation a -> [IntervalRelation a]

enumFromThenTo :: IntervalRelation a -> IntervalRelation a -> IntervalRelation a -> [IntervalRelation a]

Eq (IntervalRelation a)

Defined in IntervalAlgebra

Methods

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

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

Ord (IntervalRelation a)

Defined in IntervalAlgebra

Methods

compare :: IntervalRelation a -> IntervalRelation a -> Ordering

(<) :: IntervalRelation a -> IntervalRelation a -> Bool

(<=) :: IntervalRelation a -> IntervalRelation a -> Bool

(>) :: IntervalRelation a -> IntervalRelation a -> Bool

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

max :: IntervalRelation a -> IntervalRelation a -> IntervalRelation a

min :: IntervalRelation a -> IntervalRelation a -> IntervalRelation a

Read (IntervalRelation a)

Defined in IntervalAlgebra

Methods

readsPrec :: Int -> ReadS (IntervalRelation a)

readList :: ReadS [IntervalRelation a]

readPrec :: ReadPrec (IntervalRelation a)

readListPrec :: ReadPrec [IntervalRelation a]

Show (IntervalRelation a)

Defined in IntervalAlgebra

Methods

showsPrec :: Int -> IntervalRelation a -> ShowS

show :: IntervalRelation a -> String

showList :: [IntervalRelation a] -> ShowS

type ComparativePredicateOf a = a -> a -> Bool

Defines a predicate of two objects of type a.

Functions for creating new intervals from existing

expand :: (IntervalSizeable a b, Intervallic i a) => b -> b -> i a -> i a

Resize an 'i a' to by expanding to "left" by l and to the "right" by r. In the case that l or r are less than a moment the respective endpoints are unchanged.

expandl :: (IntervalSizeable a b, Intervallic i a) => b -> i a -> i a

Expands an 'i a' to left by i.

expandr :: (IntervalSizeable a b, Intervallic i a) => b -> i a -> i a

Expands an 'i a' to right by i.

beginerval :: IntervalSizeable a b => b -> a -> Interval a

Safely creates an 'Interval a' using x as the begin and adding max moment dur to x as the end.

enderval :: IntervalSizeable a b => b -> a -> Interval a

Safely creates an 'Interval a' using x as the end and adding negate max moment dur to x as the begin.

extenterval :: IntervalAlgebraic i a => i a -> i a -> Interval a

Creates a new Interval spanning the extent x and y.