Data.Range

Documentation

data EndPoint a

Constructors

Open a

Closed a

Instances

Functor EndPoint

Foldable EndPoint

Traversable EndPoint

Eq a => Eq (EndPoint a)

Read a => Read (EndPoint a)

Show a => Show (EndPoint a)

isOpen :: EndPoint a -> Bool

isClosed :: EndPoint a -> Bool

unEndPoint :: Lens (EndPoint a) (EndPoint b) a b

data Range a

Constructors

Range

Fields

_lower :: EndPoint a

_upper :: EndPoint a

Instances

Functor Range

Foldable Range

Traversable Range

Eq a => Eq (Range a)

Read a => Read (Range a)

Show a => Show (Range a)

Ord a => IsIntersectableWith (Range a) (Range a)

type IntersectionOf (Range a) (Range a) = (:) * NoIntersection ((:) * (Range a) ([] *))

prettyShow :: Show a => Range a -> String

lower :: forall a. Lens' (Range a) (EndPoint a)

upper :: forall a. Lens' (Range a) (EndPoint a)

pattern OpenRange :: t -> t -> Range t

pattern ClosedRange :: t -> t -> Range t

pattern Range' :: EndPoint a -> EndPoint a -> Range a

A range from l to u, ignoring/forgetting the type of the enpoints

inRange :: Ord a => a -> Range a -> Bool

Test if a value lies in a range.

>>> 1 `inRange` (OpenRange 0 2)
True
>>> 1 `inRange` (OpenRange 0 1)
False
>>> 1 `inRange` (ClosedRange 0 1)
True
>>> 1 `inRange` (ClosedRange 1 1)
True
>>> 10 `inRange` (OpenRange 1 10)
False
>>> 10 `inRange` (ClosedRange 0 1)
False

width :: Num r => Range r -> r

Get the width of the interval

>>> width $ ClosedRange 1 10
9
>>> width $ OpenRange 5 10
5

clipLower :: Ord a => EndPoint a -> Range a -> Maybe (Range a)

Clip the interval from below. I.e. intersect with the interval {l,infty), where { is either open, (, orr closed, [.

clipUpper :: Ord a => EndPoint a -> Range a -> Maybe (Range a)

Clip the interval from above. I.e. intersect with (-infty, u}, where } is either open, ), or closed, ],

midPoint :: Fractional r => Range r -> r

isValid :: Ord a => Range a -> Bool

Check if the range is valid and nonEmpty, i.e. if the lower endpoint is indeed smaller than the right endpoint. Note that we treat empty open-ranges as invalid as well.

shiftLeft :: Num r => r -> Range r -> Range r

Shift a range x units to the left

>>> prettyShow $ shiftLeft 10 (ClosedRange 10 20)
"[0, 10]"
>>> prettyShow $ shiftLeft 10 (OpenRange 15 25)
"(5, 15)"

shiftRight :: Num r => r -> Range r -> Range r

Shifts the range to the right

>>> prettyShow $ shiftRight 10 (ClosedRange 10 20)
"[20, 30]"
>>> prettyShow $ shiftRight 10 (OpenRange 15 25)
"(25, 35)"