Copyright	Copyright (c) 2007--2015 wren gayle romano
License	BSD3
Maintainer	wren@community.haskell.org
Stability	stable
Portability	semi-portable (OverlappingInstances,...)
Safe Haskell	Safe
Language	Haskell98

Data.Number.PartialOrd

Contents

Partial Ordering
Functions

Description

The Prelude's Ord class for dealing with ordered types is often onerous to use because it requires Eq as well as a total ordering. While such total orderings are common, partial orderings are more so. This module presents a class for partially ordered types.

Synopsis

Partial Ordering

class PartialOrd a where #

This class defines a partially ordered type. The method names were chosen so as not to conflict with Ord and Eq. We use Maybe instead of defining new types PartialOrdering and FuzzyBool because this way should make the class easier to use.

Minimum complete definition: cmp

Minimal complete definition

cmp

Methods

cmp :: a -> a -> Maybe Ordering #

like compare

gt :: a -> a -> Maybe Bool infix 4 #

like (>)

ge :: a -> a -> Maybe Bool infix 4 #

like (>=)

eq :: a -> a -> Maybe Bool infix 4 #

like (==)

ne :: a -> a -> Maybe Bool infix 4 #

like (/=)

le :: a -> a -> Maybe Bool infix 4 #

like (<=)

lt :: a -> a -> Maybe Bool infix 4 #

like (<)

maxPO :: a -> a -> Maybe a infix 4 #

like max. The default instance returns the left argument when they're equal.

minPO :: a -> a -> Maybe a infix 4 #

like min. The default instance returns the left argument when they're equal.

Instances

PartialOrd Double #
Methods cmp :: Double -> Double -> Maybe Ordering # gt :: Double -> Double -> Maybe Bool # ge :: Double -> Double -> Maybe Bool # eq :: Double -> Double -> Maybe Bool # ne :: Double -> Double -> Maybe Bool # le :: Double -> Double -> Maybe Bool # lt :: Double -> Double -> Maybe Bool # maxPO :: Double -> Double -> Maybe Double # minPO :: Double -> Double -> Maybe Double #
PartialOrd Float #
Methods cmp :: Float -> Float -> Maybe Ordering # gt :: Float -> Float -> Maybe Bool # ge :: Float -> Float -> Maybe Bool # eq :: Float -> Float -> Maybe Bool # ne :: Float -> Float -> Maybe Bool # le :: Float -> Float -> Maybe Bool # lt :: Float -> Float -> Maybe Bool # maxPO :: Float -> Float -> Maybe Float # minPO :: Float -> Float -> Maybe Float #
Ord a => PartialOrd a #
Methods cmp :: a -> a -> Maybe Ordering # gt :: a -> a -> Maybe Bool # ge :: a -> a -> Maybe Bool # eq :: a -> a -> Maybe Bool # ne :: a -> a -> Maybe Bool # le :: a -> a -> Maybe Bool # lt :: a -> a -> Maybe Bool # maxPO :: a -> a -> Maybe a # minPO :: a -> a -> Maybe a #
PartialOrd LogFloat #
Methods cmp :: LogFloat -> LogFloat -> Maybe Ordering # gt :: LogFloat -> LogFloat -> Maybe Bool # ge :: LogFloat -> LogFloat -> Maybe Bool # eq :: LogFloat -> LogFloat -> Maybe Bool # ne :: LogFloat -> LogFloat -> Maybe Bool # le :: LogFloat -> LogFloat -> Maybe Bool # lt :: LogFloat -> LogFloat -> Maybe Bool # maxPO :: LogFloat -> LogFloat -> Maybe LogFloat # minPO :: LogFloat -> LogFloat -> Maybe LogFloat #

Functions

comparingPO :: PartialOrd b => (a -> b) -> a -> a -> Maybe Ordering #

Like Data.Ord.comparing. Helpful in conjunction with the xxxBy family of functions from Data.List