Add Finite class

clash-lang · Jan 1, 2025 · 7a1399a · 7a1399a
1 parent e1235bd
commit 7a1399a
Show file tree

Hide file tree

Showing 13 changed files with 1,028 additions and 13 deletions.
diff --git a/changelog/2024-12-30T13_36_39+01_00_add_finite_class b/changelog/2024-12-30T13_36_39+01_00_add_finite_class
@@ -0,0 +1 @@
+ADDED: Added `Clash.Class.Finite.Finite`: a class for types with only finitely many inhabitants. The class can be considered a more hardware-friendly alternative to `Bounded` and `Enum`, utilizing 'Index' instead of `Int` and vectors instead of lists.
diff --git a/clash-prelude/clash-prelude.cabal b/clash-prelude/clash-prelude.cabal
@@ -51,7 +51,7 @@ Maintainer:           QBayLogic B.V. <[email protected]>
 Copyright:            Copyright © 2013-2016, University of Twente,
                                   2016-2017, Myrtle Software Ltd,
                                   2017-2019, QBayLogic B.V., Google Inc.,
-                                  2021-2023, QBayLogic B.V.
+                                  2021-2025, QBayLogic B.V.
 Category:             Hardware
 Build-type:           Simple
 
@@ -183,6 +183,10 @@ Library
                       Clash.Class.Counter.Internal
                       Clash.Class.Counter.TH
                       Clash.Class.Exp
+                      Clash.Class.Finite
+                      Clash.Class.Finite.Internal
+                      Clash.Class.Finite.Internal.Dictionaries
+                      Clash.Class.Finite.Internal.TH
                       Clash.Class.HasDomain
                       Clash.Class.HasDomain.HasSingleDomain
                       Clash.Class.HasDomain.HasSpecificDomain

diff --git a/clash-prelude/src/Clash/Class/Finite.hs b/clash-prelude/src/Clash/Class/Finite.hs
@@ -0,0 +1,18 @@
+{-|
+Copyright  :  (C) 2024-2025, QBayLogic B.V.
+License    :  BSD2 (see the file LICENSE)
+Maintainer :  QBayLogic B.V. <[email protected]>
+-}
+
+module Clash.Class.Finite
+  ( -- * Finite Class
+    Finite(..)
+    -- * Extensions
+  , ReversedIndexOrder(..)
+  , WithUndefined(..)
+    -- * Deriving Helpers
+  , FiniteDerive(..)
+  )
+where
+
+import Clash.Class.Finite.Internal
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ADDED: Added `Clash.Class.Finite.Finite`: a class for types with only finitely many inhabitants. The class can be considered a more hardware-friendly alternative to `Bounded` and `Enum`, utilizing 'Index' instead of `Int` and vectors instead of lists.