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.

Minimal complete definition

plus, minus, times

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

plus :: 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.

minus :: 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.

times :: 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)

Associated Types

type AResult (BitVector m) (BitVector n) :: *

type MResult (BitVector m) (BitVector n) :: *

Methods

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

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

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

ExtendingNum (Index m) (Index n)

Associated Types

type AResult (Index m) (Index n) :: *

type MResult (Index m) (Index n) :: *

Methods

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

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

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

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

Associated Types

type AResult (Unsigned m) (Unsigned n) :: *

type MResult (Unsigned m) (Unsigned n) :: *

Methods

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

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

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

ExtendingNum (Signed m) (Signed n)

Associated Types

type AResult (Signed m) (Signed n) :: *

type MResult (Signed m) (Signed n) :: *

Methods

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

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

times :: 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

Associated Types

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

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

Methods

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

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

times :: 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.

Instances

Eq SaturationMode

Methods

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

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

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

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

Minimal complete definition

satPlus, satMin, satMult

Methods

satPlus :: SaturationMode -> a -> a -> a

Addition with parametrisable over- and underflow behaviour

satMin :: SaturationMode -> a -> a -> a

Subtraction with parametrisable over- and underflow behaviour

satMult :: SaturationMode -> a -> a -> a

Multiplication with parametrisable over- and underflow behaviour

Instances

KnownNat n => SaturatingNum (BitVector n)

Methods

satPlus :: SaturationMode -> BitVector n -> BitVector n -> BitVector n

satMin :: SaturationMode -> BitVector n -> BitVector n -> BitVector n

satMult :: SaturationMode -> BitVector n -> BitVector n -> BitVector n

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

Methods

satPlus :: SaturationMode -> Index n -> Index n -> Index n

satMin :: SaturationMode -> Index n -> Index n -> Index n

satMult :: SaturationMode -> Index n -> Index n -> Index n

KnownNat n => SaturatingNum (Unsigned n)

Methods

satPlus :: SaturationMode -> Unsigned n -> Unsigned n -> Unsigned n

satMin :: SaturationMode -> Unsigned n -> Unsigned n -> Unsigned n

satMult :: SaturationMode -> Unsigned n -> Unsigned n -> Unsigned n

KnownNat n => SaturatingNum (Signed n)

Methods

satPlus :: SaturationMode -> Signed n -> Signed n -> Signed n

satMin :: SaturationMode -> Signed n -> Signed n -> Signed n

satMult :: SaturationMode -> Signed n -> Signed n -> Signed n

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

Methods

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

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

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

boundedPlus :: SaturatingNum a => a -> a -> a

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

boundedMin :: SaturatingNum a => a -> a -> a

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

boundedMult :: SaturatingNum a => a -> a -> a

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