| Copyright | Copyright (c) 2009-2017 David Sorokin <david.sorokin@gmail.com> |
|---|---|
| License | BSD3 |
| Maintainer | David Sorokin <david.sorokin@gmail.com> |
| Stability | experimental |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Simulation.Aivika.Queue.Infinite.Base
Description
Tested with: GHC 8.0.1
This module defines an infinite optimised queue, which has no counters nor signals.
Synopsis
- type FCFSQueue a = Queue FCFS FCFS a
- type LCFSQueue a = Queue LCFS FCFS a
- type SIROQueue a = Queue SIRO FCFS a
- type PriorityQueue a = Queue StaticPriorities FCFS a
- data Queue sm so a
- newFCFSQueue :: Simulation (FCFSQueue a)
- newLCFSQueue :: Simulation (LCFSQueue a)
- newSIROQueue :: Simulation (SIROQueue a)
- newPriorityQueue :: Simulation (PriorityQueue a)
- newQueue :: (QueueStrategy sm, QueueStrategy so) => sm -> so -> Simulation (Queue sm so a)
- enqueueStoringStrategy :: Queue sm so a -> sm
- dequeueStrategy :: Queue sm so a -> so
- queueNull :: Queue sm so a -> Event Bool
- queueCount :: Queue sm so a -> Event Int
- dequeue :: (DequeueStrategy sm, EnqueueStrategy so) => Queue sm so a -> Process a
- dequeueWithOutputPriority :: (DequeueStrategy sm, PriorityQueueStrategy so po) => Queue sm so a -> po -> Process a
- tryDequeue :: DequeueStrategy sm => Queue sm so a -> Event (Maybe a)
- enqueue :: (EnqueueStrategy sm, DequeueStrategy so) => Queue sm so a -> a -> Event ()
- enqueueWithStoringPriority :: (PriorityQueueStrategy sm pm, DequeueStrategy so) => Queue sm so a -> pm -> a -> Event ()
- queueDelete :: (Eq a, DeletingQueueStrategy sm, DequeueStrategy so) => Queue sm so a -> a -> Event Bool
- queueDelete_ :: (Eq a, DeletingQueueStrategy sm, DequeueStrategy so) => Queue sm so a -> a -> Event ()
- queueDeleteBy :: (DeletingQueueStrategy sm, DequeueStrategy so) => Queue sm so a -> (a -> Bool) -> Event (Maybe a)
- queueDeleteBy_ :: (DeletingQueueStrategy sm, DequeueStrategy so) => Queue sm so a -> (a -> Bool) -> Event ()
- queueContains :: (Eq a, DeletingQueueStrategy sm) => Queue sm so a -> a -> Event Bool
- queueContainsBy :: DeletingQueueStrategy sm => Queue sm so a -> (a -> Bool) -> Event (Maybe a)
- clearQueue :: DequeueStrategy sm => Queue sm so a -> Event ()
Queue Types
type FCFSQueue a = Queue FCFS FCFS a Source #
A type synonym for the ordinary FIFO queue also known as the FCFS (First Come - First Serviced) queue.
type LCFSQueue a = Queue LCFS FCFS a Source #
A type synonym for the ordinary LIFO queue also known as the LCFS (Last Come - First Serviced) queue.
type SIROQueue a = Queue SIRO FCFS a Source #
A type synonym for the SIRO (Serviced in Random Order) queue.
type PriorityQueue a = Queue StaticPriorities FCFS a Source #
A type synonym for the queue with static priorities applied when storing the elements in the queue.
Represents an infinite queue using the specified strategies for
internal storing (in memory), sm, and dequeueing (output), so, where a denotes
the type of items stored in the queue.
Creating Queue
newFCFSQueue :: Simulation (FCFSQueue a) Source #
Create a new infinite FCFS queue.
newLCFSQueue :: Simulation (LCFSQueue a) Source #
Create a new infinite LCFS queue.
newSIROQueue :: Simulation (SIROQueue a) Source #
Create a new infinite SIRO queue.
newPriorityQueue :: Simulation (PriorityQueue a) Source #
Create a new infinite priority queue.
Arguments
| :: (QueueStrategy sm, QueueStrategy so) | |
| => sm | the strategy applied when storing items in the queue |
| -> so | the strategy applied to the dequeueing (output) processes when the queue is empty |
| -> Simulation (Queue sm so a) |
Create a new infinite queue with the specified strategies.
Queue Properties and Activities
enqueueStoringStrategy :: Queue sm so a -> sm Source #
The strategy applied when storing (in memory) items in the queue.
dequeueStrategy :: Queue sm so a -> so Source #
The strategy applied to the dequeueing (output) processes.
queueNull :: Queue sm so a -> Event Bool Source #
Test whether the queue is empty.
See also queueNullChanged and queueNullChanged_.
queueCount :: Queue sm so a -> Event Int Source #
Return the current queue size.
See also queueCountStats, queueCountChanged and queueCountChanged_.
Dequeuing and Enqueuing
Arguments
| :: (DequeueStrategy sm, EnqueueStrategy so) | |
| => Queue sm so a | the queue |
| -> Process a | the dequeued value |
Dequeue suspending the process if the queue is empty.
dequeueWithOutputPriority Source #
Arguments
| :: (DequeueStrategy sm, PriorityQueueStrategy so po) | |
| => Queue sm so a | the queue |
| -> po | the priority for output |
| -> Process a | the dequeued value |
Dequeue with the output priority suspending the process if the queue is empty.
Arguments
| :: DequeueStrategy sm | |
| => Queue sm so a | the queue |
| -> Event (Maybe a) | the dequeued value of |
Try to dequeue immediately.
Arguments
| :: (EnqueueStrategy sm, DequeueStrategy so) | |
| => Queue sm so a | the queue |
| -> a | the item to enqueue |
| -> Event () |
Enqueue the item.
enqueueWithStoringPriority Source #
Arguments
| :: (PriorityQueueStrategy sm pm, DequeueStrategy so) | |
| => Queue sm so a | the queue |
| -> pm | the priority for storing |
| -> a | the item to enqueue |
| -> Event () |
Enqueue with the storing priority the item.
Arguments
| :: (Eq a, DeletingQueueStrategy sm, DequeueStrategy so) | |
| => Queue sm so a | the queue |
| -> a | the item to remove from the queue |
| -> Event Bool | whether the item was found and removed |
Remove the item from the queue and return a flag indicating whether the item was found and actually removed.
Arguments
| :: (Eq a, DeletingQueueStrategy sm, DequeueStrategy so) | |
| => Queue sm so a | the queue |
| -> a | the item to remove from the queue |
| -> Event () |
Remove the specified item from the queue.
Arguments
| :: (DeletingQueueStrategy sm, DequeueStrategy so) | |
| => Queue sm so a | the queue |
| -> (a -> Bool) | the predicate |
| -> Event (Maybe a) |
Remove an item satisfying the specified predicate and return the item if found.
Arguments
| :: (DeletingQueueStrategy sm, DequeueStrategy so) | |
| => Queue sm so a | the queue |
| -> (a -> Bool) | the predicate |
| -> Event () |
Remove an item satisfying the specified predicate.
Arguments
| :: (Eq a, DeletingQueueStrategy sm) | |
| => Queue sm so a | the queue |
| -> a | the item to search the queue for |
| -> Event Bool | whether the item was found |
Detect whether the item is contained in the queue.
Arguments
| :: DeletingQueueStrategy sm | |
| => Queue sm so a | the queue |
| -> (a -> Bool) | the predicate |
| -> Event (Maybe a) | the item if it was found |
Detect whether an item satisfying the specified predicate is contained in the queue.
Arguments
| :: DequeueStrategy sm | |
| => Queue sm so a | the queue |
| -> Event () |
Clear the queue immediately.