Class Queue<T>

This inherits from LinkedList with two extra properties for a rear node and max length.

It also implements common actions on queues such as enqueue and dequeue.

Type Parameters

T

The type of the satellite data.

Hierarchy

LinkedList<T>
- Queue

Index

Constructors

constructor

new Queue<T>(initial: LLNode<T> | notLLNode<T> | notLLNode<T>[], maxLength?: number): Queue<T>
Throws
When an invalid value for maxLength is provided.
Type Parameters
- T
Parameters
- initial: LLNode<T> | notLLNode<T> | notLLNode<T>[]
  
  The initial value(s) with which to initialize the queue. See LinkedList.
- Optional maxLength: number
  
  The maximum number of items in the queue. If not provided, there will be no limit.
Returns Queue<T>
Overrides LinkedList.constructor
- Defined in data_structures/queue/Queue.ts:29

Properties

head

head: null | LLNode<T>

The head (first LLNode node) of the linked list. This node is the first node encountered in LinkedList.traverse traversals.

length

length: number = 0

The number of nodes in the linked list.

maxLength

maxLength: null | number

The maximum number of items in the queue at any given time.

If null, there will be no restriction to the number of items.

rear

rear: LLNode<T>

Represents the last item in the queue.

This value changes when enqueue is called.

Methods

access

access(index: number): LLNode<T>
Accesses a node by index.

Note that this operation is O(n).

Returns
The LLNode at that index.

Throws
When the index is out of range.
Parameters
- index: number
  
  The index (0 is head, 1 is head.next) of the node.
Returns LLNode<T>
Inherited from LinkedList.access
- Defined in data_structures/linked_list/LinkedList.ts:149

dequeue

dequeue(): void
Dequeues the head of the queue.

Throws
When the queue is already empty.

Returns void
- Defined in data_structures/queue/Queue.ts:75

enqueue

enqueue(value: T): void
Places a new value in the queue.

This inserts a new LLNode after the current rear.

To enqueue at an arbitrary position in the queue, see LinkedList.insert

Throws
Throws when trying to add to a full queue.
Parameters
- value: T
  
  The value to enqueue.
Returns void
- Defined in data_structures/queue/Queue.ts:59

insert

insert(nodeValue: T, insertAfter: LLNode<T>): void
Inserts a value into the linked list.

Todo
Implement default behaviour to create set the new node as the new head as default behaviour when no insertAfter is specified.
Parameters
- nodeValue: T
  
  The satellite data of the new node to be inserted.
- insertAfter: LLNode<T>
  
  The LLNode after which to insert the new value.
Returns void
Inherited from LinkedList.insert
- Defined in data_structures/linked_list/LinkedList.ts:102

remove

remove(node: LLNode<T>): void
Removes the specified node from the linked list.

Throws
When the node is not present.
Parameters
- node: LLNode<T>
  
  The LLNode node to remove. It must be the exact object; it does not suffice for it to be a deep copy.
Returns void
Inherited from LinkedList.remove
- Defined in data_structures/linked_list/LinkedList.ts:116

traverse

traverse(): T[]
Traverses the linked list, returning an array representation of the LL, starting from the LinkedList.head head.

Returns an empty array when LinkedList.head head is null.

Returns
The traversal of the linked list.

Returns T[]
Inherited from LinkedList.traverse
- Defined in data_structures/linked_list/LinkedList.ts:80

Class Queue<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Throws

Type Parameters

T

Parameters

initial: LLNode<T> | notLLNode<T> | notLLNode<T>[]

Optional maxLength: number

Returns Queue<T>

Properties

head

length

maxLength

rear

Methods

access

Returns

Throws

Parameters

index: number

Returns LLNode<T>

dequeue

Throws

Returns void

enqueue

Throws

Parameters

value: T

Returns void

insert

Todo

Parameters

nodeValue: T

insertAfter: LLNode<T>

Returns void

remove

Throws

Parameters

node: LLNode<T>

Returns void

traverse

Returns

Returns T[]

Settings

Member Visibility

Theme

`Optional` maxLength: number