module Prim.Data.Nat where

Primitive: Natural numbersπŸ”—

The natural numbers are the h-initial type generated by a point and an endomorphism.

data Nat : Type where
  zero : Nat
  suc  : Nat β†’ Nat
{-# BUILTIN NATURAL Nat #-}

Optimised functions on NatπŸ”—

Agda lets us define the following functions on natural numbers, which are computed more efficiently when bound as BUILTINs.

infix  4 _==_ _<_
infixl 6 _+_ _-_
infixl 7 _*_

_+_ : Nat β†’ Nat β†’ Nat
zero  + m = m
suc n + m = suc (n + m)

{-# BUILTIN NATPLUS _+_ #-}

_-_ : Nat β†’ Nat β†’ Nat
n     - zero = n
zero  - suc m = zero
suc n - suc m = n - m

{-# BUILTIN NATMINUS _-_ #-}

_*_ : Nat β†’ Nat β†’ Nat
zero  * m = zero
suc n * m = m + n * m

{-# BUILTIN NATTIMES _*_ #-}

_==_ : Nat β†’ Nat β†’ Bool
zero  == zero  = true
suc n == suc m = n == m
_     == _     = false

{-# BUILTIN NATEQUALS _==_ #-}

_<_ : Nat β†’ Nat β†’ Bool
_     < zero  = false
zero  < suc _ = true
suc n < suc m = n < m

{-# BUILTIN NATLESS _<_ #-}