Data.IntPSQ

psqueues-0.2.2.3: Pure priority search queues

Safe Haskell | Safe
Language | Haskell98

Data.IntPSQ

Contents

- Type
- Query
- Construction
- Insertion
- Delete/update
- Lists
- Views
- Traversal
- Validity check

Description

`IntPSQ` fixes the key type to `Int`. It is generally much faster than an `OrdPSQ`.

Many operations have a worst-case complexity of O(min(n,W)). This means that the operation can -- become linear in the number of elements with a maximum of W -- the number of bits in an Int (32 or 64).

Synopsis

- data IntPSQ p v
- null :: IntPSQ p v -> Bool
- size :: IntPSQ p v -> Int
- member :: Int -> IntPSQ p v -> Bool
- lookup :: Int -> IntPSQ p v -> Maybe (p, v)
- findMin :: Ord p => IntPSQ p v -> Maybe (Int, p, v)
- empty :: IntPSQ p v
- singleton :: Ord p => Int -> p -> v -> IntPSQ p v
- insert :: Ord p => Int -> p -> v -> IntPSQ p v -> IntPSQ p v
- delete :: Ord p => Int -> IntPSQ p v -> IntPSQ p v
- deleteMin :: Ord p => IntPSQ p v -> IntPSQ p v
- alter :: Ord p => (Maybe (p, v) -> (b, Maybe (p, v))) -> Int -> IntPSQ p v -> (b, IntPSQ p v)
- alterMin :: Ord p => (Maybe (Int, p, v) -> (b, Maybe (Int, p, v))) -> IntPSQ p v -> (b, IntPSQ p v)
- fromList :: Ord p => [(Int, p, v)] -> IntPSQ p v
- toList :: IntPSQ p v -> [(Int, p, v)]
- keys :: IntPSQ p v -> [Int]
- insertView :: Ord p => Int -> p -> v -> IntPSQ p v -> (Maybe (p, v), IntPSQ p v)
- deleteView :: Ord p => Int -> IntPSQ p v -> Maybe (p, v, IntPSQ p v)
- minView :: Ord p => IntPSQ p v -> Maybe (Int, p, v, IntPSQ p v)
- map :: (Int -> p -> v -> w) -> IntPSQ p v -> IntPSQ p w
- fold' :: (Int -> p -> v -> a -> a) -> a -> IntPSQ p v -> a
- valid :: Ord p => IntPSQ p v -> Bool

# Type

data IntPSQ p v #

A priority search queue with `Int` keys and priorities of type `p` and values of type `v`. It is strict in keys, priorities and values.

Instances

Functor (IntPSQ p) # |
Methods fmap :: (a -> b) -> IntPSQ p a -> IntPSQ p b # (<$) :: a -> IntPSQ p b -> IntPSQ p a #
Foldable (IntPSQ p) # |
Methods fold :: Monoid m => IntPSQ p m -> m # foldMap :: Monoid m => (a -> m) -> IntPSQ p a -> m # foldr :: (a -> b -> b) -> b -> IntPSQ p a -> b # foldr' :: (a -> b -> b) -> b -> IntPSQ p a -> b # foldl :: (b -> a -> b) -> b -> IntPSQ p a -> b # foldl' :: (b -> a -> b) -> b -> IntPSQ p a -> b # foldr1 :: (a -> a -> a) -> IntPSQ p a -> a # foldl1 :: (a -> a -> a) -> IntPSQ p a -> a # toList :: IntPSQ p a -> [a] # null :: IntPSQ p a -> Bool # length :: IntPSQ p a -> Int # elem :: Eq a => a -> IntPSQ p a -> Bool # maximum :: Ord a => IntPSQ p a -> a # minimum :: Ord a => IntPSQ p a -> a # sum :: Num a => IntPSQ p a -> a # product :: Num a => IntPSQ p a -> a #
Traversable (IntPSQ p) # |
Methods traverse :: Applicative f => (a -> f b) -> IntPSQ p a -> f (IntPSQ p b) # sequenceA :: Applicative f => IntPSQ p (f a) -> f (IntPSQ p a) # mapM :: Monad m => (a -> m b) -> IntPSQ p a -> m (IntPSQ p b) # sequence :: Monad m => IntPSQ p (m a) -> m (IntPSQ p a) #
(Ord p, Eq v) => Eq (IntPSQ p v) # |
Methods (==) :: IntPSQ p v -> IntPSQ p v -> Bool # (/=) :: IntPSQ p v -> IntPSQ p v -> Bool #
(Show p, Show v) => Show (IntPSQ p v) # |
Methods showsPrec :: Int -> IntPSQ p v -> ShowS # show :: IntPSQ p v -> String # showList :: [IntPSQ p v] -> ShowS #
(NFData p, NFData v) => NFData (IntPSQ p v) # |
Methods rnf :: IntPSQ p v -> () #

