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


-- | Map of maps using Enum types as keys
--   
--   This package provides 'maps of maps' using Enum types as keys. The
--   code is based upon Data.IntMap in containers 5.0.
@package enummapmap
@version 0.0.2


module Data.EnumMapMap.Strict

-- | No subtrees should be empty. Returns <a>True</a> if one is.
emptySubTrees :: IsEmm k => EnumMapMap k v -> Bool

-- | Multiple keys are joined by the (<a>:&amp;</a>) constructor and
--   terminated with <a>K</a>.
--   
--   <pre>
--   multiKey :: Int :&amp; Int :&amp; K Int
--   multiKey = 5 :&amp; 6 :&amp; K 5
--   </pre>
data (:&) k t
(:&) :: !k -> !t -> :& k t

-- | Keys are terminated with the <a>K</a> type
--   
--   <pre>
--   singleKey :: K Int
--   singleKey = K 5
--   </pre>
data K k
K :: !k -> K k

-- | Split after 1 key.
--   
--   <pre>
--   emm :: EnumMapMap (T1 :&amp; T2 :&amp; K T3) v
--   splitKey d1 emm :: EnumMapMap (T1 :&amp; K T2) (EnumMapMap (K T3) v)
--   </pre>
d1 :: Z

-- | Split after 2 keys.
--   
--   <pre>
--   emm :: EnumMapMap (T1 :&amp; T2 :&amp; K T3) v
--   splitKey d1 emm :: EnumMapMap (K T1) (EnumMapMap (T2 :&amp; K T3) v)
--   </pre>
d2 :: N (Z)
d3 :: N (N (Z))
d4 :: N (N (N (Z)))
d5 :: N (N (N (N (Z))))
d6 :: N (N (N (N (N (Z)))))
d7 :: N (N (N (N (N (N (Z))))))
d8 :: N (N (N (N (N (N (N (Z)))))))
d9 :: N (N (N (N (N (N (N (N (Z))))))))
d10 :: N (N (N (N (N (N (N (N (N (Z)))))))))

-- | Number of elements in the <a>EnumMapMap</a>.
size :: IsEmm k => EnumMapMap k v -> Int

-- | Is the <a>EnumMapMap</a> empty?
--   
--   Submaps can never be empty, so the following should always hold true:
--   
--   <pre>
--   emm :: EnumMapMap (Int :&amp; Int :&amp; K ID) Bool)
--   null $ splitKey x emm == False
--   </pre>
null :: IsEmm k => EnumMapMap k v -> Bool

-- | Is the key present in the <a>EnumMapMap</a>?
member :: IsEmm k => k -> EnumMapMap k v -> Bool

-- | Lookup up the value at a key in the <a>EnumMapMap</a>.
--   
--   <pre>
--   emm = fromList [(3 :&amp; K 1, "a")]
--   lookup (3 :&amp; K 1) emm == Just "a"
--   lookup (2 :&amp; K 1) emm == Nothing
--   </pre>
lookup :: IsEmm k => k -> EnumMapMap k v -> Maybe v

-- | The empty <a>EnumMapMap</a>.
empty :: IsEmm k => EnumMapMap k v

-- | An <a>EnumMapMap</a> with one element
--   
--   <pre>
--   singleton (5 :&amp; K 3) "a" == fromList [(5 :&amp; K 3, "a")]
--   </pre>
singleton :: IsEmm k => k -> v -> EnumMapMap k v

-- | Insert a new Key/Value pair into the <a>EnumMapMap</a>.
insert :: IsEmm k => k -> v -> EnumMapMap k v -> EnumMapMap k v

-- | Insert with a combining function.
insertWith :: IsEmm k => (v -> v -> v) -> k -> v -> EnumMapMap k v -> EnumMapMap k v

-- | Insert with a combining function.
insertWithKey :: IsEmm k => (k -> v -> v -> v) -> k -> v -> EnumMapMap k v -> EnumMapMap k v

-- | Remove a key and it's value from the <a>EnumMapMap</a>. If the key is
--   not present the original <a>EnumMapMap</a> is returned.
delete :: IsEmm k => k -> EnumMapMap k v -> EnumMapMap k v

-- | The expression (<tt><a>alter</a> f k emm</tt>) alters the value at
--   <tt>k</tt>, or absence thereof. <a>alter</a> can be used to insert,
--   delete, or update a value in an <a>EnumMapMap</a>.
alter :: IsEmm k => (Maybe v -> Maybe v) -> k -> EnumMapMap k v -> EnumMapMap k v

-- | The (left-biased) union of two <a>EnumMapMap</a>s. It prefers the
--   first <a>EnumMapMap</a> when duplicate keys are encountered.
union :: IsEmm k => EnumMapMap k v -> EnumMapMap k v -> EnumMapMap k v

