X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDeque.html;h=c8db26f52715b2e443d817f8254e8b466d39a486;hb=dae90956d7de793209a952cb754b317a0ef221c8;hp=cdd41c158395f3fd54c29b527b638c55fba0d7e2;hpb=238a6a36482b3cf82d1f984f0bdd7d296a2f4ba1;p=poolifier.git diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html index cdd41c15..c8db26f5 100644 --- a/docs/classes/Deque.html +++ b/docs/classes/Deque.html @@ -1,7 +1,7 @@ -Deque | poolifier - v3.1.12

Class Deque<T>`Internal`

Deque. +Deque | poolifier - v3.1.19

Class Deque<T>`Internal`

Deque. Implemented with a doubly linked list.

-

Type Parameters

T
Type of deque data.
-

Index

Constructors

Type Parameters

T
Type of deque data.
+

Index

Constructors

Properties

head? maxSize size @@ -16,27 +16,27 @@ Implemented with a doubly linked list.

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.
+

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:144

backward

backward(): Iterable<T>
Returns an backward iterator for the deque.
-
Returns Iterable<T>
An backward iterator for the deque.
+

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.
  +
  - 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 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.
  +
  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 queue.
-
- Defined in src/deque.ts:61

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file