Clash.Unique

Unique

type Unique = Int

class Uniquable a where

Methods

getUnique :: a -> Unique

setUnique :: a -> Unique -> a

Instances

Uniquable Int

Defined in Clash.Unique

Methods

getUnique :: Int -> Unique

setUnique :: Int -> Unique -> Int

Uniquable TyCon

Defined in Clash.Core.TyCon

Methods

getUnique :: TyCon -> Unique

setUnique :: TyCon -> Unique -> TyCon

Uniquable DataCon

Defined in Clash.Core.DataCon

Methods

getUnique :: DataCon -> Unique

setUnique :: DataCon -> Unique -> DataCon

Uniquable (Name a)

Defined in Clash.Core.Name

Methods

getUnique :: Name a -> Unique

setUnique :: Name a -> Unique -> Name a

Uniquable (Var a)

Defined in Clash.Core.Var

Methods

getUnique :: Var a -> Unique

setUnique :: Var a -> Unique -> Var a

UniqMap

data UniqMap a

Map indexed by a Uniquable key

Instances

Functor UniqMap

Defined in Clash.Unique

Methods

fmap :: (a -> b) -> UniqMap a -> UniqMap b

(<$) :: a -> UniqMap b -> UniqMap a

Foldable UniqMap

Defined in Clash.Unique

Methods

fold :: Monoid m => UniqMap m -> m

foldMap :: Monoid m => (a -> m) -> UniqMap a -> m

foldMap' :: Monoid m => (a -> m) -> UniqMap a -> m

foldr :: (a -> b -> b) -> b -> UniqMap a -> b

foldr' :: (a -> b -> b) -> b -> UniqMap a -> b

foldl :: (b -> a -> b) -> b -> UniqMap a -> b

foldl' :: (b -> a -> b) -> b -> UniqMap a -> b

foldr1 :: (a -> a -> a) -> UniqMap a -> a

foldl1 :: (a -> a -> a) -> UniqMap a -> a

toList :: UniqMap a -> [a]

null :: UniqMap a -> Bool

length :: UniqMap a -> Int

elem :: Eq a => a -> UniqMap a -> Bool

maximum :: Ord a => UniqMap a -> a

minimum :: Ord a => UniqMap a -> a

sum :: Num a => UniqMap a -> a

product :: Num a => UniqMap a -> a

Traversable UniqMap

Defined in Clash.Unique

Methods

traverse :: Applicative f => (a -> f b) -> UniqMap a -> f (UniqMap b)

sequenceA :: Applicative f => UniqMap (f a) -> f (UniqMap a)

mapM :: Monad m => (a -> m b) -> UniqMap a -> m (UniqMap b)

sequence :: Monad m => UniqMap (m a) -> m (UniqMap a)

ClashPretty a => Show (UniqMap a)

Defined in Clash.Unique

Methods

showsPrec :: Int -> UniqMap a -> ShowS

show :: UniqMap a -> String

showList :: [UniqMap a] -> ShowS

Semigroup (UniqMap a)

Defined in Clash.Unique

Methods

(<>) :: UniqMap a -> UniqMap a -> UniqMap a

sconcat :: NonEmpty (UniqMap a) -> UniqMap a

stimes :: Integral b => b -> UniqMap a -> UniqMap a

Monoid (UniqMap a)

Defined in Clash.Unique

Methods

mempty :: UniqMap a

mappend :: UniqMap a -> UniqMap a -> UniqMap a

mconcat :: [UniqMap a] -> UniqMap a

Binary a => Binary (UniqMap a)

Defined in Clash.Unique

Methods

put :: UniqMap a -> Put

get :: Get (UniqMap a)

putList :: [UniqMap a] -> Put

NFData a => NFData (UniqMap a)

Defined in Clash.Unique

Methods

rnf :: UniqMap a -> ()

ClashPretty a => ClashPretty (UniqMap a)

Defined in Clash.Unique

Methods

clashPretty :: UniqMap a -> Doc ()

Accessors

Size information

nullUniqMap :: UniqMap a -> Bool

Check whether the map is empty

Indexing

lookupUniqMap :: Uniquable a => a -> UniqMap b -> Maybe b

Look up a value in the map

lookupUniqMap' :: (HasCallStack, Uniquable a) => UniqMap b -> a -> b

Like lookupUniqMap', but errors out when the key is not present

Construction

emptyUniqMap :: UniqMap a

The empty map

unitUniqMap :: Uniquable a => a -> b -> UniqMap b

Map with a single key-value pair

Modification

extendUniqMap :: Uniquable a => a -> b -> UniqMap b -> UniqMap b

Extend the map with a new key-value pair. If the key already exists in the associated value will be overwritten

extendUniqMapWith :: Uniquable a => a -> b -> (b -> b -> b) -> UniqMap b -> UniqMap b

Extend the map with a new key-value pair. If the key already exists in the associated value will be combined with the new value using the function provided

extendListUniqMap :: Uniquable a => UniqMap b -> [(a, b)] -> UniqMap b

Extend the map with a list of key-value pairs. Positions with existing keys will be overwritten with the new values

delUniqMap :: Uniquable a => UniqMap b -> a -> UniqMap b

Remove a key-value pair from the map

delListUniqMap :: Uniquable a => UniqMap b -> [a] -> UniqMap b

Remove a list of key-value pairs from the map

