Clash.Core.Var

Variables in CoreHW

Documentation

data Attr'

Interal version of Clash.Annotations.SynthesisAttributes.Attr.

Needed because Clash.Annotations.SynthesisAttributes.Attr uses the Symbol kind for names, which do not have a term-level representation

Constructors

BoolAttr' String Bool

IntegerAttr' String Integer

StringAttr' String String

Attr' String

Instances

Eq Attr'

Defined in Clash.Core.Var

Methods

(==) :: Attr' -> Attr' -> Bool

(/=) :: Attr' -> Attr' -> Bool

Ord Attr'

Defined in Clash.Core.Var

Methods

compare :: Attr' -> Attr' -> Ordering

(<) :: Attr' -> Attr' -> Bool

(<=) :: Attr' -> Attr' -> Bool

(>) :: Attr' -> Attr' -> Bool

(>=) :: Attr' -> Attr' -> Bool

max :: Attr' -> Attr' -> Attr'

min :: Attr' -> Attr' -> Attr'

Show Attr'

Defined in Clash.Core.Var

Methods

showsPrec :: Int -> Attr' -> ShowS

show :: Attr' -> String

showList :: [Attr'] -> ShowS

Generic Attr'

Defined in Clash.Core.Var

Associated Types

type Rep Attr' :: Type -> Type

Methods

from :: Attr' -> Rep Attr' x

to :: Rep Attr' x -> Attr'

Hashable Attr'

Defined in Clash.Core.Var

Methods

hashWithSalt :: Int -> Attr' -> Int

hash :: Attr' -> Int

Binary Attr'

Defined in Clash.Core.Var

Methods

put :: Attr' -> Put

get :: Get Attr'

putList :: [Attr'] -> Put

NFData Attr'

Defined in Clash.Core.Var

Methods

rnf :: Attr' -> ()

type Rep Attr'

Defined in Clash.Core.Var

type Rep Attr' = D1 ('MetaData "Attr'" "Clash.Core.Var" "clash-lib-0.9999-inplace" 'False) ((C1 ('MetaCons "BoolAttr'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :+: C1 ('MetaCons "IntegerAttr'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer))) :+: (C1 ('MetaCons "StringAttr'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "Attr'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

data Var a

Variables in CoreHW

Constructors

TyVar

Constructor for type variables

Fields

• varName :: !(Name a)
• varUniq :: !Unique
• varType :: Kind

Id

Constructor for term variables

Fields

• varName :: !(Name a)
• varUniq :: !Unique
• varType :: Type
• idScope :: IdScope

Instances

Eq (Var a)

Defined in Clash.Core.Var

Methods

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

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

Ord (Var a)

Defined in Clash.Core.Var

Methods

compare :: Var a -> Var a -> Ordering

(<) :: Var a -> Var a -> Bool

(<=) :: Var a -> Var a -> Bool

(>) :: Var a -> Var a -> Bool

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

max :: Var a -> Var a -> Var a

min :: Var a -> Var a -> Var a

Show (Var a)

Defined in Clash.Core.Var

Methods

showsPrec :: Int -> Var a -> ShowS

show :: Var a -> String

showList :: [Var a] -> ShowS

Generic (Var a)

Defined in Clash.Core.Var

Associated Types

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

Methods

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

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

Hashable (Var a)

Defined in Clash.Core.Var

Methods

hashWithSalt :: Int -> Var a -> Int

hash :: Var a -> Int

Binary (Var a)

Defined in Clash.Core.Var

Methods

put :: Var a -> Put

get :: Get (Var a)

putList :: [Var a] -> Put

NFData (Var a)

Defined in Clash.Core.Var

Methods

rnf :: Var a -> ()

ClashPretty (Var a)

Defined in Clash.Core.Pretty

Methods

clashPretty :: Var a -> Doc ()

Uniquable (Var a)

Defined in Clash.Core.Var

Methods

getUnique :: Var a -> Unique

PrettyPrec (Var a)

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Var a -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> Var a -> m ClashDoc

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 (Var a)

Defined in Clash.Core.Var

type Rep (Var a) = D1 ('MetaData "Var" "Clash.Core.Var" "clash-lib-0.9999-inplace" 'False) (C1 ('MetaCons "TyVar" 'PrefixI 'True) (S1 ('MetaSel ('Just "varName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Name a)) :*: (S1 ('MetaSel ('Just "varUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique) :*: S1 ('MetaSel ('Just "varType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Kind))) :+: C1 ('MetaCons "Id" 'PrefixI 'True) ((S1 ('MetaSel ('Just "varName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Name a)) :*: S1 ('MetaSel ('Just "varUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique)) :*: (S1 ('MetaSel ('Just "varType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type) :*: S1 ('MetaSel ('Just "idScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IdScope))))

data IdScope

Constructors

GlobalId

LocalId

Instances

Show IdScope

Defined in Clash.Core.Var

Methods

showsPrec :: Int -> IdScope -> ShowS

show :: IdScope -> String

showList :: [IdScope] -> ShowS

Generic IdScope

Defined in Clash.Core.Var

Associated Types

type Rep IdScope :: Type -> Type

Methods

from :: IdScope -> Rep IdScope x

to :: Rep IdScope x -> IdScope

Hashable IdScope

Defined in Clash.Core.Var

Methods

hashWithSalt :: Int -> IdScope -> Int

hash :: IdScope -> Int

Binary IdScope

Defined in Clash.Core.Var

Methods

put :: IdScope -> Put

get :: Get IdScope

putList :: [IdScope] -> Put

NFData IdScope

Defined in Clash.Core.Var

Methods

rnf :: IdScope -> ()

type Rep IdScope

Defined in Clash.Core.Var

type Rep IdScope = D1 ('MetaData "IdScope" "Clash.Core.Var" "clash-lib-0.9999-inplace" 'False) (C1 ('MetaCons "GlobalId" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LocalId" 'PrefixI 'False) (U1 :: Type -> Type))

type Id = Var Term

Term variable

type TyVar = Var Type

Type variable

mkId :: Type -> IdScope -> TmName -> Id

Make a term variable

mkLocalId :: Type -> TmName -> Id

mkGlobalId :: Type -> TmName -> Id

mkTyVar :: Kind -> TyName -> TyVar

Make a type variable

setVarUnique :: Var a -> Unique -> Var a

setVarType :: Var a -> Type -> Var a

setIdScope :: IdScope -> Var a -> Var a

modifyVarName :: (Name a -> Name a) -> Var a -> Var a

Change the name of a variable

isGlobalId :: Var a -> Bool

isLocalId :: Var a -> Bool

attrName :: Attr' -> String