deque/io.klibs.collections/Deque

Deque

open class Deque<T>(initialCapacity: Int = 16, val scaleFactor: Float = 1.5f, val maxSize: Int)

Generic Deque

Deque type that accepts a generic type of values.

Author

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

Since

v0.1.0

Parameters

Type the values held by this Deque instance.

initialCapacity

Initial capacity of the internal data container backing the created deque.

Up to this many values may be added to the deque before the internal data container needs to be resized and reallocated.

scaleFactor

Internal storage reallocation scale factor.

If/when this Deque determines it needs to resize its internal data container to hold additional values being pushed, the internal data container will be resized at a rate of capacity * scaleFactor.

If the scale factor returns a value that is equal to or less than the current capacity, the resize will fall back to a size of capacity + 1.

Default: 1.5

maxSize

Maximum size this deque can grow to.

If adding a value to this Deque would push the size or capacity of the deque to be greater than maxSize then an exception will be thrown.

Default: 2,147,483,647 (Int.MAX_VALUE)

Constructors

Deque

fun Deque(initialCapacity: Int = 16, scaleFactor: Float = 1.5f, maxSize: Int)

Constructs a new Deque instance.

Types

Iterator

inner class Iterator

ReverseIterator

inner class ReverseIterator

Functions

append

inline fun append(value: T)

Pushes the given value onto the back of this deque.

atCapacity

inline fun atCapacity(): Boolean

Tests whether this deque is currently at capacity, or in other words is the number of items in this deque equal to the size of the underlying data container.

clear

fun clear()

Clears all elements from this dequeue, leaving it empty, but with the same allocated capacity.

contains

operator fun contains(value: T): Boolean

Tests whether this deque contains at least one instance of the given value.

ensureCapacity

fun ensureCapacity(minCapacity: Int)

Ensures that this deque has at least the given capacity allocated.

equals

open operator override fun equals(other: Any?): Boolean

get

operator fun get(index: Int): T

Gets the value at the given index from this deque.

hashCode

open override fun hashCode(): Int

insert

fun insert(index: Int, value: T)

Inserts the given value into this deque at the specified index.

isEmpty

inline fun isEmpty(): Boolean

Returns true if this deque contains zero items.

isNotEmpty

inline fun isNotEmpty(): Boolean

Returns true if this deque contains one or more items.

iterator

operator fun iterator(): Deque.Iterator<T>

Returns an iterator over the elements in this deque.

peekEach

fun peekEach(reverse: Boolean = false, fn: (value: T) -> Unit)

Calls the given function with each item in this deque.

peekEachIndexed

fun peekEachIndexed(reverse: Boolean, fn: (index: Int, value: T) -> Unit)

Calls the given function with each item in this deque and its index.

peekFirst

fun peekFirst(): T

Returns the first item in this deque.

peekFirstOr

fun peekFirstOr(value: T): T

Returns the first item in this deque if it is not empty, otherwise returns the given value.

peekFirstOrGet

fun peekFirstOrGet(fn: () -> T): T

Returns the first item in this deque if it is not empty, otherwise returns the value returned by the given function.

peekFirstOrNull

fun peekFirstOrNull(): T?

Returns the first item in this deque if it is not empty, otherwise returns null.

peekFirstOrThrow

fun peekFirstOrThrow(fn: () -> Throwable): T

Returns the first item in this deque if it is not empty, otherwise returns the value returned by the given function.

peekLast

fun peekLast(): T

Returns the last item in this deque.

peekLastOr

fun peekLastOr(value: T): T

Returns the last item in this deque if it is not empty, otherwise returns the given value.

peekLastOrGet

fun peekLastOrGet(fn: () -> T): T

Returns the last item in this deque if it is not empty, otherwise returns the value returned by the given function.

peekLastOrNull

fun peekLastOrNull(): T?

Returns the last item in this deque if it is not empty, otherwise returns null.

peekLastOrThrow

fun peekLastOrThrow(fn: () -> Throwable): T

Returns the last item in this deque if it is not empty, otherwise returns the value returned by the given function.

plusAssign

inline operator fun plusAssign(value: T)

popAt

fun popAt(index: Int): T

Removes and returns the element at the given index from this deque.

popEach

fun popEach(reverse: Boolean = false, fn: (value: T) -> Unit)

Removes each item off of this deque one at a time and calls the given function with each removed item.

popEachIndexed

fun popEachIndexed(reverse: Boolean = false, fn: (index: Int, value: T) -> Unit)

Removes each item off of this deque one at a time and calls the given function with each removed item along with the index of that item in the deque.

popFirst

fun popFirst(): T

Removes the first item from this deque and returns it.

popFirstOr

fun popFirstOr(value: T): T

Removes and returns the first item in this deque or returns value if this deque is empty.

popFirstOrGet

fun popFirstOrGet(fn: () -> T): T

Removes and returns the first item in this deque or returns the value returned by fn if this deque is empty.

popFirstOrNull

fun popFirstOrNull(): T?

Removes and returns the first item in this deque or returns null if this deque is empty.

popFirstOrThrow

fun popFirstOrThrow(fn: () -> Throwable): T

Removes the first item from this deque and returns it.

popLast

fun popLast(): T

Removes the last item from this deque and returns it.

popLastOr

fun popLastOr(value: T): T

Removes and returns the last item in this deque or returns value if this deque is empty.

popLastOrGet

fun popLastOrGet(fn: () -> T): T

Removes and returns the last item in this deque or returns the value returned by fn if this deque is empty.

popLastOrNull

fun popLastOrNull(): T?

Removes and returns the last item in this deque or returns null if this deque is empty.

popLastOrThrow

fun popLastOrThrow(fn: () -> Throwable): T

Removes the last item from this deque and returns it.

prepend

inline fun prepend(value: T)

Pushes the given value onto the front of this deque.

pushFirst

fun pushFirst(value: T)

Pushes the given value onto the front of this deque.

pushLast

fun pushLast(value: T)

Pushes the given value onto the back of this deque.

reverseIterator

fun reverseIterator(): Deque.ReverseIterator<T>

Returns an iterator over the elements in this deque in reverse, starting from the last element and ending with the first.

set

operator fun set(index: Int, value: T)

Sets the value at the given index from this deque.

toString

open override fun toString(): String

Properties

capacity

val capacity: Int

Currently allocated capacity.

freeSpace

val freeSpace: Int

The amount of space left in this queue's currently allocated backing data container.

lastIndex

val lastIndex: Int

Index of the last element in this deque.

maxSize

val maxSize: Int

scaleFactor

val scaleFactor: Float = 1.5f

size

var size: Int = 0

Number of elements in this deque.