Monadoc

queues

Version 1.0.0 revision 3 uploaded by mitchellwrosen.

Package meta

Synopsis
Queue data structures.
Description

Queue data structures, as described in

  • Okasaki, Chris. "Simple and efficient purely functional queues and deques." Journal of functional programming 5.4 (1995): 583-592.

  • Okasaki, Chris. Purely Functional Data Structures. Diss. Princeton University, 1996.

A queue has a "back" where new elements are enqueued, and a "front" where elements are dequeued in the order that they were enqueued (last in, first out).

The queues provided in this library also support an "enqueue at front" operation, because the underlying representations happen to support it, so you might technically refer to these data structures as output-restricted deques.

In this library, it is helpful to think of the "front" being on the left, because (though the direction is arbitrary) we are consistent throughout, where it matters:

  • List conversion functions associate the head of a list with the front of a queue.

  • The append operator xs <> ys creates a queue with xs in front of ys.

  • The Show instances draw the front of the queue on the left.

Under "ephemeral" (or "single-threaded", or "linear") usage, wherein one does not need to refer to an old version of a data structure after mutating it:

  • EphemeralQueue is 2.5x faster than and allocates 0.50x as much memory as Queue.

  • Queue is 2.6x faster than and allocates 0.40x as much memory as Seq (from containers).

(These numbers vary from benchmark to benchmark and machine to machine. Always perform your own experiments!)

While it is certainly common to use a queue ephemerally, it is unusual for a Haskell data structure to require ephemeral usage to achieve its stated bounds. A refactoring or change in requirements might cause surprising changes in performance. That is why EphemeralQueue has a longer name and module name. When in doubt, use Queue.

Author
Mitchell Dalvi Rosen, Travis Staton
Bug reports
https://github.com/awkward-squad/queues/issues
Category
Data
Copyright
Copyright (C) 2023-2024 Mitchell Dalvi Rosen, Travis Staton
Homepage
https://github.com/awkward-squad/queues
Maintainer
Mitchell Dalvi Rosen <mitchellwrosen@gmail.com>, Travis Staton <hello@travisstaton.com>
Package URL
n/a
Stability
n/a

Components