Clash.Class.HasDomain

Documentation

type WithSpecificDomain dom r = (HasSpecificDomain dom r, dom ~ GetDomain dom r)

Type that forces dom to be present in r at least once. Will resolve to a type error if it doesn't. It will always fail if given dom is completely polymorphic and can't be tied to r in any way.

type WithSingleDomain dom r = (HasSingleDomain r, dom ~ GetDomain r)

Type that forces dom to be the same in all subtypes of r that might contain a domain. If given a polymorphic domain not tied to r, GHC will be allowed to infer that that domain is equal to the one in r on the condition that r contains just a single domain.

type family HasDomain (dom :: Domain) (n :: Type) :: HasDomainWrapperResult

Type family that searches a type and checks whether a specific domain is present. Will result in either "domain not found, and no others either", "domain not found, but found another", or "found domain".

Instances

type HasDomain dom1 (Enable dom2)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (Enable dom2) = DomEq dom1 dom2

type HasDomain dom1 (Reset dom2)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (Reset dom2) = DomEq dom1 dom2

type HasDomain dom1 (Clock dom2)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (Clock dom2) = DomEq dom1 dom2

type HasDomain dom (Vec n a)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (Vec n a) = HasDomain dom a

type HasDomain dom1 (Signal dom2 a)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (Signal dom2 a) = DomEq dom1 dom2

type HasDomain dom1 (Proxy dom2)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (Proxy dom2) = DomEq dom1 dom2

type HasDomain dom (a -> b)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a -> b) = Merge dom a b

type HasDomain dom (a, b)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a, b) = Merge dom a b

type HasDomain dom1 (DSignal dom2 delay a)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom1 (DSignal dom2 delay a) = DomEq dom1 dom2

type HasDomain dom (a0, a1, a2)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a0, a1, a2) = Merge dom a0 (a1, a2)

type HasDomain dom1 (BiSignalOut ds dom2 n)

Defined in Clash.Signal.BiSignal

type HasDomain dom1 (BiSignalOut ds dom2 n) = DomEq dom1 dom2

type HasDomain dom (a0, a1, a2, a3)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a0, a1, a2, a3) = Merge dom a0 (a1, a2, a3)

type HasDomain dom (a0, a1, a2, a3, a4)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a0, a1, a2, a3, a4) = Merge dom a0 (a1, a2, a3, a4)

type HasDomain dom (a0, a1, a2, a3, a4, a5)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a0, a1, a2, a3, a4, a5) = Merge dom a0 (a1, a2, a3, a4, a5)

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6) = Merge dom a0 (a1, a2, a3, a4, a5, a6)

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6, a7)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6, a7) = Merge dom a0 (a1, a2, a3, a4, a5, a6, a7)

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6, a7, a8)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6, a7, a8) = Merge dom a0 (a1, a2, a3, a4, a5, a6, a7, a8)

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9) = Merge dom a0 (a1, a2, a3, a4, a5, a6, a7, a8, a9)

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) = Merge dom a0 (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11)

Defined in Clash.Class.HasDomain.HasSpecificDomain

type HasDomain dom (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) = Merge dom a0 (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11)

type family TryDomain (orig :: Type) (n :: Type) :: TryDomainResult

Instances

type TryDomain t Double

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t Double = 'NotFound

type TryDomain t Float

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t Float = 'NotFound

type TryDomain t Int

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t Int = 'NotFound

type TryDomain t Integer

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t Integer = 'NotFound

type TryDomain t Bool

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t Bool = 'NotFound

type TryDomain t ()

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t () = 'NotFound

type TryDomain t (Maybe a)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Maybe a) = TryDomain t a

type TryDomain t (Enable dom)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Enable dom) = 'Found dom

type TryDomain t (Reset dom)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Reset dom) = 'Found dom

type TryDomain t (Clock dom)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Clock dom) = 'Found dom

type TryDomain t (RTree d a)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (RTree d a) = TryDomain t a

type TryDomain t (Vec n a)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Vec n a) = TryDomain t a

type TryDomain t (Proxy dom)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Proxy dom) = 'Found dom

type TryDomain t (Signal dom a)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Signal dom a) = 'Found dom

type TryDomain t (Either a b)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (Either a b) = Merge t a b

type TryDomain t (a, b)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a, b) = Merge t a b

type TryDomain t (a -> b)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a -> b) = Merge t a b

type TryDomain t (DSignal dom delay a)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (DSignal dom delay a) = 'Found dom

type TryDomain t (a0, a1, a2)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a0, a1, a2) = Merge t a0 (a1, a2)

type TryDomain t (BiSignalOut ds dom n)

Defined in Clash.Signal.BiSignal

type TryDomain t (BiSignalOut ds dom n) = 'Found dom

type TryDomain t (a0, a1, a2, a3)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a0, a1, a2, a3) = Merge t a0 (a1, a2, a3)

type TryDomain t (a0, a1, a2, a3, a4)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a0, a1, a2, a3, a4) = Merge t a0 (a1, a2, a3, a4)

type TryDomain t (a0, a1, a2, a3, a4, a5)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a0, a1, a2, a3, a4, a5) = Merge t a0 (a1, a2, a3, a4, a5)

type TryDomain t (a0, a1, a2, a3, a4, a5, a6)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a0, a1, a2, a3, a4, a5, a6) = Merge t a0 (a1, a2, a3, a4, a5, a6)

type TryDomain t (a0, a1, a2, a3, a4, a5, a6, a7)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a0, a1, a2, a3, a4, a5, a6, a7) = Merge t a0 (a1, a2, a3, a4, a5, a6, a7)

type TryDomain t (a0, a1, a2, a3, a4, a5, a6, a7, a8)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a0, a1, a2, a3, a4, a5, a6, a7, a8) = Merge t a0 (a1, a2, a3, a4, a5, a6, a7, a8)

type TryDomain t (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9) = Merge t a0 (a1, a2, a3, a4, a5, a6, a7, a8, a9)

type TryDomain t (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) = Merge t a0 (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)

type TryDomain t (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11)

Defined in Clash.Class.HasDomain.HasSingleDomain

type TryDomain t (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) = Merge t a0 (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11)

data TryDomainResult

Constructors

NotFound

Ambiguous Domain Domain

Found Domain

type DomEq (n :: Domain) (m :: Domain) = IfStuck (DomEqWorker n m) 'NotFound (Pure (DomEqWorker n m))

Check domain for equality. Return 'Found if so, return 'NotFound if not. The reason d'etre for this type family is that _open_ type families don't allow overlapping types. We therefore defer equality checking to a closed type family.