Class KavenLinkedList<T>

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

Hierarchy

KavenLinkedList

Implements

IKavenLinkedList<T>
IRandom<T>

Index

Constructors

constructor

new KavenLinkedList<T>(): KavenLinkedList<T>
Type Parameters
- T
Returns KavenLinkedList<T>
- Defined in libs/data_structures/KavenLinkedList.ts:51

Properties

`Optional` EqualityComparer

EqualityComparer?: TEqualityComparer<T>

`Protected` count

count: number

`Protected` `Optional` head

head?: KavenLinkedListNode<T>

Accessors

Count

get Count(): number
Gets the number of nodes actually contained in the KavenLinkedList.

Returns
The number of nodes actually contained in the KavenLinkedList.

Returns number
Implementation of IKavenLinkedList.Count
- Defined in libs/data_structures/KavenLinkedList.ts:67

First

get First(): undefined | KavenLinkedListNode<T>
Gets the first node of the KavenLinkedList.

Returns
The first KavenLinkedListNode of the KavenLinkedList.

Returns undefined | KavenLinkedListNode<T>
Implementation of IKavenLinkedList.First
- Defined in libs/data_structures/KavenLinkedList.ts:63

Last

get Last(): undefined | KavenLinkedListNode<T>
Gets the last node of the KavenLinkedList.

Returns
The last KavenLinkedListNode of the KavenLinkedList.

Returns undefined | KavenLinkedListNode<T>
Implementation of IKavenLinkedList.Last
- Defined in libs/data_structures/KavenLinkedList.ts:55

Methods

AddAfter

AddAfter(node: KavenLinkedListNode<T>, value: T): KavenLinkedListNode<T>
Adds a new node containing the specified value after the specified existing node in the KavenLinkedList.

Returns
The new KavenLinkedListNode containing value.
Parameters
- node: KavenLinkedListNode<T>
  
  The KavenLinkedListNode after which to insert newNode.
- value: T
  
  The value to add to the KavenLinkedList.
Returns KavenLinkedListNode<T>
Implementation of IKavenLinkedList.AddAfter
- Defined in libs/data_structures/KavenLinkedList.ts:71

AddBefore

AddBefore(node: KavenLinkedListNode<T>, value: T): KavenLinkedListNode<T>
Adds a new node containing the specified value before the specified existing node in the KavenLinkedList.

Returns
The new KavenLinkedListNode containing value.
Parameters
- node: KavenLinkedListNode<T>
  
  The KavenLinkedListNode before which to insert a new KavenLinkedListNode containing value.
- value: T
  
  The value to add to the KavenLinkedList.
Returns KavenLinkedListNode<T>
Implementation of IKavenLinkedList.AddBefore
- Defined in libs/data_structures/KavenLinkedList.ts:84

AddFirst

AddFirst(value: T): KavenLinkedListNode<T>
Adds a new node containing the specified value at the start of the KavenLinkedList.

Returns
The new KavenLinkedListNode containing value.
Parameters
- value: T
  
  The value to add at the start of the KavenLinkedList.
Returns KavenLinkedListNode<T>
Implementation of IKavenLinkedList.AddFirst
- Defined in libs/data_structures/KavenLinkedList.ts:98

AddLast

AddLast(value: T): KavenLinkedListNode<T>
Adds a new node containing the specified value at the end of the KavenLinkedList.

Returns
The new KavenLinkedListNode containing value.
Parameters
- value: T
  
  The value to add at the end of the KavenLinkedList.
Returns KavenLinkedListNode<T>
Implementation of IKavenLinkedList.AddLast
- Defined in libs/data_structures/KavenLinkedList.ts:110

Clear

Clear(): void
Removes all nodes from the KavenLinkedList.

Returns void
Implementation of IKavenLinkedList.Clear
- Defined in libs/data_structures/KavenLinkedList.ts:121

Contains

Contains(value: T): boolean
Determines whether a value is in the KavenLinkedList.

Returns
true if value is found in the KavenLinkedList; otherwise, false.
Parameters
- value: T
  
  The value to locate in the KavenLinkedList.
Returns boolean
Implementation of IKavenLinkedList.Contains
- Defined in libs/data_structures/KavenLinkedList.ts:133

Find

Find(value: T): undefined | KavenLinkedListNode<T>
Finds the first node that contains the specified value.

Returns
The first KavenLinkedListNode that contains the specified value, if found; otherwise, undefined.
Parameters
- value: T
  
  he value to locate in the KavenLinkedList.
Returns undefined | KavenLinkedListNode<T>
Implementation of IKavenLinkedList.Find
- Defined in libs/data_structures/KavenLinkedList.ts:137

FindLast

FindLast(value: T): undefined | KavenLinkedListNode<T>
Finds the last node that contains the specified value.

Returns
The last KavenLinkedListNode that contains the specified value, if found; otherwise, undefined.
Parameters
- value: T
  
  The value to locate in the KavenLinkedList.
Returns undefined | KavenLinkedListNode<T>
Implementation of IKavenLinkedList.FindLast
- Defined in libs/data_structures/KavenLinkedList.ts:164

Random

Random(): undefined | T
Returns
A random item in the collection without removing it.

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

Remove

Remove(value: T): boolean
Removes the first occurrence of the specified value from the KavenLinkedList.

Returns
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.
Parameters
- value: T
  
  The value to remove from the KavenLinkedList.
Returns boolean
Implementation of IKavenLinkedList.Remove
- Defined in libs/data_structures/KavenLinkedList.ts:198

RemoveFirst

RemoveFirst(): void
Removes the node at the start of the KavenLinkedList.

Returns void
Implementation of IKavenLinkedList.RemoveFirst
- Defined in libs/data_structures/KavenLinkedList.ts:209

RemoveLast

RemoveLast(): void
Removes the node at the end of the KavenLinkedList.

Returns void
Implementation of IKavenLinkedList.RemoveLast
- Defined in libs/data_structures/KavenLinkedList.ts:215

`Protected` insertNodeBefore

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

`Protected` insertNodeToEmptyList

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

`Protected` isEqual

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

`Protected` removeNode

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

Class KavenLinkedList<T>

Summary

Since

Version

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Returns KavenLinkedList<T>

Properties

Optional EqualityComparer

Protected count

Protected Optional head

Accessors

Count

Returns

Returns number

First

Returns

Returns undefined | KavenLinkedListNode<T>

Last

Returns

Returns undefined | KavenLinkedListNode<T>

Methods

AddAfter

Returns

Parameters

node: KavenLinkedListNode<T>

value: T

Returns KavenLinkedListNode<T>

AddBefore

Returns

Parameters

node: KavenLinkedListNode<T>

value: T

Returns KavenLinkedListNode<T>

AddFirst

Returns

Parameters

value: T

Returns KavenLinkedListNode<T>

AddLast

Returns

Parameters

value: T

Returns KavenLinkedListNode<T>

Clear

Returns void

Contains

Returns

Parameters

value: T

Returns boolean

Find

Returns

Parameters

value: T

Returns undefined | KavenLinkedListNode<T>

FindLast

Returns

Parameters

value: T

Returns undefined | KavenLinkedListNode<T>

Random

Returns

Returns undefined | T

Remove

Returns

Parameters

value: T

Returns boolean

`Optional` EqualityComparer

`Protected` count

`Protected` `Optional` head

`Protected` insertNodeBefore

`Protected` insertNodeToEmptyList

`Protected` isEqual

`Protected` removeNode