Clash.Class.Num

Arithmetic functions for arguments and results of different precision

class ExtendingNum a b where

Adding, subtracting, and multiplying values of two different (sub-)types.

Associated Types

type AResult a b

Type of the result of the addition or subtraction

type MResult a b

Type of the result of the multiplication

Methods

add :: a -> b -> AResult a b

Add values of different (sub-)types, return a value of a (sub-)type that is potentially different from either argument.

sub :: a -> b -> AResult a b

Subtract values of different (sub-)types, return a value of a (sub-)type that is potentially different from either argument.

mul :: a -> b -> MResult a b

Multiply values of different (sub-)types, return a value of a (sub-)type that is potentially different from either argument.

Instances

(KnownNat m, KnownNat n) => ExtendingNum (BitVector m) (BitVector n)

Defined in Clash.Sized.Internal.BitVector

Associated Types

type AResult (BitVector m) (BitVector n)

type MResult (BitVector m) (BitVector n)

Methods

add :: BitVector m -> BitVector n -> AResult (BitVector m) (BitVector n)

sub :: BitVector m -> BitVector n -> AResult (BitVector m) (BitVector n)

mul :: BitVector m -> BitVector n -> MResult (BitVector m) (BitVector n)

ExtendingNum (Index m) (Index n)

Defined in Clash.Sized.Internal.Index

Associated Types

type AResult (Index m) (Index n)

type MResult (Index m) (Index n)

Methods

add :: Index m -> Index n -> AResult (Index m) (Index n)

sub :: Index m -> Index n -> AResult (Index m) (Index n)

mul :: Index m -> Index n -> MResult (Index m) (Index n)

