document minimal complete definition for Bits
authorRoss Paterson <ross@soi.city.ac.uk>
Thu, 24 Aug 2006 14:05:04 +0000 (14:05 +0000)
committerRoss Paterson <ross@soi.city.ac.uk>
Thu, 24 Aug 2006 14:05:04 +0000 (14:05 +0000)
Data/Bits.hs

index d33f7ee..ded147a 100644 (file)
@@ -66,6 +66,10 @@ The 'Bits' class defines bitwise operations over integral types.
 
 * Bits are numbered from 0 with bit 0 being the least
   significant bit.
+
+Minimal complete definition: '.&.', '.|.', 'xor', 'complement',
+('shift' or ('shiftL' and 'shiftR')), ('rotate' or ('rotateL' and 'rotateR')),
+'bitSize' and 'isSigned'.
 -}
 class Num a => Bits a where
     -- | Bitwise \"and\"