IntervalAlgebra.IntervalUtilities

Documentation

combineIntervals :: IntervalCombinable a => [Interval a] -> [Interval a]

Returns a list of intervals where any intervals that meet or share support are combined into one interval. *To work properly, the input list should be sorted*.

>>> combineIntervals [intInt 0 10, intInt 2 7, intInt 10 12, intInt 13 15]
[(0, 12),(13, 15)]

gaps :: IntervalCombinable a => [Interval a] -> [Interval a]

Returns a (possibly empty) list of intervals consisting of the gaps between intervals in the input list. *To work properly, the input list should be sorted*.

durations :: (Functor f, IntervalSizeable a b) => f (Interval a) -> f b

Returns the duration of each Interval in the Functor f.

>>> durations [intInt 1 10, intInt 2 12, intInt 5 6]
[9,10,1]

clip :: (IntervalAlgebraic a, IntervalSizeable a b) => Interval a -> Interval a -> Maybe (Interval a)

In the case that x y are not disjoint, clips y to the extent of x.

>>> clip (intInt 0 5) (intInt 3 6)
Just (3, 5)

>>> clip (intInt 0 3) (intInt 4 6)
Nothing

relations :: IntervalAlgebraic a => [Interval a] -> [IntervalRelation a]

Finds the IntervalRelation between each consecutive pair of intervals.

>>> relations [intInt 0 1, intInt 1 2]
[Meets]

gapsWithin

Arguments

:: (IntervalSizeable a b, IntervalCombinable a, IntervalFilterable [] a)

=> Interval a

i

-> [Interval a]

x

-> [Interval a]

Applies gaps to all the non-disjoint intervals in x that are *not* disjoint from i. Intervals that overlaps or are overlappedBy i are clipped to i.

>>> gapsWithin (intInt 1 10) [intInt 0 5, intInt 7 9, intInt 12 15]
[(5, 7),(9, 10)]

emptyIf

Arguments

:: (Monoid (f (Interval a)), Foldable f, IntervalFilterable f a)

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

e.g. any or all

-> (Interval a -> Bool)

predicate to apply to each element of input list

-> f (Interval a)

-> f (Interval a)

Given a predicate combinator, a predicate, and list of intervals, returns the input unchanged if the predicate combinator is True. Otherwise, returns an empty list. See emptyIfAny and emptyIfNone for examples.

emptyIfNone

Arguments

:: (Monoid (f (Interval a)), Foldable f, IntervalFilterable f a)

=> (Interval a -> Bool)

predicate to apply to each element of input list

-> f (Interval a)

-> f (Interval a)

Returns the empty monoid structure if *none* of the element of input satisfy the predicate condition.

For example, the following returns the empty list because none of the intervals in the input list starts (3, 5).

>>> emptyIfNone (starts (intInt 3 5)) [intInt 3 4, intInt 5 6]
[]

In the following, (3, 5) starts (3, 6), so the input is returned.

>>> emptyIfNone (starts (intInt 3 5)) [intInt 3 6, intInt 5 6]
[(3, 6),(5, 6)]

emptyIfAny

Arguments

:: (Monoid (f (Interval a)), Foldable f, IntervalFilterable f a)

=> (Interval a -> Bool)

predicate to apply to each element of input list

-> f (Interval a)

-> f (Interval a)

Returns the empty monoid structure if *any* of the element of input satisfy the predicate condition

emptyIfAll

Arguments

:: (Monoid (f (Interval a)), Foldable f, IntervalFilterable f a)

=> (Interval a -> Bool)

predicate to apply to each element of input list

-> f (Interval a)

-> f (Interval a)

Returns the empty monoid structure if *all* of the element of input satisfy the predicate condition