Clash.Normalize.Types

Types used in Normalize modules

Documentation

data NormalizeState

State of the NormalizeMonad

Constructors

NormalizeState

Fields

• _normalized :: BindingMap

  Global binders

• _specialisationCache :: Map (Id, Int, Either Term Type) Id

  Cache of previously specialized functions:

  • Key: (name of the original function, argument position, specialized term/type)
  • Elem: (name of specialized function,type of specialized function)
• _specialisationHistory :: VarEnv Int

  Cache of how many times a function was specialized

• _inlineHistory :: VarEnv (VarEnv Int)

  Cache of function where inlining took place:

  • Key: function where inlining took place
  • Elem: (functions which were inlined, number of times inlined)
• _primitiveArgs :: Map Text (Set Int)

  Cache for looking up constantness of blackbox arguments

• _recursiveComponents :: VarEnv Bool

  Map telling whether a components is recursively defined.

  NB: there are only no mutually-recursive component, only self-recursive ones.

specialisationHistory :: Lens' NormalizeState (VarEnv Int)

specialisationCache :: Lens' NormalizeState (Map (Id, Int, Either Term Type) Id)

recursiveComponents :: Lens' NormalizeState (VarEnv Bool)

primitiveArgs :: Lens' NormalizeState (Map Text (Set Int))

normalized :: Lens' NormalizeState BindingMap

inlineHistory :: Lens' NormalizeState (VarEnv (VarEnv Int))

type NormalizeMonad = State NormalizeState

State monad that stores specialisation and inlining information

type NormalizeSession = RewriteMonad NormalizeState

RewriteSession with extra Normalisation information

type NormRewrite = Rewrite NormalizeState

A Transform action in the context of the RewriteMonad and NormalizeMonad

data TermClassification

Description of a Term in terms of the type "components" the Term has.

Is used as a performance/size metric.

Constructors

TermClassification

Fields

• _function :: !Int

  Number of functions

• _primitive :: !Int

  Number of primitives

• _selection :: !Int

  Number of selections/multiplexers

Instances

Show TermClassification

Defined in Clash.Normalize.Types

Methods

showsPrec :: Int -> TermClassification -> ShowS

show :: TermClassification -> String

showList :: [TermClassification] -> ShowS

selection :: Lens' TermClassification Int

primitive :: Lens' TermClassification Int

function :: Lens' TermClassification Int