Fix out-of-bounds natural generation of genBitVector (#2704)

lmbollen · web-flow · commit 6ccbf50eea60 · 2024-04-09T08:04:36.000+02:00
diff --git a/changelog/2024-04-08T16_56_08+02_00_fix_genBitVector b/changelog/2024-04-08T16_56_08+02_00_fix_genBitVector
@@ -0,0 +1 @@
+FIXED: `genBitVector` no longer contains off-by-one error on for generated Naturals
diff --git a/clash-prelude-hedgehog/src/Clash/Hedgehog/Sized/BitVector.hs b/clash-prelude-hedgehog/src/Clash/Hedgehog/Sized/BitVector.hs
@@ -1,5 +1,5 @@
 {-|
-Copyright   : (C) 2021-2022, QBayLogic B.V.
+Copyright   : (C) 2021-2024, QBayLogic B.V.
 License     : BSD2 (see the file LICENSE)
 Maintainer  : QBayLogic B.V. <devops@qbaylogic.com>
 
@@ -68,7 +68,7 @@ genBitVector =
     , (10, Gen.constant undefined#)
     ]
  where
-  genNatural = Gen.integral $ constant 0 (2^natToNatural @n)
+  genNatural = Gen.integral $ constant 0 (2^natToNatural @n - 1)
 
 data SomeBitVector atLeast where
   SomeBitVector :: SNat n -> BitVector (atLeast + n) -> SomeBitVector atLeast

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+FIXED: `genBitVector` no longer contains off-by-one error on for generated Naturals