Clash.Core.Type

Types in CoreHW

Documentation

data Type

Types in CoreHW: function and polymorphic types

Constructors

VarTy !Kind !TyName

Type variable

ConstTy !ConstTy

Type constant

ForAllTy !(Bind TyVar Type)

Polymorphic Type

AppTy !Type !Type

Type Application

LitTy !LitTy

Type literal

Instances

Eq Type

Methods

(==) :: Type -> Type -> Bool

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

Ord Type

Methods

compare :: Type -> Type -> Ordering

(<) :: Type -> Type -> Bool

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

(>) :: Type -> Type -> Bool

(>=) :: Type -> Type -> Bool

max :: Type -> Type -> Type

min :: Type -> Type -> Type

Show Type

Methods

showsPrec :: Int -> Type -> ShowS

show :: Type -> String

showList :: [Type] -> ShowS

Generic Type

Associated Types

type Rep Type :: * -> *

Methods

from :: Type -> Rep Type x

to :: Rep Type x -> Type

Hashable Type

Methods

hashWithSalt :: Int -> Type -> Int

hash :: Type -> Int

NFData Type

Methods

rnf :: Type -> ()

Alpha Type

Methods

aeq' :: AlphaCtx -> Type -> Type -> Bool

fvAny' :: (Contravariant f, Applicative f) => AlphaCtx -> (AnyName -> f AnyName) -> Type -> f Type

close :: AlphaCtx -> NamePatFind -> Type -> Type

open :: AlphaCtx -> NthPatFind -> Type -> Type

isPat :: Type -> DisjointSet AnyName

isTerm :: Type -> All

isEmbed :: Type -> Bool

nthPatFind :: Type -> NthPatFind

namePatFind :: Type -> NamePatFind

swaps' :: AlphaCtx -> Perm AnyName -> Type -> Type

lfreshen' :: LFresh m => AlphaCtx -> Type -> (Type -> Perm AnyName -> m b) -> m b

freshen' :: Fresh m => AlphaCtx -> Type -> m (Type, Perm AnyName)

acompare' :: AlphaCtx -> Type -> Type -> Ordering

Pretty Type

Methods

ppr :: LFresh m => Type -> m Doc

pprPrec :: LFresh m => Rational -> Type -> m Doc

Subst Term Type

Methods

isvar :: Type -> Maybe (SubstName Type Term)

isCoerceVar :: Type -> Maybe (SubstCoerce Type Term)

subst :: Name Term -> Term -> Type -> Type

substs :: [(Name Term, Term)] -> Type -> Type

Subst Type Term

Methods

isvar :: Term -> Maybe (SubstName Term Type)

isCoerceVar :: Term -> Maybe (SubstCoerce Term Type)

subst :: Name Type -> Type -> Term -> Term

substs :: [(Name Type, Type)] -> Term -> Term

Subst Type Type

Methods

isvar :: Type -> Maybe (SubstName Type Type)

isCoerceVar :: Type -> Maybe (SubstCoerce Type Type)

subst :: Name Type -> Type -> Type -> Type

substs :: [(Name Type, Type)] -> Type -> Type

Subst Type Pat

Methods

isvar :: Pat -> Maybe (SubstName Pat Type)

isCoerceVar :: Pat -> Maybe (SubstCoerce Pat Type)

subst :: Name Type -> Type -> Pat -> Pat

substs :: [(Name Type, Type)] -> Pat -> Pat

Generic b => Subst Type (Var b)

Methods

isvar :: Var b -> Maybe (SubstName (Var b) Type)

isCoerceVar :: Var b -> Maybe (SubstCoerce (Var b) Type)

subst :: Name Type -> Type -> Var b -> Var b

substs :: [(Name Type, Type)] -> Var b -> Var b

Pretty (Var Type)

Methods

ppr :: LFresh m => Var Type -> m Doc

pprPrec :: LFresh m => Rational -> Var Type -> m Doc

type Rep Type

