X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDeque.html;h=2bc899a2cd1672dcab37359dacfb9d3437475072;hb=77e8da5a0633e5a282ddc82f52b354101d112f0f;hp=3d05d8758e33f6dd49f12638ff897daf9e6ae4df;hpb=1ed7fb6c99f2fcb5f319d9c1fa2aefc5434f82e4;p=poolifier.git diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html index 3d05d875..2bc899a2 100644 --- a/docs/classes/Deque.html +++ b/docs/classes/Deque.html @@ -1,307 +1,42 @@ -Deque | poolifier - v3.0.2 -

-

-

- -

Class Deque<T>`Internal`

-

-

Deque. +Deque | poolifier - v3.1.29

Class Deque<T>`Internal`

Deque. Implemented with a doubly linked list.

-

-

-

-

Type Parameters

-

-
T
-
Type of deque data.
-
-

-

-

Hierarchy

-

Deque

-

-

-

-

Index

-

-

-

Constructors

-

-

-

Properties

-

head? -maxSize -size -tail? -

-

-

Methods

-

[iterator] -backward -clear -incrementSize -peekFirst -peekLast -pop -push -shift -unshift -

-

-

Constructors

-

-

constructor

-

new Deque<T>(): Deque<T>
-
-
Type Parameters
-
- -
  T
-
Returns Deque<T>
-
- Defined in src/deque.ts:34

-

-

Properties

-

-

`Private` `Optional` head

-

head?: Node<T>

-

-

maxSize

-

maxSize: number

-

The maximum size of the deque.

-

-

-

-

size

-

size: number

-

The size of the deque.

-

-

-

-

`Private` `Optional` tail

-

tail?: Node<T>

-

-

Methods

-

-

[iterator]

-

[iterator](): Iterator<T, any, undefined>
-
Returns an iterator for the deque.
-
-
Returns Iterator<T, any, undefined>
An iterator for the deque.
- -
-
See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
-
-
- Defined in src/deque.ts:144

-

-

backward

-

backward(): Iterable<T>
-
Returns an backward iterator for the deque.
-
-
Returns Iterable<T>
An backward iterator for the deque.
- -
-
See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
-
-
- Defined in src/deque.ts:170

-

-

clear

-

clear(): void
-
Clears the deque.
-
-
Returns void
-
-
- Defined in src/deque.ts:131

-

-

`Private` incrementSize

-

incrementSize(): number
-
Returns number
-
- Defined in src/deque.ts:194

-

-

peekFirst

-

peekFirst(): undefined | T
-
Peeks at the first data.
-
-
Returns undefined | T
The first data or undefined if the deque is empty.
- -
-
- Defined in src/deque.ts:116

-

-

peekLast

-

peekLast(): undefined | T
-
Peeks at the last data.
-
-
Returns undefined | T
The last data or undefined if the deque is empty.
- -
-
- Defined in src/deque.ts:124

-

-

pop

-

pop(): undefined | T
-
Pops data from the deque.
-
-
Returns undefined | T
The popped data or undefined if the deque is empty.
- -
-
- Defined in src/deque.ts:77

-

-

push

-

push(data): number
-
Appends data to the deque.
-
-
-
Parameters
-
- -
  data: T
  -
  Data to append.
  -
  -
-
Returns number
The new size of the queue.
- -
-
- Defined in src/deque.ts:44

-

-

shift

-

shift(): undefined | T
-
Shifts data from the deque.
-
-
Returns undefined | T
The shifted data or undefined if the deque is empty.
- -
-
- Defined in src/deque.ts:97

-

-

unshift

-

unshift(data): number
-
Prepends data to the deque.
-
-
-
Parameters
-
- -
  data: T
  -
  Data to prepend.
  -
  -
-
Returns number
The new size of the queue.
- -
-
- Defined in src/deque.ts:61

-

-

-

Generated using TypeDoc

-

\ No newline at end of file +

Type Parameters

T
Type of deque data.
+

Index

Constructors

Properties

head? +maxSize +size +tail? +

Methods

[iterator] +backward +clear +incrementSize +peekFirst +peekLast +pop +push +shift +unshift +

Constructors

constructor

new Deque<T>(): Deque<T>
Type Parameters
- T
Returns Deque<T>
- Defined in src/deque.ts:30

Properties

`Private` `Optional` head

head?: ILinkedListNode<T>

maxSize

maxSize: number

The maximum size of the deque.

+

size

size: number

The size of the deque.

+

`Private` `Optional` tail

tail?: ILinkedListNode<T>

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Returns an iterator for the deque.
+
Returns Iterator<T, any, undefined>
An iterator for the deque.
+
See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
+
- Defined in src/deque.ts:140

backward

backward(): Iterable<T>
Returns an backward iterator for the deque.
+
Returns Iterable<T>
An backward iterator for the deque.
+
See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
+
- Defined in src/deque.ts:166

clear

clear(): void
Clears the deque.
+
Returns void
- Defined in src/deque.ts:127

`Private` incrementSize

incrementSize(): number
Returns number
- Defined in src/deque.ts:190

peekFirst

peekFirst(): undefined | T
Peeks at the first data.
+
Returns undefined | T
The first data or undefined if the deque is empty.
+
- Defined in src/deque.ts:112

peekLast

peekLast(): undefined | T
Peeks at the last data.
+
Returns undefined | T
The last data or undefined if the deque is empty.
+
- Defined in src/deque.ts:120

pop

pop(): undefined | T
Pops data from the deque.
+
Returns undefined | T
The popped data or undefined if the deque is empty.
+
- Defined in src/deque.ts:73

push

push(data): number
Appends data to the deque.
+
Parameters
- data: T
  Data to append.
  +
Returns number
The new size of the deque.
+
- Defined in src/deque.ts:40

shift

shift(): undefined | T
Shifts data from the deque.
+
Returns undefined | T
The shifted data or undefined if the deque is empty.
+
- Defined in src/deque.ts:93

unshift

unshift(data): number
Prepends data to the deque.
+
Parameters
- data: T
  Data to prepend.
  +
Returns number
The new size of the deque.
+
- Defined in src/deque.ts:57

Generated using TypeDoc

\ No newline at end of file