-- | The union with a combining function.
unionWith :: IsEmm k => (v -> v -> v) -> EnumMapMap k v -> EnumMapMap k v -> EnumMapMap k v

-- | The union with a combining function.
unionWithKey :: IsEmm k => (k -> v -> v -> v) -> EnumMapMap k v -> EnumMapMap k v -> EnumMapMap k v

-- | The union of a list of maps.
unions :: IsEmm k => [EnumMapMap k v] -> EnumMapMap k v

-- | Difference between two <a>EnumMapMap</a>s (based on keys).
difference :: IsEmm k => EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v1

-- | Difference with a combining function.
differenceWith :: IsEmm k => (v1 -> v2 -> Maybe v1) -> EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v1

-- | Difference with a combining function.
differenceWithKey :: IsEmm k => (k -> v1 -> v2 -> Maybe v1) -> EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v1

-- | The (left-biased) intersection of two <a>EnumMapMap</a> (based on
--   keys).
intersection :: IsEmm k => EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v1

-- | The intersection with a combining function.
intersectionWith :: IsEmm k => (v1 -> v2 -> v3) -> EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v3

-- | The intersection with a combining function.
intersectionWithKey :: IsEmm k => (k -> v1 -> v2 -> v3) -> EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v3

-- | Map a function over all values in the <a>EnumMapMap</a>.
map :: IsEmm k => (v -> t) -> EnumMapMap k v -> EnumMapMap k t

-- | Map a function over all key/value pairs in the <a>EnumMapMap</a>.
mapWithKey :: IsEmm k => (k -> v -> t) -> EnumMapMap k v -> EnumMapMap k t

-- | Fold the keys and values in the map using the given right-associative
--   binary operator.
foldrWithKey :: IsEmm k => (k -> v -> t -> t) -> t -> EnumMapMap k v -> t

-- | Convert the <a>EnumMapMap</a> to a list of key/value pairs.
toList :: IsEmm k => EnumMapMap k v -> [(k, v)]

-- | Create a <a>EnumMapMap</a> from a list of key/value pairs.
fromList :: IsEmm k => [(k, v)] -> EnumMapMap k v

-- | Split a key so that an <a>EnumMapMap</a> becomes an <a>EnumMapMap</a>
--   of <a>EnumMapMap</a>s.
--   
--   <pre>
--   newtype ID = ID Int deriving Enum
--   emm = empty :: EnumMapMap (Int :&amp; K ID) Bool
--   res :: EnumMapMap (K ID) Bool
--   res = lookup (K 5) $ splitKey d1 emm
--   </pre>
--   
--   If the level is too high then the compilation will fail with an error
--   
--   <pre>
--   emm = empty :: EnumMapMap (Int :&amp; Int :&amp; K Int) Bool -- 3 levels
--   res1 = splitKey d4 emm -- ERROR! Instance not found...
--   res2 = splitKey d3 emm -- ERROR! Instance not found...
--   res3 = splitKey d2 emm -- Good
--   </pre>
splitKey :: IsSplit k z => z -> EnumMapMap k v -> EnumMapMap (Head k z) (EnumMapMap (Tail k z) v)

-- | Join a key so that an <a>EnumMapMap</a> of <a>EnumMapMap</a>s becomes
--   an <a>EnumMapMap</a>.
--   
--   <pre>
--   newtype ID = ID Int deriving Enum
--   emm :: EnumMapMap (K Int) (EnumMapMap (K ID) Bool)
--   res :: EnumMapMap (Int :&amp; K ID) Bool
--   res = joinKey emm
--   </pre>
--   
--   <a>joinKey</a> is the opposite of <a>splitKey</a>.
--   
--   <pre>
--   emm = empty :: EnumMapMap (Int :&amp; Int :&amp; K ID) Bool)
--   emm == joinKey $ splitKey d2 emm
--   </pre>
joinKey :: (IsEmm k, IsEmm (Plus k k2)) => EnumMapMap k (EnumMapMap k2 v) -> EnumMapMap (Plus k k2) v

-- | Join a key so that an <a>EnumMapMap</a> of <a>EnumMapMap</a>s becomes
--   an <a>EnumMapMap</a>. The unsafe version does not check for empty
--   subtrees, so it is faster.
--   
--   <pre>
--   newtype ID = ID Int deriving Enum
--   emm :: EnumMapMap (K Int) (EnumMapMap (K ID) Bool)
--   res :: EnumMapMap (Int :&amp; K ID) Bool
--   res = unsafeJoinKey emm
--   </pre>
unsafeJoinKey :: IsEmm k => EnumMapMap k (EnumMapMap k2 v) -> EnumMapMap (Plus k k2) v
instance IsSplit (k :& t) Z
instance NFData v => NFData (EnumMapMap (K k) v)
instance Show v => Show (EnumMapMap (K k) v)
instance Enum k => IsEmm (K k)


