CLaSH.Core.TyCon

Type Constructors in CoreHW

Documentation

data TyCon

Type Constructor

Constructors

AlgTyCon

Algorithmic DataCons

Fields

• tyConName :: !TyConName

  Name of the TyCon

• tyConKind :: !Kind

  Kind of the TyCon

• tyConArity :: !Int

  Number of type arguments

• algTcRhs :: !AlgTyConRhs

  DataCon definitions

FunTyCon

Function TyCons (e.g. type families)

Fields

• tyConName :: !TyConName

  Name of the TyCon

• tyConKind :: !Kind

  Kind of the TyCon

• tyConArity :: !Int

  Number of type arguments

• tyConSubst :: [([Type], Type)]

  List of: ([LHS match types], RHS type)

PrimTyCon

Primitive TyCons

Fields

• tyConName :: !TyConName

  Name of the TyCon

• tyConKind :: !Kind

  Kind of the TyCon

• tyConArity :: !Int

  Number of type arguments

SuperKindTyCon

To close the loop on the type hierarchy

Fields

• tyConName :: !TyConName

  Name of the TyCon

Instances

Eq TyCon

Methods

(==) :: TyCon -> TyCon -> Bool

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

Ord TyCon

Methods

compare :: TyCon -> TyCon -> Ordering

(<) :: TyCon -> TyCon -> Bool

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

(>) :: TyCon -> TyCon -> Bool

(>=) :: TyCon -> TyCon -> Bool

max :: TyCon -> TyCon -> TyCon

min :: TyCon -> TyCon -> TyCon

Show TyCon

Methods

showsPrec :: Int -> TyCon -> ShowS

show :: TyCon -> String

showList :: [TyCon] -> ShowS

Generic TyCon

Associated Types

type Rep TyCon :: * -> *

Methods

from :: TyCon -> Rep TyCon x

to :: Rep TyCon x -> TyCon

NFData TyCon

Methods

rnf :: TyCon -> ()

Alpha TyCon

Methods

aeq' :: AlphaCtx -> TyCon -> TyCon -> Bool

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

close :: AlphaCtx -> NamePatFind -> TyCon -> TyCon

open :: AlphaCtx -> NthPatFind -> TyCon -> TyCon

isPat :: TyCon -> DisjointSet AnyName

isTerm :: TyCon -> All

isEmbed :: TyCon -> Bool

nthPatFind :: TyCon -> NthPatFind

namePatFind :: TyCon -> NamePatFind

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

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

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

acompare' :: AlphaCtx -> TyCon -> TyCon -> Ordering

Pretty TyCon

Methods

ppr :: (Applicative m, LFresh m) => TyCon -> m Doc

pprPrec :: (Applicative m, LFresh m) => Rational -> TyCon -> m Doc

type Rep TyCon

type Rep TyCon = D1 (MetaData "TyCon" "CLaSH.Core.TyCon" "clash-lib-0.6.21-5TTHCslSvUbAS594RmKIIJ" False) ((:+:) ((:+:) (C1 (MetaCons "AlgTyCon" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "tyConName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TyConName)) (S1 (MetaSel (Just Symbol "tyConKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Kind))) ((:*:) (S1 (MetaSel (Just Symbol "tyConArity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "algTcRhs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AlgTyConRhs))))) (C1 (MetaCons "FunTyCon" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "tyConName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TyConName)) (S1 (MetaSel (Just Symbol "tyConKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Kind))) ((:*:) (S1 (MetaSel (Just Symbol "tyConArity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "tyConSubst") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [([Type], Type)])))))) ((:+:) (C1 (MetaCons "PrimTyCon" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "tyConName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TyConName)) ((:*:) (S1 (MetaSel (Just Symbol "tyConKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Kind)) (S1 (MetaSel (Just Symbol "tyConArity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))) (C1 (MetaCons "SuperKindTyCon" PrefixI True) (S1 (MetaSel (Just Symbol "tyConName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TyConName)))))

type TyConName = Name TyCon

TyCon reference

data AlgTyConRhs

The RHS of an Algebraic Datatype

Constructors

DataTyCon

Fields

• dataCons :: [DataCon]

  The DataCons of a TyCon

NewTyCon

Fields

• dataCon :: !DataCon

  The newtype DataCon

• ntEtadRhs :: ([TyName], Type)

  The argument type of the newtype DataCon in eta-reduced form, which is just the representation of the TyCon. The TyName's are the type-variables from the corresponding TyCon.

Instances

Show AlgTyConRhs

Methods

showsPrec :: Int -> AlgTyConRhs -> ShowS

show :: AlgTyConRhs -> String

showList :: [AlgTyConRhs] -> ShowS

Generic AlgTyConRhs

Associated Types

type Rep AlgTyConRhs :: * -> *

Methods

from :: AlgTyConRhs -> Rep AlgTyConRhs x

to :: Rep AlgTyConRhs x -> AlgTyConRhs

NFData AlgTyConRhs

Methods

rnf :: AlgTyConRhs -> ()

Alpha AlgTyConRhs

Methods

aeq' :: AlphaCtx -> AlgTyConRhs -> AlgTyConRhs -> Bool

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

close :: AlphaCtx -> NamePatFind -> AlgTyConRhs -> AlgTyConRhs

open :: AlphaCtx -> NthPatFind -> AlgTyConRhs -> AlgTyConRhs

isPat :: AlgTyConRhs -> DisjointSet AnyName

isTerm :: AlgTyConRhs -> All

isEmbed :: AlgTyConRhs -> Bool

nthPatFind :: AlgTyConRhs -> NthPatFind

namePatFind :: AlgTyConRhs -> NamePatFind

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

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

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

acompare' :: AlphaCtx -> AlgTyConRhs -> AlgTyConRhs -> Ordering

type Rep AlgTyConRhs

type Rep AlgTyConRhs = D1 (MetaData "AlgTyConRhs" "CLaSH.Core.TyCon" "clash-lib-0.6.21-5TTHCslSvUbAS594RmKIIJ" False) ((:+:) (C1 (MetaCons "DataTyCon" PrefixI True) (S1 (MetaSel (Just Symbol "dataCons") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [DataCon]))) (C1 (MetaCons "NewTyCon" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "dataCon") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DataCon)) (S1 (MetaSel (Just Symbol "ntEtadRhs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ([TyName], Type))))))

mkKindTyCon :: TyConName -> Kind -> TyCon

Create a Kind out of a TyConName

isTupleTyConLike :: TyConName -> Bool

Does the TyCon look like a tuple TyCon

tyConDataCons :: TyCon -> [DataCon]

Get the DataCons belonging to a TyCon