-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A compact functional set data structure.
--   
--   A <i>bit set</i> is a compact data structure, which maintains a set of
--   members from a type that can be enumerated (i. e. has an <a>Enum</a>
--   instance). Current implementations uses <tt>Integer</tt> for as bit
--   storage and provides most of the expected set operations: insertion,
--   deletion, intersection, membership testing etc.
@package bitset
@version 1.2


-- | A <i>bit set</i> maintains a record of members from a type that can be
--   enumerated (i. e. has and <a>Enum</a> instance). The maximum number of
--   elements that can be stored is <tt>maxBound :: Int</tt>.
--   
--   To use this library, define a <a>Enum</a> instance for your data type
--   or have it derived. It is important that the values you intend to
--   store in a bit set start from 0 and go up. A value for which
--   <tt>fromEnum x</tt> is <tt>n</tt> corresponds to bit location
--   <tt>n</tt> in an <tt>Integer</tt>, and thus requires that
--   <tt>Integer</tt> to have at least <tt>n</tt> bits.
--   
--   <i>Note</i>: The idea of using <a>Integer</a> as bit storage for a bit
--   set was borrowed from an unsupported <a>BitSet</a> implementation by
--   Denis Bueno.
module Data.BitSet
data BitSet a

-- | <i>O(max(m, n))</i>. See <a>difference</a>.
(\\) :: Enum a => BitSet a -> BitSet a -> BitSet a

-- | <i>O(1)</i>. Is the bit set empty?
null :: BitSet a -> Bool

-- | <i>O(1)</i>. The number of elements in the bit set.
size :: BitSet a -> Int

-- | <i>O(testBit on Integer)</i>. Ask whether the item is in the bit set.
member :: Enum a => a -> BitSet a -> Bool

-- | <i>O(testBit on Integer)</i>. Ask whether the item is in the bit set.
notMember :: Enum a => a -> BitSet a -> Bool

-- | <i>O(max(n, m))</i>.. Is this a subset? (<tt>s1 isSubsetOf s2</tt>)
--   tells whether <tt>s1</tt> is a subset of <tt>s2</tt>.
isSubsetOf :: Enum a => BitSet a -> BitSet a -> Bool

-- | <i>O(max(n, m)</i>.. Is this a proper subset? (ie. a subset but not
--   equal).
isProperSubsetOf :: Enum a => BitSet a -> BitSet a -> Bool

-- | The empty bit set.
empty :: BitSet a

-- | O(setBit on Integer). Create a singleton set.
singleton :: Enum a => a -> BitSet a

-- | <i>O(setBit on Integer)</i>. Insert an item into the bit set.
insert :: Enum a => a -> BitSet a -> BitSet a

-- | <i>O(clearBit on Integer)</i>. Delete an item from the bit set.
delete :: Enum a => a -> BitSet a -> BitSet a

-- | <i>O(max(m, n))</i>. The union of two bit sets.
union :: Enum a => BitSet a -> BitSet a -> BitSet a

-- | <i>O(max(m, n))</i>. The union of a list of bit sets.
unions :: Enum a => [BitSet a] -> BitSet a

-- | <i>O(max(m, n))</i>. Difference of two bit sets.
difference :: Enum a => BitSet a -> BitSet a -> BitSet a

-- | <i>O(max(m, n))</i>. The intersection of two bit sets.
intersection :: Enum a => BitSet a -> BitSet a -> BitSet a

-- | <i>O(n * shiftR on Integer)</i>. An alias to <tt>toList</tt>.
elems :: Enum a => BitSet a -> [a]

-- | <i>O(n * shiftR on Integer)</i>. Convert a bit set to a list of
--   elements.
toList :: Enum a => BitSet a -> [a]

-- | <i>O(n * setBit on Integer)</i>. Make a bit set from a list of
--   elements.
fromList :: Enum a => [a] -> BitSet a

-- | <i>O(1)</i>. Project a bit set to an integral type.
toIntegral :: Integral b => BitSet a -> b

-- | <i>O(n)</i>. Make a bit set from an integral. Unsafe because we don't
--   checked whether the bits set in a given value correspond to values of
--   type <tt>a</tt>. This is only useful as a more efficient alternative
--   to fromList.
unsafeFromIntegral :: Integral b => b -> BitSet a
instance Typeable1 BitSet
instance Eq (BitSet a)
instance Ord (BitSet a)
instance Data a => Data (BitSet a)
instance NFData (BitSet a)
instance (Enum a, Show a) => Show (BitSet a)
instance Enum a => Monoid (BitSet a)