Clash.Core.Term

Term representation in the CoreHW language: System F + LetRec + Case

Documentation

data Term

Term representation in the CoreHW language: System F + LetRec + Case

Constructors

Var !Id

Variable reference

Data !DataCon

Datatype constructor

Literal !Literal

Literal

Prim !PrimInfo

Primitive

Lam !Id Term

Term-abstraction

TyLam !TyVar Term

Type-abstraction

App !Term !Term

Application

TyApp !Term !Type

Type-application

Let !(Bind Term) Term

Recursive let-binding

Case !Term !Type [Alt]

Case-expression: subject, type of alternatives, list of alternatives

Cast !Term !Type !Type

Cast a term from one type to another

Tick !TickInfo !Term

Annotated term

Bundled Patterns

pattern Letrec :: [LetBinding] -> Term -> Term

Instances

Eq Term

Defined in Clash.Core.Subst

Methods

(==) :: Term -> Term -> Bool

(/=) :: Term -> Term -> Bool

Ord Term

Defined in Clash.Core.Subst

Methods

compare :: Term -> Term -> Ordering

(<) :: Term -> Term -> Bool

(<=) :: Term -> Term -> Bool

(>) :: Term -> Term -> Bool

(>=) :: Term -> Term -> Bool

max :: Term -> Term -> Term

min :: Term -> Term -> Term

Show Term

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> Term -> ShowS

show :: Term -> String

showList :: [Term] -> ShowS

Generic Term

Defined in Clash.Core.Term

Associated Types

type Rep Term :: Type -> Type

Methods

from :: Term -> Rep Term x

to :: Rep Term x -> Term

(TypeError (('Text "A broken implementation of Hashable Term has been " :<>: 'Text "removed in Clash 1.4.7. If this is an issue for you, please submit ") :<>: 'Text "an issue report at https://github.com/clash-lang/clash-compiler/issues.") :: Constraint) => Hashable Term

Defined in Clash.Core.Subst

Methods

hashWithSalt :: Int -> Term -> Int

hash :: Term -> Int

Binary Term

Defined in Clash.Core.Term

Methods

put :: Term -> Put

get :: Get Term

putList :: [Term] -> Put

NFData Term

Defined in Clash.Core.Term

Methods

rnf :: Term -> ()

ClashPretty Term

Defined in Clash.Core.Pretty

Methods

clashPretty :: Term -> Doc ()

PrettyPrec Term

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Term -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> Term -> m ClashDoc

HasFreeVars Term

Defined in Clash.Core.HasFreeVars

Methods

freeVarsOf :: Term -> VarSet

isClosed :: Term -> Bool

elemFreeVars :: Var Term -> Term -> Bool

notElemFreeVars :: Var Term -> Term -> Bool

subsetFreeVars :: VarSet -> Term -> Bool

disjointFreeVars :: VarSet -> Term -> Bool

TermLiteral Term

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term Term

showsTypePrec :: Int -> Proxy Term -> ShowS

InferType Term

Defined in Clash.Core.HasType

Methods

inferCoreTypeOf :: TyConMap -> Term -> Type

PrettyPrec (Id, Term)

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> (Id, Term) -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> (Id, Term) -> m ClashDoc

type Rep Term

Defined in Clash.Core.Term

type Rep Term = D1 ('MetaData "Term" "Clash.Core.Term" "clash-lib-1.8.1-inplace" 'False) (((C1 ('MetaCons "Var" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Id)) :+: (C1 ('MetaCons "Data" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DataCon)) :+: C1 ('MetaCons "Literal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Literal)))) :+: (C1 ('MetaCons "Prim" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PrimInfo)) :+: (C1 ('MetaCons "Lam" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Id) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Term)) :+: C1 ('MetaCons "TyLam" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TyVar) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Term))))) :+: ((C1 ('MetaCons "App" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Term) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Term)) :+: (C1 ('MetaCons "TyApp" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Term) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type)) :+: C1 ('MetaCons "Let" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Bind Term)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Term)))) :+: (C1 ('MetaCons "Case" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Term) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Alt]))) :+: (C1 ('MetaCons "Cast" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Term) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type))) :+: C1 ('MetaCons "Tick" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TickInfo) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Term))))))