module Data.EnumMapMap.Lazy

-- | No subtrees should be empty. Returns <a>True</a> if one is.
emptySubTrees :: IsEmm k => EnumMapMap k v -> Bool

-- | Multiple keys are joined by the (<a>:&amp;</a>) constructor and
--   terminated with <a>K</a>.
--   
--   <pre>
--   multiKey :: Int :&amp; Int :&amp; K Int
--   multiKey = 5 :&amp; 6 :&amp; K 5
--   </pre>
data (:&) k t
(:&) :: !k -> !t -> :& k t

-- | Keys are terminated with the <a>K</a> type
--   
--   <pre>
--   singleKey :: K Int
--   singleKey = K 5
--   </pre>
data K k
K :: !k -> K k

-- | Split after 1 key.
--   
--   <pre>
--   emm :: EnumMapMap (T1 :&amp; T2 :&amp; K T3) v
--   splitKey d1 emm :: EnumMapMap (T1 :&amp; K T2) (EnumMapMap (K T3) v)
--   </pre>
d1 :: Z

-- | Split after 2 keys.
--   
--   <pre>
--   emm :: EnumMapMap (T1 :&amp; T2 :&amp; K T3) v
--   splitKey d1 emm :: EnumMapMap (K T1) (EnumMapMap (T2 :&amp; K T3) v)
--   </pre>
d2 :: N (Z)
d3 :: N (N (Z))
d4 :: N (N (N (Z)))
d5 :: N (N (N (N (Z))))
d6 :: N (N (N (N (N (Z)))))
d7 :: N (N (N (N (N (N (Z))))))
d8 :: N (N (N (N (N (N (N (Z)))))))
d9 :: N (N (N (N (N (N (N (N (Z))))))))
d10 :: N (N (N (N (N (N (N (N (N (Z)))))))))

-- | Number of elements in the <a>EnumMapMap</a>.
size :: IsEmm k => EnumMapMap k v -> Int

-- | Is the <a>EnumMapMap</a> empty?
--   
--   Submaps can never be empty, so the following should always hold true:
--   
--   <pre>
--   emm :: EnumMapMap (Int :&amp; Int :&amp; K ID) Bool)
--   null $ splitKey x emm == False
--   </pre>
null :: IsEmm k => EnumMapMap k v -> Bool

-- | Is the key present in the <a>EnumMapMap</a>?
member :: IsEmm k => k -> EnumMapMap k v -> Bool

-- | Lookup up the value at a key in the <a>EnumMapMap</a>.
--   
--   <pre>
--   emm = fromList [(3 :&amp; K 1, "a")]
--   lookup (3 :&amp; K 1) emm == Just "a"
--   lookup (2 :&amp; K 1) emm == Nothing
--   </pre>
lookup :: IsEmm k => k -> EnumMapMap k v -> Maybe v

-- | The empty <a>EnumMapMap</a>.
empty :: IsEmm k => EnumMapMap k v

-- | An <a>EnumMapMap</a> with one element
--   
--   <pre>
--   singleton (5 :&amp; K 3) "a" == fromList [(5 :&amp; K 3, "a")]
--   </pre>
singleton :: IsEmm k => k -> v -> EnumMapMap k v

-- | Insert a new Key/Value pair into the <a>EnumMapMap</a>.
insert :: IsEmm k => k -> v -> EnumMapMap k v -> EnumMapMap k v

-- | Insert with a combining function.
insertWith :: IsEmm k => (v -> v -> v) -> k -> v -> EnumMapMap k v -> EnumMapMap k v

-- | Insert with a combining function.
insertWithKey :: IsEmm k => (k -> v -> v -> v) -> k -> v -> EnumMapMap k v -> EnumMapMap k v

-- | Remove a key and it's value from the <a>EnumMapMap</a>. If the key is
--   not present the original <a>EnumMapMap</a> is returned.
delete :: IsEmm k => k -> EnumMapMap k v -> EnumMapMap k v

-- | The expression (<tt><a>alter</a> f k emm</tt>) alters the value at
--   <tt>k</tt>, or absence thereof. <a>alter</a> can be used to insert,
--   delete, or update a value in an <a>EnumMapMap</a>.
alter :: IsEmm k => (Maybe v -> Maybe v) -> k -> EnumMapMap k v -> EnumMapMap k v

-- | The (left-biased) union of two <a>EnumMapMap</a>s. It prefers the
--   first <a>EnumMapMap</a> when duplicate keys are encountered.
union :: IsEmm k => EnumMapMap k v -> EnumMapMap k v -> EnumMapMap k v

-- | The union with a combining function.
unionWith :: IsEmm k => (v -> v -> v) -> EnumMapMap k v -> EnumMapMap k v -> EnumMapMap k v

