queue/io.klibs.collections/Queue

Queue

class Queue<T> : Collection<T> , Iterator<T>

FIFO Queue

Example:

// Create a new queue
val queue = Queue<Int>()

for (i in 1 .. 3)
  queue += i

for (i in 1 .. 3)
  require(stack.next() == i)

Author

Elizabeth Paige Harper - https://github.com/foxcapades

Since

1.0.0

Parameters

Type of items that will be appended to this queue.

Constructors

Queue

fun Queue(initialCapacity: Int = 8, scaleFactor: Float = 1.5f, maxSize: Int = Int.MAX_VALUE)

Constructs a new Queue instance.

Functions

append

fun append(value: T)

Appends the given value to the tail end of the queue.

contains

open operator override fun contains(element: T): Boolean

containsAll

open override fun containsAll(elements: Collection<T>): Boolean

get

operator fun get(i: Int): T

Gets the target queue element without removing it from the queue.

hasNext

open operator override fun hasNext(): Boolean

Tests whether this queue contains at least one more element.

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): Queue<T>

open operator override fun next(): T

Removes and returns the value from the head of the queue.

peekNext

fun peekNext(): T

Returns the value at the head of the queue without removing it.

plusAssign

operator fun plusAssign(value: T)

Alias for append.

Properties

capacity

var capacity: Int

Current capacity of this queue.

maxSize

val maxSize: Int

The maximum size this queue may grow to.

size

open override var size: Int

Current size of this queue.