unionUniqMap :: UniqMap a -> UniqMap a -> UniqMap a

A (left-biased) union of two maps

unionUniqMapWith :: (a -> a -> a) -> UniqMap a -> UniqMap a -> UniqMap a

A union of two maps, key-value pairs with the same key will be merged using the given function

differenceUniqMap :: UniqMap a -> UniqMap a -> UniqMap a

Get the difference between two maps

Element-wise operations

Mapping

mapUniqMap :: (a -> b) -> UniqMap a -> UniqMap b

Apply a function to every element in the map

mapMaybeUniqMap :: (a -> Maybe b) -> UniqMap a -> UniqMap b

Apply a function to every element in the map. When the function returns Nothing, the key-value pair will be removed

Working with predicates

Filtering

filterUniqMap :: (b -> Bool) -> UniqMap b -> UniqMap b

Derive a map where all the elements adhere to the predicate

Searching

elemUniqMap :: Uniquable a => a -> UniqMap b -> Bool

Check whether a key is in the map

notElemUniqMap :: Uniquable a => a -> UniqMap b -> Bool

Check whether a key is not in the map

elemUniqMapDirectly :: Unique -> UniqMap b -> Bool

Check whether an element exists in the uniqmap based on a given Unique

Folding

foldrWithUnique :: (Unique -> a -> b -> b) -> b -> UniqMap a -> b

Right-fold over a map using both the key and value

Conversions

Lists

eltsUniqMap :: UniqMap a -> [a]

Extract the elements of a map into a list

keysUniqMap :: UniqMap a -> [Unique]

Extract the keys of a map into a list

listToUniqMap :: Uniquable a => [(a, b)] -> UniqMap b

Convert a list of key-value pairs to a map

toListUniqMap :: UniqMap a -> [(Unique, a)]

Convert a map to a list of key-value pairs

UniqSet

uniqMapToUniqSet :: UniqMap a -> UniqSet a

Convert a UniqMap to a UniqSet

UniqSet

data UniqSet a

Set of things that have a Unique

Invariant: they keys in the map are the uniques of the values

Instances

Foldable UniqSet

Defined in Clash.Unique

Methods

fold :: Monoid m => UniqSet m -> m

foldMap :: Monoid m => (a -> m) -> UniqSet a -> m

foldMap' :: Monoid m => (a -> m) -> UniqSet a -> m

foldr :: (a -> b -> b) -> b -> UniqSet a -> b

foldr' :: (a -> b -> b) -> b -> UniqSet a -> b

foldl :: (b -> a -> b) -> b -> UniqSet a -> b

foldl' :: (b -> a -> b) -> b -> UniqSet a -> b

foldr1 :: (a -> a -> a) -> UniqSet a -> a

foldl1 :: (a -> a -> a) -> UniqSet a -> a

toList :: UniqSet a -> [a]

null :: UniqSet a -> Bool

length :: UniqSet a -> Int

elem :: Eq a => a -> UniqSet a -> Bool

maximum :: Ord a => UniqSet a -> a

minimum :: Ord a => UniqSet a -> a

sum :: Num a => UniqSet a -> a

product :: Num a => UniqSet a -> a

Semigroup (UniqSet a)

Defined in Clash.Unique

Methods

(<>) :: UniqSet a -> UniqSet a -> UniqSet a

sconcat :: NonEmpty (UniqSet a) -> UniqSet a

stimes :: Integral b => b -> UniqSet a -> UniqSet a

Monoid (UniqSet a)

Defined in Clash.Unique

Methods

mempty :: UniqSet a

mappend :: UniqSet a -> UniqSet a -> UniqSet a

mconcat :: [UniqSet a] -> UniqSet a

Binary a => Binary (UniqSet a)

Defined in Clash.Unique

Methods

put :: UniqSet a -> Put

get :: Get (UniqSet a)

putList :: [UniqSet a] -> Put

ClashPretty a => ClashPretty (UniqSet a)

Defined in Clash.Unique

Methods

clashPretty :: UniqSet a -> Doc ()

Accessors

Indexing

lookupUniqSet :: Uniquable a => a -> UniqSet b -> Maybe b

Look up an element in the set, returns it if it exists

Construction

emptyUniqSet :: UniqSet a

The empty set

unitUniqSet :: Uniquable a => a -> UniqSet a

Set with a single element

Modifications

extendUniqSet :: Uniquable a => UniqSet a -> a -> UniqSet a

Add an element to the set

unionUniqSet :: UniqSet a -> UniqSet a -> UniqSet a

Union two sets

delUniqSetDirectly :: Unique -> UniqSet b -> UniqSet b

Remove an element based on the Unique it contains

Working with predicates

Searching

elemUniqSet :: Uniquable a => a -> UniqSet a -> Bool

Check whether an element exists in the set

notElemUniqSet :: Uniquable a => a -> UniqSet a -> Bool

Check whether an element does not exist in the set

elemUniqSetDirectly :: Unique -> UniqSet a -> Bool

Check whether an element exists in the set based on the Unique contained in that element

Misc

subsetUniqSet

Arguments

:: UniqSet a

Set A

-> UniqSet a

Set B

-> Bool

Check whether a A is a subset of B

Conversions

Lists

mkUniqSet :: Uniquable a => [a] -> UniqSet a

Create a set out of a list of elements that contain a Unique

eltsUniqSet :: UniqSet a -> [a]

Get the elements of the set as a list