Class CircArrayQueue<T>

Circular array queue -- an implementation of the Queue ADT using a circular array along with a dynamic resizing scheme.

Implements

Type Parameters

T

The type of all elements in the queue.

Hierarchy

CircArrayQueue

Implements

IQueue<T>

Index

Constructors

Properties

#elems #numElems #startIdx #growthFactor

Accessors

#endIdx capacity size

Methods

#resize dequeue empty enqueue front iter toString

Constructors

constructor

new CircArrayQueue<T>(initCapacity?: number): CircArrayQueue<T>
Creates an empty queue.
Type Parameters
- T
  
  The type of all elements in the queue.
Parameters
- initCapacity: number = 2
  
  Initial anticipated number of elements to be stored in the queue.
Returns CircArrayQueue<T>
- Defined in CircArrayQueue.ts:70

Properties

`Private` #elems

#elems: T[]

The underlying array for storing queue elements of type T.

`Private` #numElems

#numElems: number

Number of elements in the queue.

`Private` #startIdx

#startIdx: number

Position of the front element in the underlying array.

`Static` `Private` #growthFactor

#growthFactor: number = 2

Growth factor for the underlying array.

Static

Accessors

`Private` #endIdx

get #endIdx(): number
Position of the one past the last queue element in the underlying array.

Returns number
- Defined in CircArrayQueue.ts:98

capacity

get capacity(): number
The maximum number of elements the queue can store without allocating additional memory.

Returns number
- Defined in CircArrayQueue.ts:89

size

get size(): number
Number of elements in the queue.

Returns number
Implementation of IQueue.size
- Defined in CircArrayQueue.ts:146

Methods

`Private` #resize

#resize(grow?: boolean): void
Grows or shrinks the underlying array by a factor of 2.
Parameters
- grow: boolean = true
  
  Grow/shrink flag.
Returns void
- Defined in CircArrayQueue.ts:113

dequeue

dequeue(): boolean
Removes the front element from the queue if not empty.

Returns
true on success, false otherwise.

Returns boolean
Implementation of IQueue.dequeue
- Defined in CircArrayQueue.ts:218

empty

empty(): boolean
Whether the queue has no elements.

Returns
true if the queue is empty, false otherwise.

Returns boolean
Implementation of IQueue.empty
- Defined in CircArrayQueue.ts:154

enqueue

enqueue(elem: T): void
Adds an element to the end of the queue.
Parameters
- elem: T
  
  The element to be added.
Returns void
Implementation of IQueue.enqueue
- Defined in CircArrayQueue.ts:208

front

front(): null | T
Gets the element at the front of the queue if not empty.

Returns
The front element.

Returns null | T
Implementation of IQueue.front
- Defined in CircArrayQueue.ts:197

iter

iter(action: ((elem: T) => void)): void
Iterates over all elements of this queue from the front.

The given operation will be performed on each element iterated.
Parameters
- action: ((elem: T) => void)
  
  The operation to be performed on each element.
  - - (elem: T): void
    - Parameters
      
      elem: T
      
      Returns void
Returns void
Implementation of IQueue.iter
- Defined in CircArrayQueue.ts:165

toString

toString(separator?: string): string
Creates a string representation of this queue.

Elements are presented in the queue order from left to right.

Returns
The string representation.
Parameters
- separator: string = ' '
  
  Element separator. Defaults to a single space character.
Returns string
Implementation of IQueue.toString
- Defined in CircArrayQueue.ts:182

Generated using TypeDoc