Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x8fef28d2026-11-02Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02

Modulebase-4.23.0.0Haskell2010

Data.Type.Ord

Basic operations on type-level Orderings.

Synopsis

family Compare
data OrderingI
type <=
type <=?
type >=
type >=?
type >
type >?
type <
type <?
type Max
type Min
family OrdCond

Packagebase-4.23.0.0
Exports13
LanguageHaskell2010
LicenceBSD-3-Clause
SourceOrd.hs

familytype family Compare (a :: k) (b :: k) :: Ordering

Compare branches on the kind of its arguments to either compare by Symbol or Nat.

Instances3Compare

type Compare a b = CmpChar a bDefined in ghc-internal-10.0.0 · GHC.Internal.Data.Type.Ord
type Compare a b = CmpSymbol a bDefined in ghc-internal-10.0.0 · GHC.Internal.Data.Type.Ord
type Compare a b = CmpNat a bDefined in ghc-internal-10.0.0 · GHC.Internal.Data.Type.Ord

datadata OrderingI (a :: k) (b :: k) where

Ordering data type for type literals that provides proof of their ordering.

Constructors

LTI :: Compare a b ~ 'LT => OrderingI a b
EQI :: Compare a a ~ 'EQ => OrderingI a a
GTI :: Compare a b ~ 'GT => OrderingI a b

Instances2Eq, Show

Eq (OrderingI a b)Defined in ghc-internal-10.0.0 · GHC.Internal.Data.Type.Ord
Show (OrderingI a b)Defined in ghc-internal-10.0.0 · GHC.Internal.Data.Type.Ord

typetype (<=) (x :: t) (y :: t) = Assert (x <=? y) (LeErrMsg x y)

Comparison (<=) of comparable types, as a constraint.

typetype (<=?) (m :: k) (n :: k) = OrdCond (Compare m n) 'True 'True 'False

Comparison (<=) of comparable types, as a function.

typetype (>=) (x :: t) (y :: t) = Assert (x >=? y) (GeErrMsg x y)

Comparison (>=) of comparable types, as a constraint.

typetype (>=?) (m :: k) (n :: k) = OrdCond (Compare m n) 'False 'True 'True

Comparison (>=) of comparable types, as a function.

typetype (>) (x :: t) (y :: t) = Assert (x >? y) (GtErrMsg x y)

Comparison (>) of comparable types, as a constraint.

typetype (>?) (m :: k) (n :: k) = OrdCond (Compare m n) 'False 'False 'True

Comparison (>) of comparable types, as a function.

typetype (<) (x :: t) (y :: t) = Assert (x <? y) (LtErrMsg x y)

Comparison (<) of comparable types, as a constraint.

typetype (<?) (m :: k) (n :: k) = OrdCond (Compare m n) 'True 'False 'False

Comparison (<) of comparable types, as a function.

typetype Max (m :: k) (n :: k) = OrdCond (Compare m n) n n m

Maximum between two comparable types.

typetype Min (m :: k) (n :: k) = OrdCond (Compare m n) m m n

Minimum between two comparable types.

familytype family OrdCond (o :: Ordering) (lt :: k) (eq :: k) (gt :: k) :: k where

A case statement on Ordering.

OrdCond c l e g is l when c ~ LT, e when c ~ EQ, and g when c ~ GT.

Equations

OrdCond 'LT lt eq gt = lt
OrdCond 'EQ lt eq gt = eq
OrdCond 'GT lt eq gt = gt