Options
All
  • Public
  • Public/Protected
  • All
Menu

A FIFO queue, where the first element pushed into the collection is also the first to be popped out of it.

import { Queue } from "scl"

Pushing and popping an element are both in O(1).

The following table summarises the time complexity of the most commonly used properties.

Property name Worst-case
add() O(1)
peek() O(1)
pop() O(1)
size O(1)
see

Stack

see

PriorityQueue

Type parameters

  • T

    The type of element in this queue.

Hierarchy

Implements

Index

Constructors

constructor

  • new Queue<T>(iterable?: Iterable<T>): Queue<T>
  • Creates a singly-linked list, optionally filled with the elements generated by the given iterable.

    const l = new DoubleinkedList();
    

    You can also construct a linked list from any iterable, like so:

    const l = new DoubleLinkedList([1, 2, 3])
    

    Type parameters

    • T

    Parameters

    • Optional iterable: Iterable<T>

    Returns Queue<T>

Accessors

size

  • get size(): number
  • Count the amount of elements in the collection.

    ⚠️ In most cases, this should be an O(1) operation. However, there are cases where this can be an O(n) operation. Therefore, it is recommended to always cache the result in a local variable.

    Returns number

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<T>
  • Returns an object which is able to sift through the values in this collection.

    The order by which the elements are traversed depends on the kind of collection. For unordered collections, the iteration order is unspecified and may even differ between two iterations on the same collection.

    Returns IterableIterator<T>

add

append

at

clear

  • clear(): void

clone

delete

  • delete(el: T): boolean

deleteAll

  • deleteAll(el: T): number

deleteAt

  • deleteAt(position: DLNode<T>): void

first

  • first(): T

getAt

  • getAt(position: number): T

has

  • has(el: T): boolean

insertAfter

insertBefore

last

  • last(): T

peek

  • peek(): T

pop

  • pop(): T

prepend

rest

toRange

Static empty

Static from

  • from<T>(iterable: Iterable<T>): Queue<T>

Legend

  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited property
  • Inherited method

Generated using TypeDoc