typenums-0.1.3: Type level numbers using existing Nat functionality
Copyright(c) 2018-2021 Iris Ward
LicenseBSD3
Maintaineraditu.venyhandottir@gmail.com
Stabilityexperimental
Safe HaskellSafe
LanguageHaskell2010

Data.TypeNums

Description

This module provides a unified interface for natural numbers, signed integers, and rationals at the type level, in a way fully compatible with existing code using type-level naturals.

Natural numbers are expressed as always, e.g. 5. Negative integers are written as Neg 3. Ratios are written as 3 :% 2.

There are some naming conflicts between this module and GHC.TypeLits, notably the comparison and arithmetic operators. This module reexports Nat, KnownNat, natVal and natVal' so you may import just this module and not GHC.TypeLits.

If you wish to use other functionality from GHC.TypeLits, this package also provides the module Data.TypeLits that includes (almost) full functionality from GHC.TypeLits, but with the conflicts resolving in this packages favour.

Synopsis

Type level numbers

Naturals

data Nat #

(Kind) This is the kind of type-level natural numbers.

Instances

Instances details
KnownNat n => KnownInt (n :: Nat) Source # 
Instance details

Defined in Data.TypeNums.Ints

Methods

intSing :: SInt n

class KnownNat (n :: Nat) #

This class gives the integer associated with a type-level natural. There are instances of the class for every concrete literal: 0, 1, 2, etc.

Since: base-4.7.0.0

Minimal complete definition

natSing

natVal :: forall (n :: Nat) proxy. KnownNat n => proxy n -> Integer #

Since: base-4.7.0.0

natVal' :: forall (n :: Nat). KnownNat n => Proxy# n -> Integer #

Since: base-4.8.0.0

data SomeNat #

This type represents unknown type-level natural numbers.

Since: base-4.10.0.0

Constructors

KnownNat n => SomeNat (Proxy n) 

Instances

Instances details
Eq SomeNat

Since: base-4.7.0.0

Instance details

Defined in GHC.TypeNats

Methods

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

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

Ord SomeNat

Since: base-4.7.0.0

Instance details

Defined in GHC.TypeNats

Read SomeNat

Since: base-4.7.0.0

Instance details

Defined in GHC.TypeNats

Show SomeNat

Since: base-4.7.0.0

Instance details

Defined in GHC.TypeNats

someNatVal :: Integer -> Maybe SomeNat #

Convert an integer into an unknown type-level natural.

Since: base-4.7.0.0

Integers

data TInt Source #

(Kind) An integer that may be negative.

Constructors

Pos Nat 
Neg Nat 

Instances