type Rep Type = D1 * (MetaData "Type" "Clash.Core.Type" "clash-lib-0.99-CApG5XjEMCZFUVyS8kIjXv" False) ((:+:) * ((:+:) * (C1 * (MetaCons "VarTy" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Kind)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * TyName)))) (C1 * (MetaCons "ConstTy" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ConstTy)))) ((:+:) * (C1 * (MetaCons "ForAllTy" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Bind TyVar Type)))) ((:+:) * (C1 * (MetaCons "AppTy" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Type)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Type)))) (C1 * (MetaCons "LitTy" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * LitTy))))))

data TypeView

An easier view on types

Constructors

FunTy !Type !Type

Function type

TyConApp !TyConName [Type]

Applied TyCon

OtherType !Type

Neither of the above

Instances

Show TypeView

Methods

showsPrec :: Int -> TypeView -> ShowS

show :: TypeView -> String

showList :: [TypeView] -> ShowS

data ConstTy

Type Constants

Constructors

TyCon !TyConName

TyCon type

Arrow

Function type

Instances

Show ConstTy

Methods

showsPrec :: Int -> ConstTy -> ShowS

show :: ConstTy -> String

showList :: [ConstTy] -> ShowS

Generic ConstTy

Associated Types

type Rep ConstTy :: * -> *

Methods

from :: ConstTy -> Rep ConstTy x

to :: Rep ConstTy x -> ConstTy

Hashable ConstTy

Methods

hashWithSalt :: Int -> ConstTy -> Int

hash :: ConstTy -> Int

NFData ConstTy

Methods

rnf :: ConstTy -> ()

Alpha ConstTy

Methods

aeq' :: AlphaCtx -> ConstTy -> ConstTy -> Bool

fvAny' :: (Contravariant f, Applicative f) => AlphaCtx -> (AnyName -> f AnyName) -> ConstTy -> f ConstTy

close :: AlphaCtx -> NamePatFind -> ConstTy -> ConstTy

open :: AlphaCtx -> NthPatFind -> ConstTy -> ConstTy

isPat :: ConstTy -> DisjointSet AnyName

isTerm :: ConstTy -> All

isEmbed :: ConstTy -> Bool

nthPatFind :: ConstTy -> NthPatFind

namePatFind :: ConstTy -> NamePatFind

swaps' :: AlphaCtx -> Perm AnyName -> ConstTy -> ConstTy

lfreshen' :: LFresh m => AlphaCtx -> ConstTy -> (ConstTy -> Perm AnyName -> m b) -> m b

freshen' :: Fresh m => AlphaCtx -> ConstTy -> m (ConstTy, Perm AnyName)

acompare' :: AlphaCtx -> ConstTy -> ConstTy -> Ordering

Subst a ConstTy

Methods

isvar :: ConstTy -> Maybe (SubstName ConstTy a)

isCoerceVar :: ConstTy -> Maybe (SubstCoerce ConstTy a)

subst :: Name a -> a -> ConstTy -> ConstTy

substs :: [(Name a, a)] -> ConstTy -> ConstTy

type Rep ConstTy

type Rep ConstTy = D1 * (MetaData "ConstTy" "Clash.Core.Type" "clash-lib-0.99-CApG5XjEMCZFUVyS8kIjXv" False) ((:+:) * (C1 * (MetaCons "TyCon" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * TyConName))) (C1 * (MetaCons "Arrow" PrefixI False) (U1 *)))

data LitTy

Literal Types

Constructors

NumTy !Integer

SymTy !String

Instances

Show LitTy

Methods

showsPrec :: Int -> LitTy -> ShowS

show :: LitTy -> String

showList :: [LitTy] -> ShowS

Generic LitTy

Associated Types

type Rep LitTy :: * -> *

Methods

from :: LitTy -> Rep LitTy x

to :: Rep LitTy x -> LitTy

Hashable LitTy

Methods

hashWithSalt :: Int -> LitTy -> Int

hash :: LitTy -> Int

NFData LitTy

Methods

rnf :: LitTy -> ()

Alpha LitTy

Methods

aeq' :: AlphaCtx -> LitTy -> LitTy -> Bool

fvAny' :: (Contravariant f, Applicative f) => AlphaCtx -> (AnyName -> f AnyName) -> LitTy -> f LitTy

close :: AlphaCtx -> NamePatFind -> LitTy -> LitTy

open :: AlphaCtx -> NthPatFind -> LitTy -> LitTy