(KnownNat m, KnownNat n) => ExtendingNum (Unsigned m) (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Associated Types

type AResult (Unsigned m) (Unsigned n)

type MResult (Unsigned m) (Unsigned n)

Methods

add :: Unsigned m -> Unsigned n -> AResult (Unsigned m) (Unsigned n)

sub :: Unsigned m -> Unsigned n -> AResult (Unsigned m) (Unsigned n)

mul :: Unsigned m -> Unsigned n -> MResult (Unsigned m) (Unsigned n)

ExtendingNum (Signed m) (Signed n)

Defined in Clash.Sized.Internal.Signed

Associated Types

type AResult (Signed m) (Signed n)

type MResult (Signed m) (Signed n)

Methods

add :: Signed m -> Signed n -> AResult (Signed m) (Signed n)

sub :: Signed m -> Signed n -> AResult (Signed m) (Signed n)

mul :: Signed m -> Signed n -> MResult (Signed m) (Signed n)

ENumFixedC rep int1 frac1 int2 frac2 => ExtendingNum (Fixed rep int1 frac1) (Fixed rep int2 frac2)

When used in a polymorphic setting, use the following Constraint synonyms for less verbose type signatures:

• ENumFixedC rep frac1 frac2 size1 size2 for: Fixed
• ENumSFixedC int1 frac1 int2 frac2 for: SFixed
• ENumUFixedC int1 frac1 int2 frac2 for: UFixed

Defined in Clash.Sized.Fixed

Associated Types

type AResult (Fixed rep int1 frac1) (Fixed rep int2 frac2)

type MResult (Fixed rep int1 frac1) (Fixed rep int2 frac2)

Methods

add :: Fixed rep int1 frac1 -> Fixed rep int2 frac2 -> AResult (Fixed rep int1 frac1) (Fixed rep int2 frac2)

sub :: Fixed rep int1 frac1 -> Fixed rep int2 frac2 -> AResult (Fixed rep int1 frac1) (Fixed rep int2 frac2)

mul :: Fixed rep int1 frac1 -> Fixed rep int2 frac2 -> MResult (Fixed rep int1 frac1) (Fixed rep int2 frac2)

Saturating arithmetic functions

data SaturationMode

Determine how overflow and underflow are handled by the functions in SaturatingNum

Constructors

SatWrap

Wrap around on overflow and underflow

SatBound

Become maxBound on overflow, and minBound on underflow

SatZero

Become 0 on overflow and underflow

SatSymmetric

Become maxBound on overflow, and (minBound + 1) on underflow for signed numbers, and minBound for unsigned numbers.

SatError

Become an XException on overflow and underflow

Instances

Bounded SaturationMode

Defined in Clash.Class.Num

Methods

minBound :: SaturationMode

maxBound :: SaturationMode

Enum SaturationMode

Defined in Clash.Class.Num

Methods

succ :: SaturationMode -> SaturationMode

pred :: SaturationMode -> SaturationMode

toEnum :: Int -> SaturationMode

fromEnum :: SaturationMode -> Int

enumFrom :: SaturationMode -> [SaturationMode]

enumFromThen :: SaturationMode -> SaturationMode -> [SaturationMode]

enumFromTo :: SaturationMode -> SaturationMode -> [SaturationMode]

enumFromThenTo :: SaturationMode -> SaturationMode -> SaturationMode -> [SaturationMode]

Eq SaturationMode

Defined in Clash.Class.Num

Methods

(==) :: SaturationMode -> SaturationMode -> Bool

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

Show SaturationMode

Defined in Clash.Class.Num

Methods

showsPrec :: Int -> SaturationMode -> ShowS

show :: SaturationMode -> String

showList :: [SaturationMode] -> ShowS

class (Bounded a, Num a) => SaturatingNum a where

Num operators in which overflow and underflow behavior can be specified using SaturationMode.

Minimal complete definition

satAdd, satSub, satMul

Methods

satAdd :: SaturationMode -> a -> a -> a

Addition with parameterizable over- and underflow behavior

satSub :: SaturationMode -> a -> a -> a

Subtraction with parameterizable over- and underflow behavior

satMul :: SaturationMode -> a -> a -> a

Multiplication with parameterizable over- and underflow behavior

satSucc :: SaturationMode -> a -> a

Get successor of (or in other words, add 1 to) given number

satPred :: SaturationMode -> a -> a

Get predecessor of (or in other words, subtract 1 from) given number

Instances

KnownNat n => SaturatingNum (BitVector n)

Defined in Clash.Sized.Internal.BitVector

Methods

satAdd :: SaturationMode -> BitVector n -> BitVector n -> BitVector n

satSub :: SaturationMode -> BitVector n -> BitVector n -> BitVector n

satMul :: SaturationMode -> BitVector n -> BitVector n -> BitVector n

satSucc :: SaturationMode -> BitVector n -> BitVector n

satPred :: SaturationMode -> BitVector n -> BitVector n

(KnownNat n, 1 <= n) => SaturatingNum (Index n)

Defined in Clash.Sized.Internal.Index

Methods

satAdd :: SaturationMode -> Index n -> Index n -> Index n

satSub :: SaturationMode -> Index n -> Index n -> Index n

satMul :: SaturationMode -> Index n -> Index n -> Index n

satSucc :: SaturationMode -> Index n -> Index n

satPred :: SaturationMode -> Index n -> Index n

KnownNat n => SaturatingNum (Unsigned n)

Defined in Clash.Sized.Internal.Unsigned

Methods

satAdd :: SaturationMode -> Unsigned n -> Unsigned n -> Unsigned n

satSub :: SaturationMode -> Unsigned n -> Unsigned n -> Unsigned n

satMul :: SaturationMode -> Unsigned n -> Unsigned n -> Unsigned n

satSucc :: SaturationMode -> Unsigned n -> Unsigned n

satPred :: SaturationMode -> Unsigned n -> Unsigned n

KnownNat n => SaturatingNum (Signed n)

Defined in Clash.Sized.Internal.Signed

Methods

satAdd :: SaturationMode -> Signed n -> Signed n -> Signed n

satSub :: SaturationMode -> Signed n -> Signed n -> Signed n

satMul :: SaturationMode -> Signed n -> Signed n -> Signed n

satSucc :: SaturationMode -> Signed n -> Signed n

satPred :: SaturationMode -> Signed n -> Signed n

NumFixedC rep int frac => SaturatingNum (Fixed rep int frac)

Defined in Clash.Sized.Fixed

Methods

satAdd :: SaturationMode -> Fixed rep int frac -> Fixed rep int frac -> Fixed rep int frac

satSub :: SaturationMode -> Fixed rep int frac -> Fixed rep int frac -> Fixed rep int frac

satMul :: SaturationMode -> Fixed rep int frac -> Fixed rep int frac -> Fixed rep int frac

satSucc :: SaturationMode -> Fixed rep int frac -> Fixed rep int frac

satPred :: SaturationMode -> Fixed rep int frac -> Fixed rep int frac

boundedAdd :: SaturatingNum a => a -> a -> a

Addition that clips to maxBound on overflow, and minBound on underflow

boundedSub :: SaturatingNum a => a -> a -> a

Subtraction that clips to maxBound on overflow, and minBound on underflow

boundedMul :: SaturatingNum a => a -> a -> a

Multiplication that clips to maxBound on overflow, and minBound on underflow