Copyright	(C) 2019 Myrtle Software Ltd 2024 QBayLogic B.V.
License	BSD2 (see the file LICENSE)
Maintainer	QBayLogic B.V. <devops@qaylogic.com>
Safe Haskell	None
Language	Haskell2010

Clash.Class.Exp

Description

Synopsis

Documentation

Type class implementing exponentiation with explicitly resizing results.

Minimal complete definition

Instances details

KnownNat m => Exp (Index m) Source #
Instance details Defined in Clash.Class.Exp Associated Types type ExpResult (Index m) n Source # Methods (^) :: forall (n :: Nat). Index m -> SNat n -> ExpResult (Index m) n Source #
KnownNat m => Exp (Unsigned m) Source #
Instance details Defined in Clash.Class.Exp Associated Types type ExpResult (Unsigned m) n Source # Methods (^) :: forall (n :: Nat). Unsigned m -> SNat n -> ExpResult (Unsigned m) n Source #
KnownNat m => Exp (Signed m) Source #
Instance details Defined in Clash.Class.Exp Associated Types type ExpResult (Signed m) n Source # Methods (^) :: forall (n :: Nat). Signed m -> SNat n -> ExpResult (Signed m) n Source #

type family ExpResult a (n :: Nat) Source #

Instances details

type ExpResult (Index m) n Source #
Instance details Defined in Clash.Class.Exp type ExpResult (Index m) n = Index (Max 2 (m ^ n))
type ExpResult (Unsigned m) n Source #
Instance details Defined in Clash.Class.Exp type ExpResult (Unsigned m) n = Unsigned (Max 1 (m * n))
type ExpResult (Signed m) n Source #
Instance details Defined in Clash.Class.Exp type ExpResult (Signed m) n = Signed (Max 2 (m * n))

(^) infixr 8 Source #

Arguments

:: Exp a
=> a	Base
-> SNat n	Exponent
-> ExpResult a n	Resized result, guaranteed to not have overflown

Exponentiation with known exponent.