Class LinkedList<T>

A generic doubly-linked list.

Type Parameters

Hierarchy

LinkedList

Implements

Iterable<T>
IRetroable<T>

Index

Constructors

constructor

new LinkedList<T>(): LinkedList<T>
Type Parameters
- T
Returns LinkedList<T>

Properties

`Private` _first

_first: null | LinkedListNode<T> = null

`Private` _last

_last: null | LinkedListNode<T> = null

`Private` _size

_size: number = 0

Accessors

first

get first(): undefined | T
The first value in the list.

This is undefined if the list is empty.

Complexity
Constant.

Returns undefined | T
- Defined in packages/collections/src/linkedlist.ts:62

firstNode

get firstNode(): null | INode<T>
The first node in the list.

This is null if the list is empty.

Complexity
Constant.

Returns null | INode<T>
- Defined in packages/collections/src/linkedlist.ts:86

isEmpty

get isEmpty(): boolean
Whether the list is empty.

Complexity
Constant.

Returns boolean
- Defined in packages/collections/src/linkedlist.ts:22

last

get last(): undefined | T
The last value in the list.

This is undefined if the list is empty.

Complexity
Constant.

Returns undefined | T
- Defined in packages/collections/src/linkedlist.ts:74

lastNode

get lastNode(): null | INode<T>
The last node in the list.

This is null if the list is empty.

Complexity
Constant.

Returns null | INode<T>
- Defined in packages/collections/src/linkedlist.ts:98

length

get length(): number
The length of the list.

Complexity
Constant.

Notes
This is equivalent to size.

This property is deprecated.

Returns number
- Defined in packages/collections/src/linkedlist.ts:50

size

get size(): number
The size of the list.

Complexity
O(1)

Notes
This is equivalent to length.

Returns number
- Defined in packages/collections/src/linkedlist.ts:35

Methods

[iterator]

[iterator](): IterableIterator<T>
Create an iterator over the values in the list.

Returns IterableIterator<T>
A new iterator starting with the first value.

Complexity
Constant.
Implementation of Iterable.[iterator]
- Defined in packages/collections/src/linkedlist.ts:110

addFirst

addFirst(value): INode<T>
Add a value to the beginning of the list.
Parameters
- value: T
  
  The value to add to the beginning of the list.
Returns INode<T>
The list node which holds the value.

Complexity
Constant.
- Defined in packages/collections/src/linkedlist.ts:251

addLast

addLast(value): INode<T>
Add a value to the end of the list.
Parameters
- value: T
  
  The value to add to the end of the list.
Returns INode<T>
The list node which holds the value.

Complexity
Constant.
- Defined in packages/collections/src/linkedlist.ts:275

assign

assign(values): void
Assign new values to the list, replacing all current values.
Parameters
- values: Iterable<T>
  
  The values to assign to the list.
  
  Complexity
  Linear.
Returns void
- Defined in packages/collections/src/linkedlist.ts:174

clear

clear(): void
Remove all values from the list.

Complexity
Linear.

Returns void
- Defined in packages/collections/src/linkedlist.ts:452

insertAfter

insertAfter(value, ref): INode<T>
Insert a value after a specific node in the list.
Parameters
- value: T
  
  The value to insert after the reference node.
- ref: null | INode<T>
  
  The reference node of interest. If this is null, the value will be added to the end of the list.
Returns INode<T>
The list node which holds the value.

Notes
The reference node must be owned by the list.

Complexity
Constant.
- Defined in packages/collections/src/linkedlist.ts:339

insertBefore

insertBefore(value, ref): INode<T>
Insert a value before a specific node in the list.
Parameters
- value: T
  
  The value to insert before the reference node.
- ref: null | INode<T>
  
  The reference node of interest. If this is null, the value will be added to the beginning of the list.
Returns INode<T>
The list node which holds the value.

Notes
The reference node must be owned by the list.

Complexity
Constant.
- Defined in packages/collections/src/linkedlist.ts:305

nodes

nodes(): IterableIterator<INode<T>>
Create an iterator over the nodes in the list.

Returns IterableIterator<INode<T>>
A new iterator starting with the first node.

Complexity
Constant.
- Defined in packages/collections/src/linkedlist.ts:142

pop

pop(): undefined | T
Remove and return the value at the end of the list.

Returns undefined | T
The removed value, or undefined if the list is empty.

Complexity
Constant.

Notes
This is equivalent to removeLast.
- Defined in packages/collections/src/linkedlist.ts:207

push

push(value): void
Add a value to the end of the list.
Parameters
- value: T
  
  The value to add to the end of the list.
  
  Complexity
  Constant.
  
  Notes
  This is equivalent to addLast.
Returns void
- Defined in packages/collections/src/linkedlist.ts:192

removeFirst

removeFirst(): undefined | T
Remove and return the value at the beginning of the list.

Returns undefined | T
The removed value, or undefined if the list is empty.

Complexity
Constant.
- Defined in packages/collections/src/linkedlist.ts:365

removeLast

removeLast(): undefined | T
Remove and return the value at the end of the list.

Returns undefined | T
The removed value, or undefined if the list is empty.

Complexity
Constant.
- Defined in packages/collections/src/linkedlist.ts:392

removeNode

removeNode(node): void
Remove a specific node from the list.
Parameters
- node: INode<T>
  
  The node to remove from the list.
  
  Complexity
  Constant.
  
  Notes
  The node must be owned by the list.
Returns void
- Defined in packages/collections/src/linkedlist.ts:422

retro

retro(): IterableIterator<T>
Create a reverse iterator over the values in the list.

Returns IterableIterator<T>
A new iterator starting with the last value.

Complexity
Constant.
Implementation of IRetroable.retro
- Defined in packages/collections/src/linkedlist.ts:126

retroNodes

retroNodes(): IterableIterator<INode<T>>
Create a reverse iterator over the nodes in the list.

Returns IterableIterator<INode<T>>
A new iterator starting with the last node.

Complexity
Constant.
- Defined in packages/collections/src/linkedlist.ts:158

shift

shift(value): void
Add a value to the beginning of the list.
Parameters
- value: T
  
  The value to add to the beginning of the list.
  
  Complexity
  Constant.
  
  Notes
  This is equivalent to addFirst.
Returns void
- Defined in packages/collections/src/linkedlist.ts:222

unshift

unshift(): undefined | T
Remove and return the value at the beginning of the list.

Returns undefined | T
The removed value, or undefined if the list is empty.

Complexity
Constant.

Notes
This is equivalent to removeFirst.
- Defined in packages/collections/src/linkedlist.ts:237

Class LinkedList<T>

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Returns LinkedList<T>

Properties

Private _first

Private _last

Private _size

Accessors

first

Returns undefined | T

firstNode

Returns null | INode<T>

isEmpty

Returns boolean

last

Returns undefined | T

lastNode

Returns null | INode<T>

length

Returns number

size

Returns number

Methods

[iterator]

Returns IterableIterator<T>

addFirst

Parameters

value: T

Returns INode<T>

addLast

Parameters

value: T

Returns INode<T>

assign

Parameters

values: Iterable<T>

Returns void

clear

Returns void

insertAfter

Parameters

value: T

ref: null | INode<T>

Returns INode<T>

insertBefore

Parameters

value: T

ref: null | INode<T>

Returns INode<T>

nodes

Returns IterableIterator<INode<T>>

pop

Returns undefined | T

push

Parameters

value: T

Returns void

removeFirst

Returns undefined | T

removeLast

Returns undefined | T

removeNode

Parameters

node: INode<T>

Returns void

retro

Returns IterableIterator<T>

retroNodes

`Private` _first

`Private` _last

`Private` _size