Instances details
KnownNat n => KnownInt ('Pos n :: TInt) Source # 
Instance details

Defined in Data.TypeNums.Ints

Methods

intSing :: SInt ('Pos n)

KnownNat n => KnownInt ('Neg n :: TInt) Source # 
Instance details

Defined in Data.TypeNums.Ints

Methods

intSing :: SInt ('Neg n)

class KnownInt (n :: k) Source #

This class gives the (value-level) integer associated with a type-level integer. There are instances of this class for every concrete natural: 0, 1, 2, etc. There are also instances of this class for every negated natural, such as Neg 1.

Minimal complete definition

intSing

Instances

Instances details
KnownNat n => KnownInt (n :: Nat) Source # 
Instance details

Defined in Data.TypeNums.Ints

Methods

intSing :: SInt n

KnownNat n => KnownInt ('Pos n :: TInt) Source # 
Instance details

Defined in Data.TypeNums.Ints

Methods

intSing :: SInt ('Pos n)

KnownNat n => KnownInt ('Neg n :: TInt) Source # 
Instance details

Defined in Data.TypeNums.Ints

Methods

intSing :: SInt ('Neg n)

intVal :: forall n proxy. KnownInt n => proxy n -> Integer Source #

Get the value associated with a type-level integer

intVal' :: forall n. KnownInt n => Proxy# n -> Integer Source #

Get the value associated with a type-level integer. The difference between this function and intVal is that it takes a Proxy# parameter, which has zero runtime representation and so is entirely free.

data SomeInt Source #

This type represents unknown type-level integers.

Since: 0.1.1

Constructors

forall n.KnownInt n => SomeInt (Proxy n) 

Instances

Instances details
Eq SomeInt Source # 
Instance details

Defined in Data.TypeNums.Ints

Methods

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

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

Ord SomeInt Source # 
Instance details

Defined in Data.TypeNums.Ints

Read SomeInt Source # 
Instance details

Defined in Data.TypeNums.Ints

Show SomeInt Source # 
Instance details

Defined in Data.TypeNums.Ints

someIntVal :: Integer -> SomeInt Source #

Convert an integer into an unknown type-level integer.

Since: 0.1.1

Rationals

data Rat Source #

Type constructor for a rational

Constructors

forall k. k :% Nat 

Instances

Instances details
(KnownInt n, KnownNat d, d /= 0) => KnownRat (n :% d :: Rat) Source # 
Instance details

Defined in Data.TypeNums.Rats

Methods

ratSing :: SRat (n :% d)

(TypeError ('Text "Denominator must not equal 0") :: Constraint) => KnownRat (n :% 0 :: Rat) Source # 
Instance details

Defined in Data.TypeNums.Rats

Methods

ratSing :: SRat (n :% 0)

class KnownRat r Source #

This class gives the (value-level) rational associated with a type-level rational. There are instances of this class for every combination of a concrete integer and concrete natural.

Minimal complete definition

ratSing

Instances

Instances details
KnownInt n => KnownRat (n :: k) Source # 
Instance details

Defined in Data.TypeNums.Rats

Methods

ratSing :: SRat n

(KnownInt n, KnownNat d, d /= 0) => KnownRat (n :% d :: Rat) Source # 
Instance details

Defined in Data.TypeNums.Rats

Methods

ratSing :: SRat (n :% d)

(TypeError ('Text "Denominator must not equal 0") :: Constraint) => KnownRat (n :% 0 :: Rat) Source # 
Instance details

Defined in Data.TypeNums.Rats

Methods

ratSing :: SRat (n :% 0)

ratVal :: forall proxy r. KnownRat r => proxy r -> Rational Source #

Get the value associated with a type-level rational

ratVal' :: forall r. KnownRat r => Proxy# r -> Rational Source #

Get the value associated with a type-level rational. The difference between this function and ratVal is that it takes a Proxy# parameter, which has zero runtime representation and so is entirely free.

data SomeRat Source #

This type represents unknown type-level integers.

Since: 0.1.1

Constructors

forall r.KnownRat r => SomeRat (Proxy r) 

Instances

Instances details
Eq SomeRat Source # 
Instance details

Defined in Data.TypeNums.Rats

Methods

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

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

Ord SomeRat Source # 
Instance details

Defined in Data.TypeNums.Rats

Read SomeRat Source # 
Instance details

Defined in Data.TypeNums.Rats

Show SomeRat Source # 
Instance details

Defined in Data.TypeNums.Rats

someRatVal :: Rational -> SomeRat Source #

Convert a rational into an unknown type-level rational.

Since: 0.1.1

Type level numerical operations

Comparisons

type (==?) (a :: k) (b :: k) = (==) a b infix 4 Source #

Boolean type-level equals. Useful for e.g. If (x ==? 0)

type (/=?) (a :: k) (b :: k) = Not ((==) a b) infix 4 Source #

Boolean type-level not-equals.

type (==) (a :: k) (b :: k) = (==) a b ~ 'True infix 4 Source #

Equality constraint, used as e.g. (x == 3) => _

type (/=) (a :: k) (b :: k) = (==) a b ~ 'False infix 4 Source #

Not-equal constraint

type family (a :: k1) <=? (b :: k2) :: Bool where ... infix 4 Source #

Boolean comparison of two type-level numbers

Equations

(a :: Nat) <=? (b :: Nat) = (<=?) a b 
('Pos a) <=? ('Pos b) = (<=?) a b 
('Neg _) <=? ('Pos _) = 'True 
('Pos 0) <=? ('Neg 0) = 'True 
('Pos _) <=? ('Neg _) = 'False 
('Pos a) <=? b = a <=? b 
a <=? ('Pos b) = a <=? b 
0 <=? ('Neg 0) = 'True 
(a :: Nat) <=? ('Neg _) = 'False 
('Neg a) <=? (b :: Nat) = 'True 
('Neg a) <=? ('Neg b) = (<=?) b a 
(n :% 0) <=? _ = TypeError ('Text "Denominator must not equal 0") 
_ <=? (n :% 0) = TypeError ('Text "Denominator must not equal 0") 
(n1 :% d1) <=? (n2 :% d2) = (n1 * d2) <=? (n2 * d1) 
a <=? (n :% d) = (a * d) <=? n 
(n :% d) <=? b = n <=? (b * d) 

type (<=) (a :: k1) (b :: k2) = (a <=? b) ~ 'True infix 4 Source #

type (<) (a :: k1) (b :: k2) = (b <=? a) ~ 'False infix 4 Source #

type (>=) (a :: k1) (b :: k2) = (b <=? a) ~ 'True infix 4 Source #

type (>) (a :: k1) (b :: k2) = (a <=? b) ~ 'False infix 4 Source #

Arithmetic

type (+) a b = Add a b infixl 6 Source #

The sum of two type-level numbers

type (-) a b = Sub a b infixl 6 Source #

The difference of two type-level numbers

type * a b = Mul a b infixl 7 Source #

The product of two type-level numbers.

Due to changes in GHC 8.6, using this operator infix and unqualified requires the NoStarIsType language extension to be active. See the GHC 8.6.x migration guide for details: https://ghc.haskell.org/trac/ghc/wiki/Migration/8.6