map_queue v0.2.0 MapQueue

MapQueue is an implemenation of a queue with a single map as the underlying data structure.

The benefit of using a MapQueue over a list is that appending to the tail of a list ++ can become quite an expensive operation when the list is large.

With MapQueue adding or removing items from the queue is roughtly as fast as the same operation on a Map.

MapQueue keeps track of items in a map with integers as keys, and also tracks the highest (last) and lowest (first) items in the map.

Since each item in a MapQueue is tracked by an integer, the memory consumption of a MapQueue will be higher than that of an equivalent list or Erlang :queue.

Link to this section Summary

Types

t()

Functions

append(queue, enumerable)

new()

new(enumerable)

pop(queue)

pop(queue, count)

pop_rear(queue)

pop_rear(queue, count)

prepend(queue, enumerable)

push(queue, value)

push_front(queue, value)

size(map_queue)

slice(map_queue, index, amount)

Link to this section Types

t()

t() :: %MapQueue{
  first: integer(),
  last: integer(),
  map: %{required(integer()) => any()}
}

Link to this section Functions