-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Utilities for Orderings
--   
--   Utilities for Ordering values (the type returned by compare)
@package ordering-util
@version 0.1.3.1

module Data.Ordering

-- | Flip an <a>Ordering</a>
flipOrdering :: Ordering -> Ordering

-- | Replace the <a>EQ</a> case with another <a>Ordering</a>
ifEQ :: Ordering -> Ordering -> Ordering

-- | Clamp <a>LT</a> to <a>EQ</a>
noLT :: Ordering -> Ordering

-- | Clamp <a>GT</a> to <a>EQ</a>
noGT :: Ordering -> Ordering

-- | Check an <a>Ordering</a> represents less-or-equal
isLE :: Ordering -> Bool

-- | Check an <a>Ordering</a> represents not-equal
isNE :: Ordering -> Bool

-- | Check an <a>Ordering</a> represents greater-or-equal
isGE :: Ordering -> Bool

-- | Returns -1, 0, and 1 for <a>LT</a>, <a>EQ</a>, and <a>GT</a>,
--   respectively
toSign :: Num n => Ordering -> n

-- | Get an <a>Ordering</a> depending on the sign of a number
--   
--   Compares the number to 0
fromSign :: (Ord n, Num n) => n -> Ordering

-- | Adjust a number by a difference up, down, or not at all
adjustBy :: Num a => a -> Ordering -> a -> a
data Ordering
LT :: Ordering
EQ :: Ordering
GT :: Ordering