mkAbstraction :: Term -> [Either Id TyVar] -> Term

Abstract a term over a list of term and type variables

mkTyLams :: Term -> [TyVar] -> Term

Abstract a term over a list of type variables

mkLams :: Term -> [Id] -> Term

Abstract a term over a list of variables

mkApps :: Term -> [Either Term Type] -> Term

Apply a list of types and terms to a term

mkTyApps :: Term -> [Type] -> Term

Apply a list of types to a term

mkTmApps :: Term -> [Term] -> Term

Apply a list of terms to a term

mkTicks :: Term -> [TickInfo] -> Term

type TmName = Name Term

Term reference

varToId :: Term -> Id

Make a term variable out of a variable reference or ticked variable reference

data Bind a

Constructors

NonRec Id a

Rec [(Id, a)]

Instances

Functor Bind

Defined in Clash.Core.Term

Methods

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

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

Eq a => Eq (Bind a)

Defined in Clash.Core.Term

Methods

(==) :: Bind a -> Bind a -> Bool

(/=) :: Bind a -> Bind a -> Bool

Show a => Show (Bind a)

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> Bind a -> ShowS

show :: Bind a -> String

showList :: [Bind a] -> ShowS

Generic (Bind a)

Defined in Clash.Core.Term

Associated Types

type Rep (Bind a) :: Type -> Type

Methods

from :: Bind a -> Rep (Bind a) x

to :: Rep (Bind a) x -> Bind a

Hashable a => Hashable (Bind a)

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> Bind a -> Int

hash :: Bind a -> Int

Binary a => Binary (Bind a)

Defined in Clash.Core.Term

Methods

put :: Bind a -> Put

get :: Get (Bind a)

putList :: [Bind a] -> Put

NFData a => NFData (Bind a)

Defined in Clash.Core.Term

Methods

rnf :: Bind a -> ()

type Rep (Bind a)

Defined in Clash.Core.Term

