robertmassaioli / range

The repository for the Haskell range library: https://hackage.haskell.org/package/range

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

range - by Robert Massaioli

build-status haskell

The range library is written in Haskell and it's purpose is to make it easy to deal with ranges. For example you may have the following ranges:

1-4, 6-23, 15-50, 90-

And you are given a value x, how do you know if the value x is in those ranges? That is the question that this library answers. You just load your ranges using the library and then you can query to see if values exist inside your ranges. This library aims to be as efficient as light as possible while still being useful.

Example Code

Here is a small example program written using this library:

module Main where

import Data.Range.Range

putStatus :: Bool -> String -> IO ()
putStatus result test = putStrLn $ "[" ++ (show result) ++ "] " ++ test

main = do
    inRanges [SingletonRange 4]   4                         `putStatus` "Singletons Match"
    inRanges [0 +=+ 10] 7                                   `putStatus` "Value in Range"
    inRanges [LowerBoundRange (Bound 80 Inclusive)] 12345   `putStatus` "Value in Long Range"
    inRanges [InfiniteRange]      8287423                   `putStatus` "Value in Infinite Range"
    inRanges [lbi 50, 1 +=+ 30] 44                          `putStatus` "NOT in Composite Range (expect false)"

If you wish to see a better example in a real program then you should check out splitter.

Installation Instructions

You can install the range library in the standard way that you install any other Haskell library: using Cabal. I have uploaded this package to Hackage so you can get it by:

cabal install range

If you wish to install it from source then check out this repository and do the following:

cd /path/to/haskell/range
cabal install

You may also wish to work on this library in a development environment, in which case you should run:

cd /path/to/haskell/range
cabal-dev install

And that is all that there is to it. I hope you enjoy using this library and make great projects with it.

About

The repository for the Haskell range library: https://hackage.haskell.org/package/range

License:MIT License


Languages

Language:Haskell 100.0%