Add test cases for tuple utilites (generated by Claude)

krame505 · krame505 · commit bbcfc566c690 · 2026-01-13T18:00:28.000-08:00
diff --git a/testsuite/bsc.lib/Prelude/AppendTuple.bs b/testsuite/bsc.lib/Prelude/AppendTuple.bs
@@ -0,0 +1,134 @@
+package AppendTuple where
+
+-- Test the AppendTuple type class
+
+{-# verilog sysAppendTuple #-}
+sysAppendTuple :: Module Empty
+sysAppendTuple =
+  module
+    counter :: Reg (UInt 5) <- mkReg 0
+
+    rules
+      "test0": when counter == 0 ==> action
+        $display "=== Testing AppendTuple ==="
+        -- Test appendTuple with two empty tuples
+        let u1 :: ()
+            u1 = ()
+        let u2 :: ()
+            u2 = ()
+        let result :: ()
+            result = appendTuple u1 u2
+        $display "appendTuple((), ()) = () [unit type]"
+        counter := counter + 1
+
+      "test1": when counter == 1 ==> action
+        -- Test appendTuple with unit type (left)
+        let t1 :: (Bool, Int 8)
+            t1 = (True, 42)
+        let t2 :: (Bool, Int 8)
+            t2 = appendTuple () t1
+        $display "appendTuple((), (True, 42)) = (%b, %0d)" (tpl_1 t2) (tpl_2 t2)
+        counter := counter + 1
+
+      "test2": when counter == 2 ==> action
+        -- Test appendTuple with unit type (right)
+        let t1 :: (Bool, Int 8)
+            t1 = (False, negate 10)
+        let t2 :: (Bool, Int 8)
+            t2 = appendTuple t1 ()
+        $display "appendTuple((False, -10), ()) = (%b, %0d)" (tpl_1 t2) (tpl_2 t2)
+        counter := counter + 1
+
+      "test3": when counter == 3 ==> action
+        -- Test append two 2-tuples to create 4-tuple
+        let t1 :: (Bool, Int 8)
+            t1 = (True, 5)
+        let t2 :: (UInt 4, Bit 3)
+            t2 = (12, 0b101)
+        let t4 :: (Bool, Int 8, UInt 4, Bit 3)
+            t4 = appendTuple t1 t2
+        $display "appendTuple((True, 5), (12, 0b101)) = (%b, %0d, %0d, %b)" (tpl_1 t4) (tpl_2 t4) (tpl_3 t4) (tpl_4 t4)
+        counter := counter + 1
+
+      "test4": when counter == 4 ==> action
+        -- Test append single element and 2-tuple to create 3-tuple
+        let b :: Bool
+            b = False
+        let t2 :: (Int 8, UInt 4)
+            t2 = (negate 3, 7)
+        let t3 :: (Bool, Int 8, UInt 4)
+            t3 = appendTuple b t2
+        $display "appendTuple(False, (-3, 7)) = (%b, %0d, %0d)" (tpl_1 t3) (tpl_2 t3) (tpl_3 t3)
+        counter := counter + 1
+
+      "test5": when counter == 5 ==> action
+        -- Test append 3-tuple and single element to create 4-tuple
+        let t3 :: (Bool, Int 8, UInt 4)
+            t3 = (True, 20, 8)
+        let b :: Bit 5
+            b = 0b11010
+        let t4 :: (Bool, Int 8, UInt 4, Bit 5)
+            t4 = appendTuple t3 b
+        $display "appendTuple((True, 20, 8), 0b11010) = (%b, %0d, %0d, %b)" (tpl_1 t4) (tpl_2 t4) (tpl_3 t4) (tpl_4 t4)
+        counter := counter + 1
+
+      "test6": when counter == 6 ==> action
+        -- Test append 2-tuple and 3-tuple to create 5-tuple
+        let t2 :: (Bool, Int 8)
+            t2 = (False, 15)
+        let t3 :: (UInt 4, Bit 3, Int 16)
+            t3 = (6, 0b111, negate 100)
+        let t5 :: (Bool, Int 8, UInt 4, Bit 3, Int 16)
+            t5 = appendTuple t2 t3
+        $display "appendTuple((False, 15), (6, 0b111, -100)) = (%b, %0d, %0d, %b, %0d)" (tpl_1 t5) (tpl_2 t5) (tpl_3 t5) (tpl_4 t5) (tpl_5 t5)
+        $display ""
+        $display "=== Testing splitTuple ==="
+        counter := counter + 1
+
+      "test7": when counter == 7 ==> action
+        -- Test splitTuple: 4-tuple into 2-tuple and 2-tuple
+        let t4 :: (Bool, Int 8, UInt 4, Bit 3)
+            t4 = (True, negate 15, 9, 0b110)
+        let split :: ((Bool, Int 8), (UInt 4, Bit 3))
+            split = splitTuple t4
+            (t1, t2) = split
+        $display "splitTuple((True, -15, 9, 0b110)) = ((%b, %0d), (%0d, %b))" (tpl_1 t1) (tpl_2 t1) (tpl_1 t2) (tpl_2 t2)
+        counter := counter + 1
+
+      "test8": when counter == 8 ==> action
+        -- Test splitTuple: 3-tuple into single and 2-tuple
+        let t3 :: (Bool, Int 8, UInt 4)
+            t3 = (False, 33, 15)
+        let split :: (Bool, (Int 8, UInt 4))
+            split = splitTuple t3
+            (b, t2) = split
+        $display "splitTuple((False, 33, 15)) = (%b, (%0d, %0d))" b (tpl_1 t2) (tpl_2 t2)
+        counter := counter + 1
+
+      "test9": when counter == 9 ==> action
+        -- Test splitTuple: 5-tuple into 2-tuple and 3-tuple
+        let t5 :: (Bool, Int 8, UInt 4, Bit 3, Int 16)
+            t5 = (True, 50, 11, 0b001, negate 200)
+        let split :: ((Bool, Int 8), (UInt 4, Bit 3, Int 16))
+            split = splitTuple t5
+            (t2, t3) = split
+        $display "splitTuple((True, 50, 11, 0b001, -200)) = ((%b, %0d), (%0d, %b, %0d))" (tpl_1 t2) (tpl_2 t2) (tpl_1 t3) (tpl_2 t3) (tpl_3 t3)
+        $display ""
+        $display "=== Round-trip test ==="
+        counter := counter + 1
+
+      "test10": when counter == 10 ==> action
+        -- Test appendTuple and splitTuple round-trip
+        let t1 :: (Bool, Int 8)
+            t1 = (True, 42)
+        let t2 :: (UInt 4, Bit 5)
+            t2 = (13, 0b10101)
+        let t4 :: (Bool, Int 8, UInt 4, Bit 5)
+            t4 = appendTuple t1 t2
+        let split :: ((Bool, Int 8), (UInt 4, Bit 5))
+            split = splitTuple t4
+            (r1, r2) = split
+        $display "appendTuple/splitTuple round-trip: ((%b, %0d), (%0d, %b))" (tpl_1 r1) (tpl_2 r1) (tpl_1 r2) (tpl_2 r2)
+        $display ""
+        $display "All AppendTuple tests passed"
+        $finish 0
diff --git a/testsuite/bsc.lib/Prelude/Prelude.exp b/testsuite/bsc.lib/Prelude/Prelude.exp
@@ -6,3 +6,5 @@ test_c_veri_bsv Eq2
 compile_verilog_fail_no_internal_error Eq3
 
 test_c_veri_bs_modules TuplePack {}
+test_c_veri_bs_modules TupleSize {}
+test_c_veri_bs_modules AppendTuple {}
diff --git a/testsuite/bsc.lib/Prelude/TupleSize.bs b/testsuite/bsc.lib/Prelude/TupleSize.bs
@@ -0,0 +1,71 @@
+package TupleSize where
+
+-- Test the TupleSize type class by using it in proviso constraints
+
+-- Helper function that requires TupleSize constraint
+tupleSize :: (TupleSize t n) => t -> Integer
+tupleSize _ = valueOf n
+
+{-# verilog sysTupleSize #-}
+sysTupleSize :: Module Empty
+sysTupleSize = module
+  rules
+    "test": when True ==> action
+      $display "=== Testing TupleSize type class ==="
+
+      -- Test TupleSize for unit type
+      let u :: ()
+          u = ()
+      let size0 = tupleSize u
+      $display "TupleSize of () = %0d (expected 0)" size0
+
+      -- Test TupleSize for single element (non-tuple)
+      let b :: Bool
+          b = True
+      let size1 = tupleSize b
+      $display "TupleSize of Bool = %0d (expected 1)" size1
+
+      -- Test TupleSize for 2-tuple
+      let t2 :: (Bool, Int 8)
+          t2 = (True, 0)
+      let size2 = tupleSize t2
+      $display "TupleSize of Tuple2 = %0d (expected 2)" size2
+
+      -- Test TupleSize for 3-tuple
+      let t3 :: (Bool, Int 8, UInt 4)
+          t3 = (True, 0, 0)
+      let size3 = tupleSize t3
+      $display "TupleSize of Tuple3 = %0d (expected 3)" size3
+
+      -- Test TupleSize for 4-tuple
+      let t4 :: (Bool, Int 8, UInt 4, Bit 5)
+          t4 = (True, 0, 0, 0)
+      let size4 = tupleSize t4
+      $display "TupleSize of Tuple4 = %0d (expected 4)" size4
+
+      -- Test TupleSize for 5-tuple
+      let t5 :: (Bool, Int 8, UInt 4, Bit 5, Int 16)
+          t5 = (True, 0, 0, 0, 0)
+      let size5 = tupleSize t5
+      $display "TupleSize of Tuple5 = %0d (expected 5)" size5
+
+      -- Test TupleSize for 6-tuple
+      let t6 :: (Bool, Int 8, UInt 4, Bit 5, Int 16, UInt 3)
+          t6 = (True, 0, 0, 0, 0, 0)
+      let size6 = tupleSize t6
+      $display "TupleSize of Tuple6 = %0d (expected 6)" size6
+
+      -- Test TupleSize for 7-tuple
+      let t7 :: (Bool, Int 8, UInt 4, Bit 5, Int 16, UInt 3, Bit 2)
+          t7 = (True, 0, 0, 0, 0, 0, 0)
+      let size7 = tupleSize t7
+      $display "TupleSize of Tuple7 = %0d (expected 7)" size7
+
+      -- Test TupleSize for 8-tuple
+      let t8 :: (Bool, Int 8, UInt 4, Bit 5, Int 16, UInt 3, Bit 2, Int 32)
+          t8 = (True, 0, 0, 0, 0, 0, 0, 0)
+      let size8 = tupleSize t8
+      $display "TupleSize of Tuple8 = %0d (expected 8)" size8
+
+      $display "All TupleSize type class tests passed"
+      $finish 0
diff --git a/testsuite/bsc.lib/Prelude/sysAppendTuple.out.expected b/testsuite/bsc.lib/Prelude/sysAppendTuple.out.expected
@@ -0,0 +1,18 @@
+=== Testing AppendTuple ===
+appendTuple((), ()) = () [unit type]
+appendTuple((), (True, 42)) = (1, 42)
+appendTuple((False, -10), ()) = (0, -10)
+appendTuple((True, 5), (12, 0b101)) = (1, 5, 12, 101)
+appendTuple(False, (-3, 7)) = (0, -3, 7)
+appendTuple((True, 20, 8), 0b11010) = (1, 20, 8, 11010)
+appendTuple((False, 15), (6, 0b111, -100)) = (0, 15, 6, 111, -100)
+
+=== Testing splitTuple ===
+splitTuple((True, -15, 9, 0b110)) = ((1, -15), (9, 110))
+splitTuple((False, 33, 15)) = (0, (33, 15))
+splitTuple((True, 50, 11, 0b001, -200)) = ((1, 50), (11, 001, -200))
+
+=== Round-trip test ===
+appendTuple/splitTuple round-trip: ((1, 42), (13, 10101))
+
+All AppendTuple tests passed
diff --git a/testsuite/bsc.lib/Prelude/sysTupleSize.out.expected b/testsuite/bsc.lib/Prelude/sysTupleSize.out.expected
@@ -0,0 +1,11 @@
+=== Testing TupleSize type class ===
+TupleSize of () = 0 (expected 0)
+TupleSize of Bool = 1 (expected 1)
+TupleSize of Tuple2 = 2 (expected 2)
+TupleSize of Tuple3 = 3 (expected 3)
+TupleSize of Tuple4 = 4 (expected 4)
+TupleSize of Tuple5 = 5 (expected 5)
+TupleSize of Tuple6 = 6 (expected 6)
+TupleSize of Tuple7 = 7 (expected 7)
+TupleSize of Tuple8 = 8 (expected 8)
+All TupleSize type class tests passed
diff --git a/testsuite/bsc.lib/vector/ConcatTuple.bs b/testsuite/bsc.lib/vector/ConcatTuple.bs
@@ -0,0 +1,140 @@
+package ConcatTuple where
+
+import Vector
+
+-- Test the ConcatTuple type class
+
+{-# verilog sysConcatTuple #-}
+sysConcatTuple :: Module Empty
+sysConcatTuple =
+  module
+    counter :: Reg (UInt 6) <- mkReg 0
+
+    rules
+      "test0": when counter == 0 ==> action
+        $display "=== Testing ConcatTuple ==="
+        -- Test empty vector to unit type
+        let empty :: Vector 0 (Bool, Int 8)
+            empty = nil
+        let unit :: ()
+            unit = concatTuple empty
+        $display "concatTuple(empty_vector) = () [unit type]"
+        counter := counter + 1
+
+      "test1": when counter == 1 ==> action
+        -- Test single element vector
+        let v1 :: Vector 1 (Bool, Int 8)
+            v1 = (True, 25) :> nil
+        let result :: (Bool, Int 8)
+            result = concatTuple v1
+        $display "concatTuple([(True, 25)]) = (%b, %0d)" (tpl_1 result) (tpl_2 result)
+        counter := counter + 1
+
+      "test2": when counter == 2 ==> action
+        -- Test vector of 3 single elements to 3-tuple
+        let v3 :: Vector 3 (Int 8)
+            v3 = 10 :> 20 :> 30 :> nil
+        let t3 :: (Int 8, Int 8, Int 8)
+            t3 = concatTuple v3
+        $display "concatTuple([10, 20, 30]) = (%0d, %0d, %0d)" (tpl_1 t3) (tpl_2 t3) (tpl_3 t3)
+        counter := counter + 1
+
+      "test3": when counter == 3 ==> action
+        -- Test vector of 4 single elements to 4-tuple
+        let v4 :: Vector 4 (UInt 4)
+            v4 = 1 :> 2 :> 3 :> 4 :> nil
+        let t4 :: (UInt 4, UInt 4, UInt 4, UInt 4)
+            t4 = concatTuple v4
+        $display "concatTuple([1, 2, 3, 4]) = (%0d, %0d, %0d, %0d)" (tpl_1 t4) (tpl_2 t4) (tpl_3 t4) (tpl_4 t4)
+        counter := counter + 1
+
+      "test4": when counter == 4 ==> action
+        -- Test vector of 2 pairs to 4-tuple
+        let v2 :: Vector 2 (Bool, Int 8)
+            v2 = (True, 5) :> (False, negate 12) :> nil
+        let t4 :: (Bool, Int 8, Bool, Int 8)
+            t4 = concatTuple v2
+        $display "concatTuple([(True, 5), (False, -12)]) = (%b, %0d, %b, %0d)" (tpl_1 t4) (tpl_2 t4) (tpl_3 t4) (tpl_4 t4)
+        counter := counter + 1
+
+      "test5": when counter == 5 ==> action
+        -- Test vector of 3 pairs to 6-tuple
+        let v3 :: Vector 3 (UInt 4, Bit 3)
+            v3 = (1, 0b001) :> (2, 0b010) :> (3, 0b011) :> nil
+        let t6 :: (UInt 4, Bit 3, UInt 4, Bit 3, UInt 4, Bit 3)
+            t6 = concatTuple v3
+        $display "concatTuple([(1, 0b001), (2, 0b010), (3, 0b011)]) = (%0d, %b, %0d, %b, %0d, %b)" (tpl_1 t6) (tpl_2 t6) (tpl_3 t6) (tpl_4 t6) (tpl_5 t6) (tpl_6 t6)
+        counter := counter + 1
+
+      "test6": when counter == 6 ==> action
+        -- Test vector of 2 triples to 6-tuple
+        let v2 :: Vector 2 (Bool, Int 8, UInt 4)
+            v2 = (True, 10, 5) :> (False, negate 20, 8) :> nil
+        let t6 :: (Bool, Int 8, UInt 4, Bool, Int 8, UInt 4)
+            t6 = concatTuple v2
+        $display "concatTuple([(True, 10, 5), (False, -20, 8)]) = (%b, %0d, %0d, %b, %0d, %0d)" (tpl_1 t6) (tpl_2 t6) (tpl_3 t6) (tpl_4 t6) (tpl_5 t6) (tpl_6 t6)
+        $display ""
+        $display "=== Testing unconcatTuple ==="
+        counter := counter + 1
+
+      "test7": when counter == 7 ==> action
+        -- Test 4-tuple to vector of 4 singles
+        let t4 :: (Int 8, Int 8, Int 8, Int 8)
+            t4 = (7, 8, 9, 10)
+        let v4 :: Vector 4 (Int 8)
+            v4 = unconcatTuple t4
+        $display "unconcatTuple((7, 8, 9, 10)) = [%0d, %0d, %0d, %0d]" (v4 !! 0) (v4 !! 1) (v4 !! 2) (v4 !! 3)
+        counter := counter + 1
+
+      "test8": when counter == 8 ==> action
+        -- Test 4-tuple to vector of 2 pairs
+        let t4 :: (Bool, Int 8, Bool, Int 8)
+            t4 = (False, 100, True, negate 50)
+        let v2 :: Vector 2 (Bool, Int 8)
+            v2 = unconcatTuple t4
+        $display "unconcatTuple((False, 100, True, -50)) = [(%b, %0d), (%b, %0d)]" (tpl_1 (v2 !! 0)) (tpl_2 (v2 !! 0)) (tpl_1 (v2 !! 1)) (tpl_2 (v2 !! 1))
+        counter := counter + 1
+
+      "test9": when counter == 9 ==> action
+        -- Test 6-tuple to vector of 3 pairs
+        let t6 :: (UInt 4, Bit 2, UInt 4, Bit 2, UInt 4, Bit 2)
+            t6 = (5, 0b00, 10, 0b01, 15, 0b10)
+        let v3 :: Vector 3 (UInt 4, Bit 2)
+            v3 = unconcatTuple t6
+        $display "unconcatTuple((5, 0b00, 10, 0b01, 15, 0b10)) = [(%0d, %b), (%0d, %b), (%0d, %b)]" (tpl_1 (v3 !! 0)) (tpl_2 (v3 !! 0)) (tpl_1 (v3 !! 1)) (tpl_2 (v3 !! 1)) (tpl_1 (v3 !! 2)) (tpl_2 (v3 !! 2))
+        counter := counter + 1
+
+      "test10": when counter == 10 ==> action
+        -- Test 6-tuple to vector of 2 triples
+        let t6 :: (Bool, Int 8, UInt 4, Bool, Int 8, UInt 4)
+            t6 = (True, 15, 3, False, negate 25, 7)
+        let v2 :: Vector 2 (Bool, Int 8, UInt 4)
+            v2 = unconcatTuple t6
+        $display "unconcatTuple((True, 15, 3, False, -25, 7)) = [(%b, %0d, %0d), (%b, %0d, %0d)]" (tpl_1 (v2 !! 0)) (tpl_2 (v2 !! 0)) (tpl_3 (v2 !! 0)) (tpl_1 (v2 !! 1)) (tpl_2 (v2 !! 1)) (tpl_3 (v2 !! 1))
+        $display ""
+        $display "=== Round-trip test ==="
+        counter := counter + 1
+
+      "test11": when counter == 11 ==> action
+        -- Test concatTuple and unconcatTuple round-trip with singles
+        let v_orig :: Vector 5 (Int 8)
+            v_orig = 1 :> 2 :> 3 :> 4 :> 5 :> nil
+        let t5 :: (Int 8, Int 8, Int 8, Int 8, Int 8)
+            t5 = concatTuple v_orig
+        let v_restored :: Vector 5 (Int 8)
+            v_restored = unconcatTuple t5
+        $display "concatTuple/unconcatTuple round-trip (singles): [%0d, %0d, %0d, %0d, %0d]" (v_restored !! 0) (v_restored !! 1) (v_restored !! 2) (v_restored !! 3) (v_restored !! 4)
+        counter := counter + 1
+
+      "test12": when counter == 12 ==> action
+        -- Test concatTuple and unconcatTuple round-trip with pairs
+        let v_orig :: Vector 3 (Bool, Int 8)
+            v_orig = (True, 11) :> (False, 22) :> (True, 33) :> nil
+        let t6 :: (Bool, Int 8, Bool, Int 8, Bool, Int 8)
+            t6 = concatTuple v_orig
+        let v_restored :: Vector 3 (Bool, Int 8)
+            v_restored = unconcatTuple t6
+        $display "concatTuple/unconcatTuple round-trip (pairs): [(%b, %0d), (%b, %0d), (%b, %0d)]" (tpl_1 (v_restored !! 0)) (tpl_2 (v_restored !! 0)) (tpl_1 (v_restored !! 1)) (tpl_2 (v_restored !! 1)) (tpl_1 (v_restored !! 2)) (tpl_2 (v_restored !! 2))
+        $display ""
+        $display "All ConcatTuple tests passed"
+        $finish 0
diff --git a/testsuite/bsc.lib/vector/libvector.exp b/testsuite/bsc.lib/vector/libvector.exp
@@ -11,3 +11,5 @@ test_c_veri_bsv FindElem
 test_c_veri_bsv FindIndex
 test_c_veri_bsv RotateBy
 test_c_veri_bsv ZeroVector
+
+test_c_veri_bs_modules ConcatTuple {}
diff --git a/testsuite/bsc.lib/vector/sysConcatTuple.out.expected b/testsuite/bsc.lib/vector/sysConcatTuple.out.expected
