Data.IntervalMap.Generic.Interval

Type class for IntervalMap keys.

As there is no sensible default, no instances for prelude types are provided (E.g. you might want to have tuples as closed intervals in one case, and open in another).

Interval type

class Ord e => Interval i e | i -> e where

Intervals with endpoints of type e. A minimal instance declaration for a closed interval needs only to define lowerBound and upperBound.

Methods

lowerBound :: i -> e

lower bound

upperBound :: i -> e

upper bound

leftClosed :: i -> Bool

Does the interval include its lower bound? Default is True for all values, i.e. closed intervals.

rightClosed :: i -> Bool

Does the interval include its upper bound bound? Default is True for all values, i.e. closed intervals.

before :: i -> i -> Bool

Interval strictly before another? True if the upper bound of the first interval is below the lower bound of the second.

after :: i -> i -> Bool

Interval strictly after another? Same as 'flip before'.

subsumes :: i -> i -> Bool

Does the first interval completely contain the second?

overlaps :: i -> i -> Bool

Do the two intervals overlap?

below :: e -> i -> Bool

Is a point strictly less than lower bound?

above :: e -> i -> Bool

Is a point strictly greater than upper bound?

inside :: e -> i -> Bool

Does the interval contain a given point?

isEmpty :: i -> Bool

Is the interval empty?

Instances

Ord a => Interval (Interval a) a

helper functions for declaring Eq and Ord instances

genericEquals :: (Interval i e, Eq e) => i -> i -> Bool

genericCompare :: (Interval i e, Ord e) => i -> i -> Ordering