-- | The union with a combining function.
unionWithKey :: IsEmm k => (k -> v -> v -> v) -> EnumMapMap k v -> EnumMapMap k v -> EnumMapMap k v

-- | The union of a list of maps.
unions :: IsEmm k => [EnumMapMap k v] -> EnumMapMap k v

-- | Difference between two <a>EnumMapMap</a>s (based on keys).
difference :: IsEmm k => EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v1

-- | Difference with a combining function.
differenceWith :: IsEmm k => (v1 -> v2 -> Maybe v1) -> EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v1

-- | Difference with a combining function.
differenceWithKey :: IsEmm k => (k -> v1 -> v2 -> Maybe v1) -> EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v1

-- | The (left-biased) intersection of two <a>EnumMapMap</a> (based on
--   keys).
intersection :: IsEmm k => EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v1

-- | The intersection with a combining function.
intersectionWith :: IsEmm k => (v1 -> v2 -> v3) -> EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v3

-- | The intersection with a combining function.
intersectionWithKey :: IsEmm k => (k -> v1 -> v2 -> v3) -> EnumMapMap k v1 -> EnumMapMap k v2 -> EnumMapMap k v3

-- | Map a function over all values in the <a>EnumMapMap</a>.
map :: IsEmm k => (v -> t) -> EnumMapMap k v -> EnumMapMap k t

-- | Map a function over all key/value pairs in the <a>EnumMapMap</a>.
mapWithKey :: IsEmm k => (k -> v -> t) -> EnumMapMap k v -> EnumMapMap k t

-- | Fold the keys and values in the map using the given right-associative
--   binary operator.
foldrWithKey :: IsEmm k => (k -> v -> t -> t) -> t -> EnumMapMap k v -> t

-- | Convert the <a>EnumMapMap</a> to a list of key/value pairs.
toList :: IsEmm k => EnumMapMap k v -> [(k, v)]

-- | Create a <a>EnumMapMap</a> from a list of key/value pairs.
fromList :: IsEmm k => [(k, v)] -> EnumMapMap k v

-- | Split a key so that an <a>EnumMapMap</a> becomes an <a>EnumMapMap</a>
--   of <a>EnumMapMap</a>s.
--   
--   <pre>
--   newtype ID = ID Int deriving Enum
--   emm = empty :: EnumMapMap (Int :&amp; K ID) Bool
--   res :: EnumMapMap (K ID) Bool
--   res = lookup (K 5) $ splitKey d1 emm
--   </pre>
--   
--   If the level is too high then the compilation will fail with an error
--   
--   <pre>
--   emm = empty :: EnumMapMap (Int :&amp; Int :&amp; K Int) Bool -- 3 levels
--   res1 = splitKey d4 emm -- ERROR! Instance not found...
--   res2 = splitKey d3 emm -- ERROR! Instance not found...
--   res3 = splitKey d2 emm -- Good
--   </pre>
splitKey :: IsSplit k z => z -> EnumMapMap k v -> EnumMapMap (Head k z) (EnumMapMap (Tail k z) v)

-- | Join a key so that an <a>EnumMapMap</a> of <a>EnumMapMap</a>s becomes
--   an <a>EnumMapMap</a>.
--   
--   <pre>
--   newtype ID = ID Int deriving Enum
--   emm :: EnumMapMap (K Int) (EnumMapMap (K ID) Bool)
--   res :: EnumMapMap (Int :&amp; K ID) Bool
--   res = joinKey emm
--   </pre>
--   
--   <a>joinKey</a> is the opposite of <a>splitKey</a>.
--   
--   <pre>
--   emm = empty :: EnumMapMap (Int :&amp; Int :&amp; K ID) Bool)
--   emm == joinKey $ splitKey d2 emm
--   </pre>
joinKey :: (IsEmm k, IsEmm (Plus k k2)) => EnumMapMap k (EnumMapMap k2 v) -> EnumMapMap (Plus k k2) v

-- | Join a key so that an <a>EnumMapMap</a> of <a>EnumMapMap</a>s becomes
--   an <a>EnumMapMap</a>. The unsafe version does not check for empty
--   subtrees, so it is faster.
--   
--   <pre>
--   newtype ID = ID Int deriving Enum
--   emm :: EnumMapMap (K Int) (EnumMapMap (K ID) Bool)
--   res :: EnumMapMap (Int :&amp; K ID) Bool
--   res = unsafeJoinKey emm
--   </pre>
unsafeJoinKey :: IsEmm k => EnumMapMap k (EnumMapMap k2 v) -> EnumMapMap (Plus k k2) v
instance IsSplit (k :& t) Z
instance NFData v => NFData (EnumMapMap (K k) v)
instance Show v => Show (EnumMapMap (K k) v)
instance Enum k => IsEmm (K k)