queue/io.klibs.collections/Queue

Queue

FIFO Queue

Example:

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

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

for (i in 1 .. 3)
  require(queue.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.

clear

fun clear()

Clears all elements from this queue.

contains

operator fun contains(element: T): Boolean

Tests whether this Queue contains the given item.

containsAll

fun containsAll(vararg elements: T): Boolean

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

Tests whether this Queue contains all the given elements.

copyToArray

fun copyToArray(provider: (size: Int, init: (Int) -> T) -> Array<T>): Array<T>

Copies the contents of this Queue into an array constructed by the given provider.

destructiveForEach

inline fun destructiveForEach(fn: (T) -> Unit)

Calls the given function on every element in this Queue as each element is removed.

destructiveIterator

fun destructiveIterator(): Any

Returns a destructive, consuming iterator that pops elements from this Queue as it is iterated.

flushToArray

fun flushToArray(provider: (size: Int, init: (Int) -> T) -> Array<T>): Array<T>

Pops the contents of this Queue into an array constructed by the given provider.

get

operator fun get(i: Int): T

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

fun next(): T

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

nonDestructiveForEach

inline fun nonDestructiveForEach(fn: (T) -> Unit)

Calls the given function on every element in this Queue.

nonDestructiveIterator

fun nonDestructiveIterator(): Any

Returns a non-destructive iterator that iterates over the elements in this Queue.

peek

fun peek(): 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.

indices

val indices: IntRange

Returns the range of valid indices in this Queue.

isEmpty

val isEmpty: Boolean

true if this Queue contains zero items.

isNotEmpty

val isNotEmpty: Boolean

true if this Queue contains one or more items.

lastIndex

val lastIndex: Int

Last valid index in this Queue.

maxSize

val maxSize: Int

The maximum size this queue may grow to.

size

var size: Int

Current size of this queue.