CLaSH.Class.Num

Documentation

class Add a b where

Implicitly adding or subtracting values of two different (sub-)types.

Associated Types

type AResult a b

Methods

plus :: a -> b -> AResult a b

minus :: a -> b -> AResult a b

Instances

KnownNat (Max m n) => Add (Signed m) (Signed n)

KnownNat (Max m n) => Add (Unsigned m) (Unsigned n)

AddFixed rep frac1 frac2 size1 size2 => Add (Fixed frac1 rep size1) (Fixed frac2 rep size2)

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

• AddFixed rep frac1 frac2 size1 size2 for: Fixed
• AddSFixed int1 frac1 int2 frac2 for: SFixed
• AddUFixed int1 frac1 int2 frac2 for: UFixed

class Mult a b where

Implicitly multiplying values of two different (sub-)types.

Associated Types

type MResult a b

Methods

mult :: a -> b -> MResult a b

Instances

KnownNat ((+) m n) => Mult (Signed m) (Signed n)

KnownNat ((+) m n) => Mult (Unsigned m) (Unsigned n)

MultFixed rep frac1 frac2 size1 size2 => Mult (Fixed frac1 rep size1) (Fixed frac2 rep size2)

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

• MultFixed rep frac1 frac2 size1 size2 for: Fixed
• MultSFixed int1 frac1 int2 frac2 for: SFixed
• MultUFixed int1 frac1 int2 frac2 for: UFixed

class Resize f where

Coerce a value to be represented by a different number of bits

Methods

resize :: (KnownNat a, KnownNat b) => f a -> f b

Instances

Resize Signed

A sign-preserving resize operation

Increasing the size of the number replicates the sign bit to the left. Truncating a number to length L keeps the sign bit and the rightmost L-1 bits.

Resize Unsigned

A resize operation that zero-extends on extension, and wraps on truncation.

Increasing the size of the number extends with zeros to the left. Truncating a number of length N to a length L just removes the left (most significant) N-L bits.