type Rep (Bind a) = D1 ('MetaData "Bind" "Clash.Core.Term" "clash-lib-1.8.1-inplace" 'False) (C1 ('MetaCons "NonRec" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Id) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "Rec" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Id, a)])))

type LetBinding = (Id, Term)

Binding in a LetRec construct

data Pat

Patterns in the LHS of a case-decomposition

Constructors

DataPat !DataCon [TyVar] [Id]

Datatype pattern, '[TyVar]' bind existentially-quantified type-variables of a DataCon

LitPat !Literal

Literal pattern

DefaultPat

Default pattern

Instances

Eq Pat

Defined in Clash.Core.Term

Methods

(==) :: Pat -> Pat -> Bool

(/=) :: Pat -> Pat -> Bool

Ord Pat

Defined in Clash.Core.Term

Methods

compare :: Pat -> Pat -> Ordering

(<) :: Pat -> Pat -> Bool

(<=) :: Pat -> Pat -> Bool

(>) :: Pat -> Pat -> Bool

(>=) :: Pat -> Pat -> Bool

max :: Pat -> Pat -> Pat

min :: Pat -> Pat -> Pat

Show Pat

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> Pat -> ShowS

show :: Pat -> String

showList :: [Pat] -> ShowS

Generic Pat

Defined in Clash.Core.Term

Associated Types

type Rep Pat :: Type -> Type

Methods

from :: Pat -> Rep Pat x

to :: Rep Pat x -> Pat

Binary Pat

Defined in Clash.Core.Term

Methods

put :: Pat -> Put

get :: Get Pat

putList :: [Pat] -> Put

NFData Pat

Defined in Clash.Core.Term

Methods

rnf :: Pat -> ()

PrettyPrec Pat

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Pat -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> Pat -> m ClashDoc

type Rep Pat

Defined in Clash.Core.Term

type Rep Pat = D1 ('MetaData "Pat" "Clash.Core.Term" "clash-lib-1.8.1-inplace" 'False) (C1 ('MetaCons "DataPat" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DataCon) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TyVar]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Id]))) :+: (C1 ('MetaCons "LitPat" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Literal)) :+: C1 ('MetaCons "DefaultPat" 'PrefixI 'False) (U1 :: Type -> Type)))

patIds :: Pat -> ([TyVar], [Id])

Get the list of term-binders out of a DataType pattern

patVars :: Pat -> [Var a]

type Alt = (Pat, Term)

data TickInfo

Constructors

SrcSpan !SrcSpan

Source tick, will get added by GHC by running clash with `-g`

NameMod !NameMod !Type

Modifier for naming module instantiations and registers, are added by the user by using the functions Clash.Magic.[prefixName,suffixName,setName]

DeDup

Deduplicate, i.e. try to share expressions between multiple branches.

NoDeDup

Do not deduplicate, i.e. keep, an expression inside a case-alternative; do not try to share expressions between multiple branches.

Instances

Eq TickInfo

Defined in Clash.Core.Term

Methods

(==) :: TickInfo -> TickInfo -> Bool

(/=) :: TickInfo -> TickInfo -> Bool

Ord TickInfo

Defined in Clash.Core.Term

Methods

compare :: TickInfo -> TickInfo -> Ordering

(<) :: TickInfo -> TickInfo -> Bool

(<=) :: TickInfo -> TickInfo -> Bool

(>) :: TickInfo -> TickInfo -> Bool

(>=) :: TickInfo -> TickInfo -> Bool

max :: TickInfo -> TickInfo -> TickInfo

min :: TickInfo -> TickInfo -> TickInfo

Show TickInfo

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> TickInfo -> ShowS

show :: TickInfo -> String

showList :: [TickInfo] -> ShowS

Generic TickInfo

Defined in Clash.Core.Term

Associated Types

type Rep TickInfo :: Type -> Type

Methods

from :: TickInfo -> Rep TickInfo x

to :: Rep TickInfo x -> TickInfo

Binary TickInfo

Defined in Clash.Core.Term

Methods

put :: TickInfo -> Put

get :: Get TickInfo

putList :: [TickInfo] -> Put

NFData TickInfo

Defined in Clash.Core.Term

Methods

rnf :: TickInfo -> ()

PrettyPrec TickInfo

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> TickInfo -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> TickInfo -> m ClashDoc

type Rep TickInfo

Defined in Clash.Core.Term

type Rep TickInfo = D1 ('MetaData "TickInfo" "Clash.Core.Term" "clash-lib-1.8.1-inplace" 'False) ((C1 ('MetaCons "SrcSpan" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SrcSpan)) :+: C1 ('MetaCons "NameMod" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NameMod) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type))) :+: (C1 ('MetaCons "DeDup" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoDeDup" 'PrefixI 'False) (U1 :: Type -> Type)))

stripTicks :: Term -> Term

stripAllTicks :: Term -> Term

Like stripTicks but removes all ticks from subexpressions.

partitionTicks

Arguments

:: [TickInfo]

-> ([TickInfo], [TickInfo])

(source ticks, nameMod ticks)

Partition ticks in source ticks and nameMod ticks

data NameMod

Tag to indicate which instance/register name modifier was used

Constructors

PrefixName

Clash.Magic.prefixName

SuffixName

Clash.Magic.suffixName

SuffixNameP

Clash.Magic.suffixNameP

SetName

Clash.Magic.setName

Instances

Eq NameMod

Defined in Clash.Core.Term

Methods

(==) :: NameMod -> NameMod -> Bool

(/=) :: NameMod -> NameMod -> Bool

Ord NameMod

Defined in Clash.Core.Term

Methods

compare :: NameMod -> NameMod -> Ordering

(<) :: NameMod -> NameMod -> Bool

(<=) :: NameMod -> NameMod -> Bool

(>) :: NameMod -> NameMod -> Bool

(>=) :: NameMod -> NameMod -> Bool

max :: NameMod -> NameMod -> NameMod

min :: NameMod -> NameMod -> NameMod

Show NameMod

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> NameMod -> ShowS

show :: NameMod -> String

showList :: [NameMod] -> ShowS

Generic NameMod

Defined in Clash.Core.Term

Associated Types

type Rep NameMod :: Type -> Type

Methods

from :: NameMod -> Rep NameMod x

to :: Rep NameMod x -> NameMod

Hashable NameMod

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> NameMod -> Int

hash :: NameMod -> Int

Binary NameMod

Defined in Clash.Core.Term

Methods

put :: NameMod -> Put

get :: Get NameMod

putList :: [NameMod] -> Put

NFData NameMod

Defined in Clash.Core.Term

Methods

rnf :: NameMod -> ()

type Rep NameMod

Defined in Clash.Core.Term

type Rep NameMod = D1 ('MetaData "NameMod" "Clash.Core.Term" "clash-lib-1.8.1-inplace" 'False) ((C1 ('MetaCons "PrefixName" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SuffixName" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SuffixNameP" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SetName" 'PrefixI 'False) (U1 :: Type -> Type)))

data PrimInfo

Constructors

PrimInfo

Fields

• primName :: !Text
• primType :: !Type
• primWorkInfo :: !WorkInfo
• primMultiResult :: !IsMultiPrim

  Primitive with multiple return values. Useful for primitives that cannot return their results as a single product type, due to limitation of synthesis tooling. It will be applied to its normal arguments, followed by the variables it should assign its results to.

  See: setupMultiResultPrim

• primUnfolding :: !PrimUnfolding

Instances

Show PrimInfo

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> PrimInfo -> ShowS

show :: PrimInfo -> String

showList :: [PrimInfo] -> ShowS

Generic PrimInfo

Defined in Clash.Core.Term

Associated Types

type Rep PrimInfo :: Type -> Type

Methods

from :: PrimInfo -> Rep PrimInfo x

to :: Rep PrimInfo x -> PrimInfo

Binary PrimInfo

Defined in Clash.Core.Term

Methods

put :: PrimInfo -> Put

get :: Get PrimInfo

putList :: [PrimInfo] -> Put

NFData PrimInfo

Defined in Clash.Core.Term

Methods

rnf :: PrimInfo -> ()

HasType PrimInfo

Defined in Clash.Core.HasType

Methods

coreTypeOf :: PrimInfo -> Type

type Rep PrimInfo

Defined in Clash.Core.Term

type Rep PrimInfo = D1 ('MetaData "PrimInfo" "Clash.Core.Term" "clash-lib-1.8.1-inplace" 'False) (C1 ('MetaCons "PrimInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "primName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "primType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type)) :*: (S1 ('MetaSel ('Just "primWorkInfo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 WorkInfo) :*: (S1 ('MetaSel ('Just "primMultiResult") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 IsMultiPrim) :*: S1 ('MetaSel ('Just "primUnfolding") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PrimUnfolding)))))

data PrimUnfolding

Constructors

NoUnfolding

Unfolding !Id

Instances

Eq PrimUnfolding

Defined in Clash.Core.Term

Methods

(==) :: PrimUnfolding -> PrimUnfolding -> Bool

(/=) :: PrimUnfolding -> PrimUnfolding -> Bool

Show PrimUnfolding

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> PrimUnfolding -> ShowS

show :: PrimUnfolding -> String

showList :: [PrimUnfolding] -> ShowS

Generic PrimUnfolding

Defined in Clash.Core.Term

Associated Types

type Rep PrimUnfolding :: Type -> Type

Methods

from :: PrimUnfolding -> Rep PrimUnfolding x

to :: Rep PrimUnfolding x -> PrimUnfolding

Hashable PrimUnfolding

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> PrimUnfolding -> Int

hash :: PrimUnfolding -> Int

Binary PrimUnfolding

Defined in Clash.Core.Term

Methods

put :: PrimUnfolding -> Put

get :: Get PrimUnfolding

putList :: [PrimUnfolding] -> Put

NFData PrimUnfolding

Defined in Clash.Core.Term

Methods

rnf :: PrimUnfolding -> ()

type Rep PrimUnfolding

Defined in Clash.Core.Term

type Rep PrimUnfolding = D1 ('MetaData "PrimUnfolding" "Clash.Core.Term" "clash-lib-1.8.1-inplace" 'False) (C1 ('MetaCons "NoUnfolding" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unfolding" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Id)))

data IsMultiPrim

Constructors

SingleResult

MultiResult

Instances

Eq IsMultiPrim

Defined in Clash.Core.Term

Methods

(==) :: IsMultiPrim -> IsMultiPrim -> Bool

(/=) :: IsMultiPrim -> IsMultiPrim -> Bool

Show IsMultiPrim

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> IsMultiPrim -> ShowS

show :: IsMultiPrim -> String

showList :: [IsMultiPrim] -> ShowS

Generic IsMultiPrim

Defined in Clash.Core.Term

Associated Types

type Rep IsMultiPrim :: Type -> Type

Methods

from :: IsMultiPrim -> Rep IsMultiPrim x

to :: Rep IsMultiPrim x -> IsMultiPrim

Hashable IsMultiPrim

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> IsMultiPrim -> Int

hash :: IsMultiPrim -> Int

Binary IsMultiPrim

Defined in Clash.Core.Term

Methods

put :: IsMultiPrim -> Put

get :: Get IsMultiPrim

putList :: [IsMultiPrim] -> Put

NFData IsMultiPrim

Defined in Clash.Core.Term

Methods

rnf :: IsMultiPrim -> ()

type Rep IsMultiPrim

Defined in Clash.Core.Term

type Rep IsMultiPrim = D1 ('MetaData "IsMultiPrim" "Clash.Core.Term" "clash-lib-1.8.1-inplace" 'False) (C1 ('MetaCons "SingleResult" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MultiResult" 'PrefixI 'False) (U1 :: Type -> Type))

data MultiPrimInfo

Constructors

MultiPrimInfo

Fields

• mpi_primInfo :: PrimInfo
• mpi_resultDc :: DataCon
• mpi_resultTypes :: [Type]

data WorkInfo

Constructors

WorkConstant

Ignores its arguments, and outputs a constant

WorkNever

Never adds any work

WorkVariable

Does work when the arguments are variable

WorkAlways

Performs work regardless of whether the variables are constant or variable; these are things like clock or reset generators

WorkIdentity Int [Int]

A more restrictive version of WorkNever, where the value is the argument at the given position if all arguments for the given list of positions are also WorkIdentity

Instances

Eq WorkInfo

Defined in Clash.Core.Term

Methods

(==) :: WorkInfo -> WorkInfo -> Bool

(/=) :: WorkInfo -> WorkInfo -> Bool

Show WorkInfo

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> WorkInfo -> ShowS

show :: WorkInfo -> String

showList :: [WorkInfo] -> ShowS

Generic WorkInfo

Defined in Clash.Core.Term

Associated Types

type Rep WorkInfo :: Type -> Type

Methods

from :: WorkInfo -> Rep WorkInfo x

to :: Rep WorkInfo x -> WorkInfo

Hashable WorkInfo

Defined in Clash.Core.Term

Methods

hashWithSalt :: Int -> WorkInfo -> Int

hash :: WorkInfo -> Int

Binary WorkInfo

Defined in Clash.Core.Term

Methods

put :: WorkInfo -> Put

get :: Get WorkInfo

putList :: [WorkInfo] -> Put

NFData WorkInfo

Defined in Clash.Core.Term

Methods

rnf :: WorkInfo -> ()

type Rep WorkInfo

Defined in Clash.Core.Term

type Rep WorkInfo = D1 ('MetaData "WorkInfo" "Clash.Core.Term" "clash-lib-1.8.1-inplace" 'False) ((C1 ('MetaCons "WorkConstant" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WorkNever" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "WorkVariable" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "WorkAlways" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WorkIdentity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int])))))

data CoreContext

Context in which a term appears

Constructors

AppFun

Function position of an application

AppArg (Maybe (Text, Int, Int))

Argument position of an application. If this is an argument applied to a primitive, a tuple is defined containing (name of the primitive, #type args, #term args)

TyAppC

Function position of a type application

LetBinding Id [Id]

RHS of a Let-binder with the sibling LHS'

LetBody [LetBinding]

Body of a Let-binding with the bound LHS'

LamBody Id

Body of a lambda-term with the abstracted variable

TyLamBody TyVar

Body of a TyLambda-term with the abstracted type-variable

CaseAlt Pat

RHS of a case-alternative with the bound pattern on the LHS

CaseScrut

Subject of a case-decomposition

CastBody

Body of a Cast

TickC TickInfo

Body of a Tick

Instances

Eq CoreContext

Defined in Clash.Core.Term

Methods

(==) :: CoreContext -> CoreContext -> Bool

(/=) :: CoreContext -> CoreContext -> Bool

Show CoreContext

Defined in Clash.Core.Term

Methods

showsPrec :: Int -> CoreContext -> ShowS

show :: CoreContext -> String

showList :: [CoreContext] -> ShowS

Generic CoreContext

Defined in Clash.Core.Term

Associated Types

type Rep CoreContext :: Type -> Type

Methods

from :: CoreContext -> Rep CoreContext x

to :: Rep CoreContext x -> CoreContext

Binary CoreContext

Defined in Clash.Core.Term

Methods

put :: CoreContext -> Put

get :: Get CoreContext

putList :: [CoreContext] -> Put

NFData CoreContext

Defined in Clash.Core.Term

Methods

rnf :: CoreContext -> ()

type Rep CoreContext

Defined in Clash.Core.Term

type Rep CoreContext = D1 ('MetaData "CoreContext" "Clash.Core.Term" "clash-lib-1.8.1-inplace" 'False) (((C1 ('MetaCons "AppFun" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AppArg" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Text, Int, Int))))) :+: (C1 ('MetaCons "TyAppC" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LetBinding" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Id) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Id])) :+: C1 ('MetaCons "LetBody" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [LetBinding]))))) :+: ((C1 ('MetaCons "LamBody" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Id)) :+: (C1 ('MetaCons "TyLamBody" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TyVar)) :+: C1 ('MetaCons "CaseAlt" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Pat)))) :+: (C1 ('MetaCons "CaseScrut" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CastBody" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TickC" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TickInfo))))))

type Context = [CoreContext]

A list of CoreContext describes the complete navigation path from the top-level to a specific sub-expression.

isLambdaBodyCtx :: CoreContext -> Bool

Is the Context a Lambda/Term-abstraction context?

isTickCtx :: CoreContext -> Bool

Is the Context a Tick context?

walkTerm :: forall a. (Term -> Maybe a) -> Term -> [a]

Visit all terms in a term, testing it with a predicate, and returning a list of predicate yields.

collectArgs :: Term -> (Term, [Either Term Type])

Split a (Type)Application in the applied term and it arguments

collectArgsTicks :: Term -> (Term, [Either Term Type], [TickInfo])

collectTicks :: Term -> (Term, [TickInfo])

collectTermIds :: Term -> [Id]

collectBndrs :: Term -> ([Either Id TyVar], Term)

Split a (Type)Abstraction in the bound variables and the abstracted term

primArg

Arguments

:: Term

Function application

-> Maybe (Text, Int, Int)

If Term was a primitive: (name of primitive, #type args, #term args)

Given a function application, find the primitive it's applied. Yields Nothing if given term is not an application or if it is not a primitive.