Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusTx.Enum

Contents

Orphan instances

Synopsis

class Enum a where
- succ :: a -> a
- pred :: a -> a
- toEnum :: Integer -> a
- fromEnum :: a -> Integer
- enumFromTo :: a -> a -> [a]
- enumFromThenTo :: a -> a -> a -> [a]
deriveEnum :: Name -> Q [Dec]

Documentation

class Enum a where #

Class Enum defines operations on sequentially ordered types.

Minimal complete definition

toEnum, fromEnum

Methods

succ :: a -> a #

The successor of a value. For numeric types, succ adds 1.

For types that implement Ord, succ x should be the least element that is greater than x, and error if there is none.

pred :: a -> a #

The predecessor of a value. For numeric types, pred subtracts 1.

For types that implement Ord, pred x should be the greatest element that is less than x, and error if there is none.

toEnum :: Integer -> a #

Convert from an Integer.

fromEnum :: a -> Integer #

Convert to an Integer.

enumFromTo :: a -> a -> [a] #

Construct a list from the given range (corresponds to [a..b]).

enumFromThenTo :: a -> a -> a -> [a] #

Construct a list from the given range (corresponds to [a,b..c]). This has the same semantics as the Haskell version,so if a==b and c>=b then you get an infinite list, which you probably don't want in Plutus Core.

Instances

Instances details

Enum Ordering #
Instance details Defined in PlutusTx.Enum Methods succ :: Ordering -> Ordering # pred :: Ordering -> Ordering # toEnum :: Integer -> Ordering # fromEnum :: Ordering -> Integer # enumFromTo :: Ordering -> Ordering -> [Ordering] # enumFromThenTo :: Ordering -> Ordering -> Ordering -> [Ordering] #
Enum Rational #
Instance details Defined in PlutusTx.Ratio Methods succ :: Rational -> Rational # pred :: Rational -> Rational # toEnum :: Integer -> Rational # fromEnum :: Rational -> Integer # enumFromTo :: Rational -> Rational -> [Rational] # enumFromThenTo :: Rational -> Rational -> Rational -> [Rational] #
Enum Integer #
Instance details Defined in PlutusTx.Enum.Class Methods succ :: Integer -> Integer # pred :: Integer -> Integer # toEnum :: Integer -> Integer # fromEnum :: Integer -> Integer # enumFromTo :: Integer -> Integer -> [Integer] # enumFromThenTo :: Integer -> Integer -> Integer -> [Integer] #
Enum () #
Instance details Defined in PlutusTx.Enum Methods succ :: () -> () # pred :: () -> () # toEnum :: Integer -> () # fromEnum :: () -> Integer # enumFromTo :: () -> () -> [()] # enumFromThenTo :: () -> () -> () -> [()] #
Enum Bool #
Instance details Defined in PlutusTx.Enum Methods succ :: Bool -> Bool # pred :: Bool -> Bool # toEnum :: Integer -> Bool # fromEnum :: Bool -> Integer # enumFromTo :: Bool -> Bool -> [Bool] # enumFromThenTo :: Bool -> Bool -> Bool -> [Bool] #

deriveEnum :: Name -> Q [Dec] #

Derive PlutusTx.Enum typeclass for datatypes, much like `deriving stock Enum` does for Haskell

Note: requires enabling OverloadedStrings language extension

Orphan instances

Enum Ordering #
Instance details Methods succ :: Ordering -> Ordering # pred :: Ordering -> Ordering # toEnum :: Integer -> Ordering # fromEnum :: Ordering -> Integer # enumFromTo :: Ordering -> Ordering -> [Ordering] # enumFromThenTo :: Ordering -> Ordering -> Ordering -> [Ordering] #
Enum () #
Instance details Methods succ :: () -> () # pred :: () -> () # toEnum :: Integer -> () # fromEnum :: () -> Integer # enumFromTo :: () -> () -> [()] # enumFromThenTo :: () -> () -> () -> [()] #
Enum Bool #
Instance details Methods succ :: Bool -> Bool # pred :: Bool -> Bool # toEnum :: Integer -> Bool # fromEnum :: Bool -> Integer # enumFromTo :: Bool -> Bool -> [Bool] # enumFromThenTo :: Bool -> Bool -> Bool -> [Bool] #