CLaSH.Sized.Internal.Index

Datatypes

newtype Index n

Arbitrary-bounded unsigned integer represented by ceil(log_2(n)) bits.

Given an upper bound n, an Index n number has a range of: [0 .. n-1]

>>> maxBound :: Index 8
7
>>> minBound :: Index 8
0
>>> read (show (maxBound :: Index 8)) :: Index 8
7
>>> 1 + 2 :: Index 8
3
>>> 2 + 6 :: Index 8
*** Exception: CLaSH.Sized.Index: result 8 is out of bounds: [0..7]
>>> 1 - 3 :: Index 8
*** Exception: CLaSH.Sized.Index: result -2 is out of bounds: [0..7]
>>> 2 * 3 :: Index 8
6
>>> 2 * 4 :: Index 8
*** Exception: CLaSH.Sized.Index: result 8 is out of bounds: [0..7]

Constructors

I

The constructor, I, and the field, unsafeToInteger, are not synthesisable.

Fields

unsafeToInteger :: Integer

Instances

Resize Index

KnownNat n => Bounded (Index n)

KnownNat n => Enum (Index n)

The functions: enumFrom, enumFromThen, enumFromTo, and enumFromThenTo, are not synthesisable.

Eq (Index n)

KnownNat n => Integral (Index n)

Typeable Nat n => Data (Index n)

KnownNat n => Num (Index n)

Operators report an error on overflow and underflow

Ord (Index n)

KnownNat n => Read (Index n)

None of the Read class' methods are synthesisable.

KnownNat n => Real (Index n)

Show (Index n)

KnownNat n => Arbitrary (Index n)

KnownNat n => CoArbitrary (Index n)

KnownNat n => Default (Index n)

KnownNat n => Lift (Index n)

KnownNat n => BitPack (Index n)

Bundle (Index n)

ExtendingNum (Index m) (Index n)

type Unbundled' clk (Index n) = Signal' clk (Index n)

type BitSize (Index n) = CLog 2 n

type AResult (Index m) (Index n) = Index ((-) ((+) m n) 1)

type MResult (Index m) (Index n) = Index ((+) (* ((-) m 1) ((-) n 1)) 1)

Type classes

BitConvert

pack# :: Index n -> BitVector (CLog 2 n)

unpack# :: KnownNat n => BitVector (CLog 2 n) -> Index n

Eq

eq# :: Index n -> Index n -> Bool

neq# :: Index n -> Index n -> Bool

Ord

lt# :: Index n -> Index n -> Bool

ge# :: Index n -> Index n -> Bool

gt# :: Index n -> Index n -> Bool

le# :: Index n -> Index n -> Bool

Enum (not synthesisable)

enumFrom# :: KnownNat n => Index n -> [Index n]

enumFromThen# :: KnownNat n => Index n -> Index n -> [Index n]

enumFromTo# :: KnownNat n => Index n -> Index n -> [Index n]

enumFromThenTo# :: KnownNat n => Index n -> Index n -> Index n -> [Index n]

Bounded

maxBound# :: KnownNat n => Index n

Num

(+#) :: KnownNat n => Index n -> Index n -> Index n

(-#) :: KnownNat n => Index n -> Index n -> Index n

(*#) :: KnownNat n => Index n -> Index n -> Index n

fromInteger# :: KnownNat n => Integer -> Index n

ExtendingNum

plus# :: Index m -> Index n -> Index ((m + n) - 1)

minus# :: Index m -> Index n -> Index ((m + n) - 1)

times# :: Index m -> Index n -> Index (((m - 1) * (n - 1)) + 1)

Integral

quot# :: Index n -> Index n -> Index n

rem# :: Index n -> Index n -> Index n

toInteger# :: Index n -> Integer

Resize

resize# :: KnownNat m => Index n -> Index m