Data.Range.NestedRange

Nested Ranges are common in practical usage. They appear in such forms as library version numbers ("Version 1.4.5.6" for example).

It is very useful to be able to compare these ranges to one another. This module exists for the purpose of allowing these comparisons between nested ranges. The module builds upon the basic range concept from other parts of this library.

Documentation

data NestedRange a

The Nested Range is a structure that in a nested form of many ranges where there can be multiple ranges at every level.

For example, saying that you require a minimum version of 1.2.3 could be represented as:

NestedRange [[LowerBoundRange 1],[LowerBoundRange 2],[LowerBoundRange 3]]

Constructors

NestedRange [[Range a]]

Instances

Eq a => Eq (NestedRange a)

Defined in Data.Range.NestedRange

Methods

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

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

Show a => Show (NestedRange a)

Defined in Data.Range.NestedRange

Methods

showsPrec :: Int -> NestedRange a -> ShowS

show :: NestedRange a -> String

showList :: [NestedRange a] -> ShowS

fromVersion :: (Int -> Range Int) -> Version -> NestedRange Int

This method converts the Data.Version datatype into a NestedRange.

For example:

ghci> fromVersion LowerBoundRange (Version [1, 2, 3] [])
NestedRange [[LowerBoundRange 1],[LowerBoundRange 2],[LowerBoundRange 3]]
(0.01 secs, 624,736 bytes)
ghci>

inNestedRange :: Ord a => [a] -> NestedRange a -> Bool

Given a list of nested values and a nested range tell us wether the nested value exists inside the nested range.

Examples

In a simple case:

ghci> inNestedRange [2, 8, 3] (NestedRange [[SpanRange 1 2]] :: NestedRange Integer)
True
(0.01 secs, 558,400 bytes)
ghci>

Not in the bounds:

ghci> inNestedRange [2, 8, 3] (NestedRange [[SpanRange 1 2], [UpperBoundRange 7]] :: NestedRange Integer)
False
(0.00 secs, 558,896 bytes)
ghci>

For something based on Data.Version:

ghci> version = Version [2, 8, 3] []
ghci> upperBound = Version [2, 7] []
ghci> inNestedRange (versionBranch version) (fromVersion UpperBoundRange upperBound)
False
ghci>
ghci> inNestedRange (versionBranch version) (fromVersion LowerBoundRange upperBound)
True
ghci>