Copyright | (C) 2013-2015, University of Twente |
---|---|

License | BSD2 (see the file LICENSE) |

Maintainer | Christiaan Baaij <christiaan.baaij@gmail.com> |

Safe Haskell | Trustworthy |

Language | Haskell2010 |

- data Index n

# Documentation

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]

`>>>`

7`maxBound :: Index 8`

`>>>`

0`minBound :: Index 8`

`>>>`

3`1 + 2 :: Index 8`

`>>>`

*** Exception: 8 is out of bounds: [0..7]`2 + 6 :: Index 8`

`>>>`

*** Exception: -2 is out of bounds: [0..7]`1 - 3 :: Index 8`

`>>>`

6`2 * 3 :: Index 8`

`>>>`

*** Exception: 8 is out of bounds: [0..7]`2 * 4 :: Index 8`

KnownNat n => Bounded (Index n) Source | |

KnownNat n => Enum (Index n) Source | The functions: |

Eq (Index n) Source | |

KnownNat n => Integral (Index n) Source | |

KnownNat n => Num (Index n) Source | Operators report an error on overflow and underflow |

Ord (Index n) Source | |

KnownNat n => Real (Index n) Source | |

Show (Index n) Source | |

KnownNat n => Arbitrary (Index n) Source | |

KnownNat n => CoArbitrary (Index n) Source | |

KnownNat n => Default (Index n) Source | |

KnownNat n => Lift (Index n) Source | |

Bundle (Index n) Source | |

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