ordering-util-0.1.3.2: Utilities for Orderings
Safe HaskellSafe-Inferred
LanguageHaskell2010

Data.Ordering

Synopsis

Simple functions

flipOrdering :: Ordering -> Ordering Source #

Flip an Ordering

ifEQ :: Ordering -> Ordering -> Ordering Source #

Replace the EQ case with another Ordering

noLT :: Ordering -> Ordering Source #

Clamp LT to EQ

noGT :: Ordering -> Ordering Source #

Clamp GT to EQ

isLE :: Ordering -> Bool Source #

Check an Ordering represents less-or-equal

isNE :: Ordering -> Bool Source #

Check an Ordering represents not-equal

isGE :: Ordering -> Bool Source #

Check an Ordering represents greater-or-equal

toSign :: Num n => Ordering -> n Source #

Returns -1, 0, and 1 for LT, EQ, and GT, respectively

fromSign :: (Ord n, Num n) => n -> Ordering Source #

Get an Ordering depending on the sign of a number

Compares the number to 0

adjustBy :: Num a => a -> Ordering -> a -> a Source #

Adjust a number by a difference up, down, or not at all

Reexports from base

data Ordering #

Constructors

LT 
EQ 
GT 

Instances

Instances details
Monoid Ordering

Since: base-2.1

Instance details

Defined in GHC.Base

Methods

mempty :: Ordering #

mappend :: Ordering -> Ordering -> Ordering #

mconcat :: [Ordering] -> Ordering #

Semigroup Ordering

Since: base-4.9.0.0

Instance details

Defined in GHC.Base

Methods

(<>) :: Ordering -> Ordering -> Ordering #

sconcat :: NonEmpty Ordering -> Ordering #

stimes :: Integral b => b -> Ordering -> Ordering #

Bounded Ordering

Since: base-2.1

Instance details

Defined in GHC.Enum

Methods

minBound :: Ordering #

maxBound :: Ordering #

Enum Ordering

Since: base-2.1

Instance details

Defined in GHC.Enum

Methods

succ :: Ordering -> Ordering #

pred :: Ordering -> Ordering #

toEnum :: Int -> Ordering #

fromEnum :: Ordering -> Int #

enumFrom :: Ordering -> [Ordering] #

enumFromThen :: Ordering -> Ordering -> [Ordering] #

enumFromTo :: Ordering -> Ordering -> [Ordering] #

enumFromThenTo :: Ordering -> Ordering -> Ordering -> [Ordering] #

Read Ordering

Since: base-2.1

Instance details

Defined in GHC.Read

Methods

readsPrec :: Int -> ReadS Ordering #

readList :: ReadS [Ordering] #

readPrec :: ReadPrec Ordering #

readListPrec :: ReadPrec [Ordering] #

Show Ordering

Since: base-2.1

Instance details

Defined in GHC.Show

Methods

showsPrec :: Int -> Ordering -> ShowS #

show :: Ordering -> String #

showList :: [Ordering] -> ShowS #

Eq Ordering 
Instance details

Defined in GHC.Classes

Methods

(==) :: Ordering -> Ordering -> Bool #

(/=) :: Ordering -> Ordering -> Bool #

Ord Ordering 
Instance details

Defined in GHC.Classes

Methods

compare :: Ordering -> Ordering -> Ordering #

(<) :: Ordering -> Ordering -> Bool #

(<=) :: Ordering -> Ordering -> Bool #

(>) :: Ordering -> Ordering -> Bool #

(>=) :: Ordering -> Ordering -> Bool #

max :: Ordering -> Ordering -> Ordering #

min :: Ordering -> Ordering -> Ordering #