typenums

Type level numbers using existing Nat functionality https://github.com/adituv/typenums#readme

Version on this page:0.1.2.1
LTS Haskell 12.23:0.1.2.1
Stackage Nightly 2018-12-15:0.1.2.1
Latest on Hackage:0.1.2.1

See all snapshots typenums appears in

BSD3 licensed by AdituV
Maintained by aditu.venyhandottir@gmail.com

Module documentation for 0.1.2.1

There are no documented modules for this package.

typenums

Hackage Build status Windows build status BSD3 license

Type level numbers using existing Nat functionality. Uses kind-polymorphic typeclasses and type families to facilitate more general code compatible with existing code using type-level Naturals.

Usage

Import either Data.TypeNums or Data.TypeLits instead of GHC.TypeLits. Some definitions conflict with GHC.TypeLits, so if you really must import it, use an explicit import list.

This library is intended to be used in a kind-polymorphic way, such that a type-level integer parameter can be written as a natural, and a rational can be written as either of the other two. As an example:

{-# LANGUAGE PolyKinds #-}

data SomeType (n :: k) = SomeType

useSomeType :: KnownInt n => SomeType n -> _
useSomeType = -- ...

Syntax

  • Positive integers are written as natural numbers, as before. Optionally they can also be written as Pos n.
  • Negative integers are written as Neg n.
  • Ratios are written as n :% d, where n can be a natural number, Pos n, or Neg n, and d is a natural number.

Addition, subtraction and multiplication at type level are all given as infix operators with standard notation, and are compatible with any combination of the above types. Equality and comparison constraints are likewise available for any combination of the above types.

N.B. The equality constraint conflicts with that in Data.Type.Equality. The (==) operator from Data.Type.Equality is re-exported as (==?) from both Data.TypeNums and Data.TypeLits.

Changes

Change log

typenums uses PVP Versioning. The change log is available on GitHub.

0.1.2.1

  • Fix build failure on GHC 8.6 by adding conditional NoStarIsType langauge pragma

0.1.2

  • (#2) Refactored type-level arithmetic so that the type families are exposed from an Internal module.

0.1.1.1

  • Add UndecidableInstances language extension to Data.TypeNums.Rats. This fixes a compilation error with GHC HEAD.

0.1.1

  • (#1) Added existentially-quantified datatypes SomeInt and SomeRat to handle type-level Ints and Rats that are not statically known. Added functions someIntVal and someRatVal to construct these from an Integer/Rational value.

0.1.0.0

  • Initial Haddock release
  • Defined type-level integers and rationals
  • Defined polykinded arithmetic over nats, ints and rats
  • Defined polykinded comparison over nats, ints and rats
  • Added Data.TypeLits module
Depends on 1 package:
Used by 1 package:
comments powered byDisqus