KavenLinkedList | kaven-basic

Represents a doubly-Linked circular list.

summary: In this type of linked list, the next of the last node will point to the first node and the previous pointer of the first node will point to the last node.
since: 1.1.19
version: 2019-03-22

Type parameters

T

Hierarchy

KavenLinkedList

Implements

IKavenLinkedList<T>
IRandom<T>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new KavenLinkedList<T>(): KavenLinkedList<T>

- Defined in libs/data_structures/KavenLinkedList.ts:51
Type parameters
- T
Returns KavenLinkedList<T>

Properties

Optional EqualityComparer

EqualityComparer: TEqualityComparer<T>

Protected count

count: number

Protected Optional head

head: KavenLinkedListNode<T>

Accessors

Count

get Count(): number

Implementation of IKavenLinkedList.Count
- Defined in libs/data_structures/KavenLinkedList.ts:67
Gets the number of nodes actually contained in the KavenLinkedList.

Returns number

First

get First(): undefined | KavenLinkedListNode<T>

Implementation of IKavenLinkedList.First
- Defined in libs/data_structures/KavenLinkedList.ts:63
Gets the first node of the KavenLinkedList.

Returns undefined | KavenLinkedListNode<T>

Last

get Last(): undefined | KavenLinkedListNode<T>

Implementation of IKavenLinkedList.Last
- Defined in libs/data_structures/KavenLinkedList.ts:55
Gets the last node of the KavenLinkedList.

Returns undefined | KavenLinkedListNode<T>

Methods

AddAfter

AddAfter(node: KavenLinkedListNode<T>, value: T): KavenLinkedListNode<T>

Implementation of IKavenLinkedList.AddAfter
- Defined in libs/data_structures/KavenLinkedList.ts:71
Adds a new node containing the specified value after the specified existing node in the KavenLinkedList.

Parameters
- node: KavenLinkedListNode<T>
- value: T
Returns KavenLinkedListNode<T>

The new KavenLinkedListNode containing value.

AddBefore

AddBefore(node: KavenLinkedListNode<T>, value: T): KavenLinkedListNode<T>

Implementation of IKavenLinkedList.AddBefore
- Defined in libs/data_structures/KavenLinkedList.ts:84
Adds a new node containing the specified value before the specified existing node in the KavenLinkedList.

Parameters
- node: KavenLinkedListNode<T>
- value: T
Returns KavenLinkedListNode<T>

The new KavenLinkedListNode containing value.

AddFirst

AddFirst(value: T): KavenLinkedListNode<T>

Implementation of IKavenLinkedList.AddFirst
- Defined in libs/data_structures/KavenLinkedList.ts:98
Adds a new node containing the specified value at the start of the KavenLinkedList.

Parameters
- value: T
Returns KavenLinkedListNode<T>

The new KavenLinkedListNode containing value.

AddLast

AddLast(value: T): KavenLinkedListNode<T>

Implementation of IKavenLinkedList.AddLast
- Defined in libs/data_structures/KavenLinkedList.ts:110
Adds a new node containing the specified value at the end of the KavenLinkedList.

Parameters
- value: T
Returns KavenLinkedListNode<T>

The new KavenLinkedListNode containing value.

Clear

Clear(): void

Implementation of IKavenLinkedList.Clear
- Defined in libs/data_structures/KavenLinkedList.ts:121
Removes all nodes from the KavenLinkedList.

Returns void

Contains

Contains(value: T): boolean

Implementation of IKavenLinkedList.Contains
- Defined in libs/data_structures/KavenLinkedList.ts:133
Determines whether a value is in the KavenLinkedList.

Parameters
- value: T
Returns boolean

true if value is found in the KavenLinkedList; otherwise, false.

Find

Find(value: T): undefined | KavenLinkedListNode<T>

Implementation of IKavenLinkedList.Find
- Defined in libs/data_structures/KavenLinkedList.ts:137
Finds the first node that contains the specified value.

Parameters
- value: T
Returns undefined | KavenLinkedListNode<T>

The first KavenLinkedListNode that contains the specified value, if found; otherwise, undefined.

FindLast

FindLast(value: T): undefined | KavenLinkedListNode<T>

Implementation of IKavenLinkedList.FindLast
- Defined in libs/data_structures/KavenLinkedList.ts:164
Finds the last node that contains the specified value.

Parameters
- value: T
Returns undefined | KavenLinkedListNode<T>

The last KavenLinkedListNode that contains the specified value, if found; otherwise, undefined.

Random

Random(): undefined | T

Implementation of IRandom.Random
- Defined in libs/data_structures/KavenLinkedList.ts:221
Returns undefined | T

Remove

Remove(value: T): boolean

Implementation of IKavenLinkedList.Remove
- Defined in libs/data_structures/KavenLinkedList.ts:198
Removes the first occurrence of the specified value from the KavenLinkedList.

Parameters
- value: T
Returns boolean

true if the element containing value is successfully removed; otherwise, false. This method also returns false if value was not found in the original KavenLinkedList.

RemoveFirst

RemoveFirst(): void

Implementation of IKavenLinkedList.RemoveFirst
- Defined in libs/data_structures/KavenLinkedList.ts:209
Removes the node at the start of the KavenLinkedList.

Returns void

RemoveLast

RemoveLast(): void

Implementation of IKavenLinkedList.RemoveLast
- Defined in libs/data_structures/KavenLinkedList.ts:215
Removes the node at the end of the KavenLinkedList.

Returns void

Protected insertNodeBefore

insertNodeBefore(node: KavenLinkedListNode<T>, newNode: KavenLinkedListNode<T>): void

- Defined in libs/data_structures/KavenLinkedList.ts:242
Parameters
- node: KavenLinkedListNode<T>
- newNode: KavenLinkedListNode<T>
Returns void

Protected insertNodeToEmptyList

insertNodeToEmptyList(newNode: KavenLinkedListNode<T>): void

- Defined in libs/data_structures/KavenLinkedList.ts:235
Parameters
- newNode: KavenLinkedListNode<T>
Returns void

Protected isEqual

isEqual(a: T, b: T): boolean

- Defined in libs/data_structures/KavenLinkedList.ts:278
Parameters
- a: T
- b: T
Returns boolean

Protected removeNode

removeNode(node: KavenLinkedListNode<T>): void

- Defined in libs/data_structures/KavenLinkedList.ts:258
Parameters
- node: KavenLinkedListNode<T>
Returns void

Generated using TypeDoc