Class LinkedList<T>

A standard doubly-linked list implementation.

Type Parameters

Implements

Iterable<T>

Index

Constructors

constructor

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

Accessors

empty

get empty(): boolean
Returns true if the list is empty.

Returns boolean
- Defined in util/collection/LinkedList.ts:41

head

get head(): null | LinkedNode<T>
Returns the current head.

Returns null | LinkedNode<T>
- Defined in util/collection/LinkedList.ts:27

tail

get tail(): null | LinkedNode<T>
Returns the current tail.

Returns null | LinkedNode<T>
- Defined in util/collection/LinkedList.ts:34

Methods

[iterator]

"[iterator]"(): IterableIterator<T>
Returns a new iterator, starting at the head.

Returns IterableIterator<T>
Implementation of Iterable.[iterator]
- Defined in util/collection/LinkedList.ts:298

clear

clear(): void
Clears this list.

Returns void
- Defined in util/collection/LinkedList.ts:284

createIterator

createIterator(
    start: null | LinkedNode<T>,
    end: null | LinkedNode<T>,
    next: (current: LinkedNode<T>) => null | LinkedNode<T>,
): { next: () => IteratorResult<T>; "[iterator]"(): IterableIterator<T> }
Creates an iterable iterator, starting at the specified node, getting the next node from the next() function.

Note that using iterators is not as performant as some or forEach
Parameters
- start: null | LinkedNode<T>
  The starting node. (inclusive)
- end: null | LinkedNode<T>
  The ending node (exclusive).
- next: (current: LinkedNode<T>) => null | LinkedNode<T>
  A method that is given the current node, and returns the next node.
Returns { next: () => IteratorResult<T>; "[iterator]"(): IterableIterator<T> }
- Defined in util/collection/LinkedList.ts:320

find

find(predicate: (element: T) => boolean): null | LinkedNode<T>
Returns the first node matching the given predicate.
Parameters
- predicate: (element: T) => boolean
  A function where, when true is returned, returns the current node.
Returns null | LinkedNode<T>
- Defined in util/collection/LinkedList.ts:258

findLast

findLast(predicate: (element: T) => boolean): null | LinkedNode<T>
Returns the last node matching the given predicate.
Parameters
- predicate: (element: T) => boolean
  A function where, when true is returned, returns the current node.
Returns null | LinkedNode<T>
- Defined in util/collection/LinkedList.ts:272

forEach

forEach(callback: (element: T) => void): void
Iterates over every element, invoking the given callback.
Parameters
- callback: (element: T) => void
Returns void
- Defined in util/collection/LinkedList.ts:230

insertNodeAfter

insertNodeAfter(node: LinkedNode<T>, pointer: LinkedNode<T>): void
Inserts the given node after pointer node.
Parameters
- node: LinkedNode<T>
  The node to insert after pointer. If this node is currently in this list, it will first be removed.
- pointer: LinkedNode<T>
  The pointer node.
Returns void
- Defined in util/collection/LinkedList.ts:210

insertNodeBefore

insertNodeBefore(node: LinkedNode<T>, pointer: LinkedNode<T>): void
Inserts the given node before pointer node.
Parameters
- node: LinkedNode<T>
  The node to insert before pointer. If this node is currently in this list, it will first be removed.
- pointer: LinkedNode<T>
  The pointer node.
Returns void
- Defined in util/collection/LinkedList.ts:188

pop

pop(): null | LinkedNode<T>
Removes the last node (the tail), returning it. If this list is empty, null is returned.

Returns null | LinkedNode<T>
- Defined in util/collection/LinkedList.ts:95

push

push(value: T): LinkedNode<T>
Creates a new node for the given value, adding it to the end of the list.
Parameters
- value: T
Returns LinkedNode<T>
Returns the newly created node.
- Defined in util/collection/LinkedList.ts:51

pushAll

pushAll(...values: T[]): void
Appends all given values to the end of this list.
Parameters
- ...values: T[]
Returns void
- Defined in util/collection/LinkedList.ts:67

pushNode

pushNode(node: LinkedNode<T>): void
Appends the given node to the tail of this list. If the node is already at the tail, it will no-op. If the node is in this list, it will be removed.
Parameters
- node: LinkedNode<T>
  The node to add or move to the tail of this list.
Returns void
- Defined in util/collection/LinkedList.ts:80

remove

remove(node: LinkedNode<T>): void
Removes the given linked node.
Parameters
- node: LinkedNode<T>
Returns void
- Defined in util/collection/LinkedList.ts:172

reversed

reversed(): IterableIterator<T>
Returns a new reversed iterable where the iterator starts at the tail, moving backwards to the head.

Returns IterableIterator<T>
- Defined in util/collection/LinkedList.ts:306

shift

shift(): null | LinkedNode<T>
Removes the first node (the head), returning it.
- If this list is empty, null is returned.
Returns null | LinkedNode<T>
- Defined in util/collection/LinkedList.ts:160

some

some(predicate: (element: T) => boolean): boolean
Similar to Array.prototype.some, returns true if at least one element passes the given predicate.
Parameters
- predicate: (element: T) => boolean
Returns boolean
- Defined in util/collection/LinkedList.ts:244

unshift

unshift(value: T): LinkedNode<T>
Creates a new node, adding it to the front of the list.
Parameters
- value: T
  The value to box in a linked node.
Returns LinkedNode<T>
Returns the new node.
- Defined in util/collection/LinkedList.ts:108

unshiftAll

unshiftAll(...values: T[]): void
Prepends all the given values to the head of this list. The values will maintain their order.

E.g.
```
list.unshiftAll(8, 9, 10)   // 8, 9, 10
list.unshiftAll(4, 5, 6, 7) // 4, 5, 6, 7, 8, 9, 10
list.unshiftAll(1, 2, 3)    // 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
```
Parameters
- ...values: T[]
  The values to box in linked nodes.
Returns void
- Defined in util/collection/LinkedList.ts:132

unshiftNode

unshiftNode(node: LinkedNode<T>): void
Prepends the given node to the head of this list.
- If the node is already at the head, it will no-op.
- If the node is in this list, it will be removed.
Parameters
- node: LinkedNode<T>
  The node to add or move to the head of this list.
Returns void
- Defined in util/collection/LinkedList.ts:145

Class LinkedList<T>

Type Parameters

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Returns LinkedList<T>

Accessors

empty

Returns boolean

head

Returns null | LinkedNode<T>

tail

Returns null | LinkedNode<T>

Methods

[iterator]

Returns IterableIterator<T>

clear

Returns void

createIterator

Parameters

Returns { next: () => IteratorResult<T>; "[iterator]"(): IterableIterator<T> }

find

Parameters

Returns null | LinkedNode<T>

findLast

Parameters

Returns null | LinkedNode<T>

forEach

Parameters

Returns void

insertNodeAfter

Parameters

Returns void

insertNodeBefore

Parameters

Returns void

pop

Returns null | LinkedNode<T>

push

Parameters

Returns LinkedNode<T>

pushAll

Parameters

Returns void

pushNode

Parameters

Returns void

remove

Parameters

Returns void

reversed

Returns IterableIterator<T>

shift

Returns null | LinkedNode<T>

some

Parameters

Returns boolean

unshift

Parameters

Returns LinkedNode<T>

unshiftAll

Parameters

Returns void

unshiftNode

Parameters

Returns void

Settings

On This Page