CLaSH.Sized.Index

Documentation

data 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
>>> 1 + 2 :: Index 8
3
>>> 2 + 6 :: Index 8
*** Exception: 8 is out of bounds: [0..7]
>>> 1 - 3 :: Index 8
*** Exception: -2 is out of bounds: [0..7]
>>> 2 * 3 :: Index 8
6
>>> 2 * 4 :: Index 8
*** Exception: 8 is out of bounds: [0..7]

Instances

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)

KnownNat n => Num (Index n)

Operators report an error on overflow and underflow

Ord (Index n)

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)

Bundle (Index n)

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