inRange -package:clay

Returns True the given subscript lies in the range defined the bounding pair.

>>> inRange ('a','z') 'e'
True

>>> inRange ('x','z') 'a'
False

limit (lower,upper) x checks whether x is in the range from lower to upper. Don't expect a sensible result for lower>upper.

Returns True the given subscript lies in the range defined the bounding pair.

Returns True the given subscript lies in the range defined the bounding pair.

Check whether an index is within the given range.

Is the value within the allowed inclusive range?

Check whether value in range. Have default implementation. Should satisfy: inRange b x ⇔ toIndex b x ∈ [0,nBins b)

Generate value in the specified range

Given a range and a value it will tell you wether or not the value is in the range. Remember that all ranges are inclusive. The primary value of this library is performance and this method can be used to show this quite clearly. For example, you can try and approximate basic range functionality with "Data.List.elem" so we can generate an apples to apples comparison in GHCi:

>>> :set +s

>>> elem (10000000 :: Integer) [1..10000000]
True
(0.26 secs, 720,556,888 bytes)

>>> inRange (1 +=+ 10000000) (10000000 :: Integer)
True
(0.00 secs, 557,656 bytes)

>>> 

As you can see, this function is significantly more performant, in both speed and memory, than using the elem function.

Finds all point-value pairs in a KdMap with points within a given range, where the range is specified as a set of lower and upper bounds. Points are not returned in any particular order. Worst case time complexity: O(n) for n data points and a range that spans all the points.

Finds all point-value pairs in a KdMap with points within a given range, where the range is specified as a set of lower and upper bounds. Points are not returned in any particular order. Worst case time complexity: O(n) for n data points and a range that spans all the points. TODO: Maybe use known bounds on entire tree structure to be able to automatically count whole portions of tree as being within given range.

Finds all points in a KdTree with points within a given range, where the range is specified as a set of lower and upper bounds. Points are not returned in any particular order. Worst case time complexity: O(n) for n data points and a range that spans all the points.

Tests if a given range contains a particular value.

Makes a wizard fail if it gets an ordered quantity outside of the given range.

Given a list of ranges this function tells you if a value is in any of those ranges. This is especially useful for more complex ranges.

Tests if any of the ranges contains a particular value.

A notion of (inclusive) ranges prescribed to a. Ranges are symmetric:

isInRange (lo, hi) x == isInRange (hi, lo) x

Ranges include their endpoints:

isInRange (lo, hi) lo == True

When endpoints coincide, there is nothing else:

isInRange (x, x) y == x == y

Endpoints are endpoints:

isInRange (lo, hi) x ==>
isInRange (lo, x) hi == x == hi

Ranges are transitive relations:

isInRange (lo, hi) lo' && isInRange (lo, hi) hi' && isInRange (lo', hi') x
==> isInRange (lo, hi) x

There is a default implementation of isInRange via Generic. Other helper function that can be used for implementing this function are isInRangeOrd and isInRangeEnum. Note that the isRange method from Data.Ix is not a suitable default implementation of isInRange. Unlike isInRange, isRange is not required to be symmetric, and many isRange implementations are not symmetric in practice.