Bump the version number to 0.0.4 in hath.cabal.

[hath.git] / src / Bit.hs

diff --git a/src/Bit.hs b/src/Bit.hs
index 1c7de7bf4169862cf791e8ebf6bd5e92751a4852..e3d90e420e2bffbbe97accd2ad08246731aacde4 100644 (file)
--- a/src/Bit.hs
+++ b/src/Bit.hs
@@ -1,15 +1,46 @@
-module Bit where
+-- | The Bit module contains the Bit data type, which is essentially a
+--   renamed Boolean, and some convenience functions.
+module Bit
+where
+
+import Test.QuickCheck (
+  Arbitrary,
+  arbitrary,
+  elements
+  )
+
 
 data Bit = Zero | One
-         deriving (Eq, Show)
+  deriving (Enum, Eq)
+
+instance Show Bit where
+  show Zero = "0"
+  show One  = "1"
+
+
+instance Arbitrary Bit where
+  arbitrary = elements [ Zero, One ]
 
+
+instance Ord Bit where
+  Zero <= Zero = True
+  Zero <= One  = True
+  One  <= Zero = False
+  One  <= One  = True
+
+instance Bounded Bit where
+  minBound = Zero
+  maxBound = One
+
+
+-- | Convert a Bit to an Int.
 bit_to_int :: Bit -> Int
-bit_to_int Zero = 0
-bit_to_int One  = 1
-
--- If we are passed a '0' or '1', convert it appropriately. Otherwise,
--- default to Zero.
-bit_from_char :: Char -> Bit
-bit_from_char '0' = Zero
-bit_from_char '1' = One
-bit_from_char  _  = Zero
+bit_to_int Zero =  0
+bit_to_int One  =  1
+
+-- | If we are passed a '0' or '1', convert it
+--   appropriately. Otherwise, return Nothing.
+bit_from_char :: Char -> Maybe Bit
+bit_from_char '0' = Just Zero
+bit_from_char '1' = Just One
+bit_from_char  _  = Nothing