Package 'liqueueR'

Title: Implements Queue, PriorityQueue and Stack Classes
Description: Provides three classes: Queue, PriorityQueue and Stack. Queue is just a "plain vanilla" FIFO queue; PriorityQueue orders items according to priority. Stack implements LIFO.
Authors: Andrew Collier [aut, cre]
Maintainer: Andrew Collier <[email protected]>
License: GPL-3
Version: 0.0.4
Built: 2024-10-29 03:30:50 UTC
Source: https://github.com/datawookie/liqueuer

Help Index


A PriorityQueue reference class

Description

Derived from the Queue class.

Fields

data

Initial data to populate the queue.

priorities

Numeric queue priorities.

prioritise

Function to calculate priorities from items.

Methods

pop(N = 1)

Removes and returns head of queue (or raises error if queue is empty). N is number of items to pop.

push(item)

Inserts element at back of the queue.

See Also

Queue-class for information on base class.


A Queue reference class

Description

A Queue reference class

Fields

data

Initial data to populate the queue.

Methods

peek(pos = c(1), as.list = FALSE)

Returns (but does not remove) specified positions in queue (or NULL if any one of them is not available). The as.list argument will cause a list to be returned even if only one element requested.

poll()

Removes and returns head of queue (or NULL if queue is empty).

pop(N = 1)

Removes and returns head of queue (or raises error if queue is empty). N is number of items to pop.

push(item)

Inserts element at back of the queue.

size()

Returns the number of items in the queue.

Examples

queue <- Queue$new()
queue$push("one")
queue$push(2)
queue$push("three")
queue$size()
queue$pop()
queue$poll()

A Stack reference class

Description

Derived from the Queue class.

Fields

data

Initial data to populate the stack.

Methods

push(item)

Inserts element at back of the queue.

See Also

Queue-class for information on base class.