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


-- | Simple implementation of a priority queue.
--   
--   Simple implementation of a priority queue.
@package priority-queue
@version 0.1.2

module Data.PriorityQueue

-- | The <a>pure</a> type at the chewy center.
data PQ a

-- | A new empty <a>PQ</a>
emptyPQ :: (Ord p) => (a -> p) -> PQ a

-- | Build a priority queue from a modifiable reference containing a
--   <a>PQ</a>
mkPriorityQueue :: (ModifyRef sr m (PQ a)) => sr -> PriorityQueue m a

-- | Build a priority queue using an instance of the default modifiable
--   reference for the requested monad and value type
mkDefaultPriorityQueue :: (DefaultStateRef sr m (PQ a), ModifyRef sr m (PQ a)) => sr -> PriorityQueue m a

-- | A priority queue usable in the monad m with values of type a
data PriorityQueue m a

-- | Construct a new priority queue using the specified indexing function
newPriorityQueue :: (DefaultStateRef sr m1 (PQ a), ModifyRef sr m1 (PQ a), NewRef sr m (PQ a), Ord p) => (a -> p) -> m (PriorityQueue m1 a)

-- | Construct a new priority queue using a comparator function. It is the
--   user's responsibility to ensure that this function provides a sensible
--   order.
newPriorityQueueBy :: (DefaultStateRef sr m1 (PQ a), ModifyRef sr m1 (PQ a), NewRef sr m (PQ a)) => (a -> a -> Ordering) -> m (PriorityQueue m1 a)
instance (Monad m) => QueueSize (PriorityQueue m a) m
instance (Monad m) => PeekQueue (PriorityQueue m a) m a
instance (Monad m) => DequeueWhere (PriorityQueue m a) m a
instance (Monad m) => Dequeue (PriorityQueue m a) m a
instance (Monad m) => Enqueue (PriorityQueue m a) m a