Add a note about generalizing complementActive and complementEmpty

IntersectMBO · Aug 9, 2023 · 049bcc4 · 049bcc4
1 parent 8f54371
commit 049bcc4
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/ouroboros-consensus/src/consensus-testlib/Test/Ouroboros/Consensus/ChainGenerator/Slot.hs b/ouroboros-consensus/src/consensus-testlib/Test/Ouroboros/Consensus/ChainGenerator/Slot.hs
@@ -113,6 +113,10 @@ class POL (pol :: Pol) where
     -- | Test whether @pol@ maps the given bit to one
     test :: proxy pol -> S -> Bool
 
+-- Both 'complementActive' and 'complementEmpty' are offered for simplicity
+-- instead of a generalized function that works in both cases (it would need
+-- another proxy parameter for the element type).
+
 -- | Every slot is either active or empty
 complementActive ::
      proxy pol