Copyright	(C) MLabs 2025
License	Apache 2.0
Maintainer	koz@mlabs.city, sean@mlabs.city
Safe Haskell	None
Language	Haskell2010

Covenant.DeBruijn

Description

DeBruijn indexing type and helpers. These are mainly used for scope tracking.

Synopsis

data DeBruijn where
- pattern Z :: DeBruijn
- pattern S :: DeBruijn -> DeBruijn
asInt :: DeBruijn -> Int

Documentation

data DeBruijn where Source #

A DeBruijn index.

Since: 1.0.0

Bundled Patterns

pattern Z :: DeBruijn

The zero index.

Since: 1.0.0

pattern S :: DeBruijn -> DeBruijn

Successor to an index.

Since: 1.0.0

Instances

Instances details

Arbitrary DeBruijn Source #	Since: 1.0.0
Instance details Defined in Covenant.DeBruijn Methods arbitrary :: Gen DeBruijn # shrink :: DeBruijn -> [DeBruijn] #
Monoid DeBruijn Source #	Since: 1.0.0
Instance details Defined in Covenant.DeBruijn Methods mempty :: DeBruijn # mappend :: DeBruijn -> DeBruijn -> DeBruijn # mconcat :: [DeBruijn] -> DeBruijn #
Semigroup DeBruijn Source #	Enables some manner of arithmetic with `DeBruijn`s. In this case, `<>` is analogous to `+`, while `stimes b` is analogous to scalar multiplication by `b`. Note that `DeBruijn`s cannot be scaled by negative numbers. Since: 1.0.0
Instance details Defined in Covenant.DeBruijn Methods (<>) :: DeBruijn -> DeBruijn -> DeBruijn # sconcat :: NonEmpty DeBruijn -> DeBruijn # stimes :: Integral b => b -> DeBruijn -> DeBruijn #
Show DeBruijn Source #	Since: 1.0.0
Instance details Defined in Covenant.DeBruijn Methods showsPrec :: Int -> DeBruijn -> ShowS # show :: DeBruijn -> String # showList :: [DeBruijn] -> ShowS #
Eq DeBruijn Source #	Since: 1.0.0
Instance details Defined in Covenant.DeBruijn Methods (==) :: DeBruijn -> DeBruijn -> Bool # (/=) :: DeBruijn -> DeBruijn -> Bool #
Ord DeBruijn Source #	Since: 1.0.0
Instance details Defined in Covenant.DeBruijn Methods compare :: DeBruijn -> DeBruijn -> Ordering # (<) :: DeBruijn -> DeBruijn -> Bool # (<=) :: DeBruijn -> DeBruijn -> Bool # (>) :: DeBruijn -> DeBruijn -> Bool # (>=) :: DeBruijn -> DeBruijn -> Bool # max :: DeBruijn -> DeBruijn -> DeBruijn # min :: DeBruijn -> DeBruijn -> DeBruijn #

asInt :: DeBruijn -> Int Source #

Convert a DeBruijn index into a (non-negative) Int.

Since: 1.0.0