Copyright | (C) Frank Staals |
---|---|

License | see the LICENSE file |

Maintainer | Frank Staals |

Safe Haskell | None |

Language | Haskell2010 |

Data type for representing Generic Ranges (Intervals) and functions that work with them.

## Synopsis

- data EndPoint a
- isOpen :: EndPoint a -> Bool
- isClosed :: EndPoint a -> Bool
- unEndPoint :: Lens (EndPoint a) (EndPoint b) a b
- data Range a = Range {}
- prettyShow :: Show a => Range a -> String
- lower :: forall a. Lens' (Range a) (EndPoint a)
- upper :: forall a. Lens' (Range a) (EndPoint a)
- pattern OpenRange :: a -> a -> Range a
- pattern ClosedRange :: a -> a -> Range a
- pattern Range' :: a -> a -> Range a
- inRange :: Ord a => a -> Range a -> Bool
- width :: Num r => Range r -> r
- clipLower :: Ord a => EndPoint a -> Range a -> Maybe (Range a)
- clipUpper :: Ord a => EndPoint a -> Range a -> Maybe (Range a)
- midPoint :: Fractional r => Range r -> r
- clampTo :: Ord r => Range r -> r -> r
- isValid :: Ord a => Range a -> Bool
- covers :: forall a. Ord a => Range a -> Range a -> Bool
- shiftLeft :: Num r => r -> Range r -> Range r
- shiftRight :: Num r => r -> Range r -> Range r

# Documentation

Endpoints of a range may either be open or closed.

## Instances

Data type for representing ranges.

## Instances

Functor Range Source # | |

Foldable Range Source # | |

Defined in Data.Range fold :: Monoid m => Range m -> m # foldMap :: Monoid m => (a -> m) -> Range a -> m # foldr :: (a -> b -> b) -> b -> Range a -> b # foldr' :: (a -> b -> b) -> b -> Range a -> b # foldl :: (b -> a -> b) -> b -> Range a -> b # foldl' :: (b -> a -> b) -> b -> Range a -> b # foldr1 :: (a -> a -> a) -> Range a -> a # foldl1 :: (a -> a -> a) -> Range a -> a # elem :: Eq a => a -> Range a -> Bool # maximum :: Ord a => Range a -> a # minimum :: Ord a => Range a -> a # | |

Traversable Range Source # | |

Eq a => Eq (Range a) Source # | |

Show a => Show (Range a) Source # | |

Generic (Range a) Source # | |

(Arbitrary r, Ord r) => Arbitrary (Range r) Source # | |

NFData a => NFData (Range a) Source # | |

Defined in Data.Range | |

Ord a => IsIntersectableWith (Range a) (Range a) Source # | |

Defined in Data.Range | |

type Rep (Range a) Source # | |

Defined in Data.Range type Rep (Range a) = D1 (MetaData "Range" "Data.Range" "hgeometry-combinatorial-0.11.0.0-Cktt0ZWYuCrAhHfx7XTJDd" False) (C1 (MetaCons "Range" PrefixI True) (S1 (MetaSel (Just "_lower") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (EndPoint a)) :*: S1 (MetaSel (Just "_upper") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (EndPoint a)))) | |

type IntersectionOf (Range a) (Range a) Source # | |

Defined in Data.Range |

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

Helper function to show a range in mathematical notation.

`>>>`

"(0,2)"`prettyShow $ OpenRange 0 2`

`>>>`

"[0,2]"`prettyShow $ ClosedRange 0 2`

`>>>`

"(0,5]"`prettyShow $ Range (Open 0) (Closed 5)`

pattern ClosedRange :: a -> a -> Range a Source #

pattern Range' :: a -> a -> Range a Source #

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

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

Test if a value lies in a range.

`>>>`

True`1 `inRange` (OpenRange 0 2)`

`>>>`

False`1 `inRange` (OpenRange 0 1)`

`>>>`

True`1 `inRange` (ClosedRange 0 1)`

`>>>`

True`1 `inRange` (ClosedRange 1 1)`

`>>>`

False`10 `inRange` (OpenRange 1 10)`

`>>>`

False`10 `inRange` (ClosedRange 0 1)`

This one is kind of weird

`>>>`

False`0 `inRange` Range (Closed 0) (Open 0)`

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

Get the width of the interval

`>>>`

9`width $ ClosedRange 1 10`

`>>>`

5`width $ OpenRange 5 10`

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

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) Source #

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

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

clampTo :: Ord r => Range r -> r -> r Source #

Clamps a value to a range. I.e. if the value lies outside the range we report the closest value "in the range". Note that if an endpoint of the range is open we report that value anyway, so we return a value that is truely inside the range only if that side of the range is closed.

`>>>`

10`clampTo (ClosedRange 0 10) 20`

`>>>`

0`clampTo (ClosedRange 0 10) (-20)`

`>>>`

5`clampTo (ClosedRange 0 10) 5`

`>>>`

10`clampTo (OpenRange 0 10) 20`

`>>>`

0`clampTo (OpenRange 0 10) (-20)`

`>>>`

5`clampTo (OpenRange 0 10) 5`

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

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.

covers :: forall a. Ord a => Range a -> Range a -> Bool Source #

Wether or not the first range completely covers the second one