isPat :: LitTy -> DisjointSet AnyName

isTerm :: LitTy -> All

isEmbed :: LitTy -> Bool

nthPatFind :: LitTy -> NthPatFind

namePatFind :: LitTy -> NamePatFind

swaps' :: AlphaCtx -> Perm AnyName -> LitTy -> LitTy

lfreshen' :: LFresh m => AlphaCtx -> LitTy -> (LitTy -> Perm AnyName -> m b) -> m b

freshen' :: Fresh m => AlphaCtx -> LitTy -> m (LitTy, Perm AnyName)

acompare' :: AlphaCtx -> LitTy -> LitTy -> Ordering

Pretty LitTy

Methods

ppr :: LFresh m => LitTy -> m Doc

pprPrec :: LFresh m => Rational -> LitTy -> m Doc

Subst a LitTy

Methods

isvar :: LitTy -> Maybe (SubstName LitTy a)

isCoerceVar :: LitTy -> Maybe (SubstCoerce LitTy a)

subst :: Name a -> a -> LitTy -> LitTy

substs :: [(Name a, a)] -> LitTy -> LitTy

type Rep LitTy

type Rep LitTy = D1 * (MetaData "LitTy" "Clash.Core.Type" "clash-lib-0.99-CApG5XjEMCZFUVyS8kIjXv" False) ((:+:) * (C1 * (MetaCons "NumTy" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Integer))) (C1 * (MetaCons "SymTy" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * String))))

type Kind = Type

The level above types

type KindOrType = Type

Either a Kind or a Type

type KiName = Name Kind

Reference to a Kind

type KiOccName = OccName Kind

type TyName = Name Type

Reference to a Type

type TyOccName = OccName Type

type TyVar = Var Type

Type variable

tyView :: Type -> TypeView

An easier view on types

coreView :: HashMap TyConOccName TyCon -> Type -> Maybe Type

A view on types in which newtypes are transparent, the Signal type is transparent, and type functions are evaluated to WHNF (when possible).

Only strips away one "layer".

typeKind :: HashMap TyConOccName TyCon -> Type -> Kind

Determine the kind of a type

mkTyConTy :: TyConName -> Type

Make a Type out of a TyCon

mkFunTy :: Type -> Type -> Type

Make a function type of an argument and result type

mkTyConApp :: TyConName -> [Type] -> Type

Make a TyCon Application out of a TyCon and a list of argument types

splitFunTy :: HashMap TyConOccName TyCon -> Type -> Maybe (Type, Type)

Split a function type in an argument and result type

splitFunTys :: HashMap TyConOccName TyCon -> Type -> ([Type], Type)

splitFunForallTy :: Type -> ([Either TyVar Type], Type)

Split a poly-function type in a: list of type-binders and argument types, and the result type

splitCoreFunForallTy :: HashMap TyConOccName TyCon -> Type -> ([Either TyVar Type], Type)

Split a poly-function type in a: list of type-binders and argument types, and the result type. Looks through Signal and type functions.

splitTyConAppM :: Type -> Maybe (TyConName, [Type])

Split a TyCon Application in a TyCon and its arguments

isPolyFunTy :: Type -> Bool

Is a type a polymorphic or function type?

isPolyFunCoreTy :: HashMap TyConOccName TyCon -> Type -> Bool

Is a type a polymorphic or function type under coreView?

isPolyTy :: Type -> Bool

Is a type polymorphic?

isFunTy :: HashMap TyConOccName TyCon -> Type -> Bool

Is a type a function type?

applyFunTy :: HashMap TyConOccName TyCon -> Type -> Type -> Type

Apply a function type to an argument type and get the result type

applyTy :: Fresh m => HashMap TyConOccName TyCon -> Type -> KindOrType -> m Type

Substitute the type variable of a type (ForAllTy) with another type

findFunSubst :: HashMap TyConOccName TyCon -> [([Type], Type)] -> [Type] -> Maybe Type

reduceTypeFamily :: HashMap TyConOccName TyCon -> Type -> Maybe Type

undefinedTy :: Type

The type of GHC.Err.undefined :: forall a . a

isIntegerTy :: Type -> Bool

normalizeType :: HashMap TyConOccName TyCon -> Type -> Type