# Query

null :: IntPSQ p v -> Bool #

O(1) True if the queue is empty.

size :: IntPSQ p v -> Int #

O(n) The number of elements stored in the queue.

member :: Int -> IntPSQ p v -> Bool #

O(min(n,W)) Check if a key is present in the the queue.

lookup :: Int -> IntPSQ p v -> Maybe (p, v) #

O(min(n,W)) The priority and value of a given key, or `Nothing` if the key is not bound.

findMin :: Ord p => IntPSQ p v -> Maybe (Int, p, v) #

O(1) The element with the lowest priority.

# Construction

empty :: IntPSQ p v #

O(1) The empty queue.

singleton :: Ord p => Int -> p -> v -> IntPSQ p v #

O(1) Build a queue with one element.

# Insertion

insert :: Ord p => Int -> p -> v -> IntPSQ p v -> IntPSQ p v #

O(min(n,W)) Insert a new key, priority and value into the queue. If the key is already present in the queue, the associated priority and value are replaced with the supplied priority and value.

# Delete/update

delete :: Ord p => Int -> IntPSQ p v -> IntPSQ p v #

O(min(n,W)) Delete a key and its priority and value from the queue. When the key is not a member of the queue, the original queue is returned.

deleteMin :: Ord p => IntPSQ p v -> IntPSQ p v #

O(min(n,W)) Delete the binding with the least priority, and return the rest of the queue stripped of that binding. In case the queue is empty, the empty queue is returned again.

alter :: Ord p => (Maybe (p, v) -> (b, Maybe (p, v))) -> Int -> IntPSQ p v -> (b, IntPSQ p v) #

O(min(n,W)) The expression `alter f k queue` alters the value `x` at `k`, or absence thereof. `alter` can be used to insert, delete, or update a value in a queue. It also allows you to calculate an additional value `b`.

alterMin :: Ord p => (Maybe (Int, p, v) -> (b, Maybe (Int, p, v))) -> IntPSQ p v -> (b, IntPSQ p v) #

O(min(n,W)) A variant of `alter` which works on the element with the minimum priority. Unlike `alter`, this variant also allows you to change the key of the element.

# Lists

fromList :: Ord p => [(Int, p, v)] -> IntPSQ p v #

O(n*min(n,W)) Build a queue from a list of (key, priority, value) tuples. If the list contains more than one priority and value for the same key, the last priority and value for the key is retained.

toList :: IntPSQ p v -> [(Int, p, v)] #

O(n) Convert a queue to a list of (key, priority, value) tuples. The order of the list is not specified.

keys :: IntPSQ p v -> [Int] #

O(n) Obtain the list of present keys in the queue.

# Views

insertView :: Ord p => Int -> p -> v -> IntPSQ p v -> (Maybe (p, v), IntPSQ p v) #

O(min(n,W)) Insert a new key, priority and value into the queue. If the key is already present in the queue, then the evicted priority and value can be found the first element of the returned tuple.

deleteView :: Ord p => Int -> IntPSQ p v -> Maybe (p, v, IntPSQ p v) #

O(min(n,W)) Delete a key and its priority and value from the queue. If the key was present, the associated priority and value are returned in addition to the updated queue.

minView :: Ord p => IntPSQ p v -> Maybe (Int, p, v, IntPSQ p v) #

O(min(n,W)) Retrieve the binding with the least priority, and the rest of the queue stripped of that binding.

# Traversal

map :: (Int -> p -> v -> w) -> IntPSQ p v -> IntPSQ p w #

O(n) Modify every value in the queue.

fold' :: (Int -> p -> v -> a -> a) -> a -> IntPSQ p v -> a #

O(n) Strict fold over every key, priority and value in the queue. The order in which the fold is performed is not specified.

# Validity check

valid :: Ord p => IntPSQ p v -> Bool #

O(n^2) Internal function to check if the `IntPSQ` is valid, i.e. if all invariants hold. This should always be the case.