X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDeque.html;h=4486260a8f358ee46707cd4ae3e0a627f20f284b;hb=6349b7551b1060472ed8c97dd01ef0c827d62278;hp=61cdba861d8bc596834754900e965127fb6c4b8f;hpb=b7e141c40bccfd7a4ec0ff98b7829f7d296f048b;p=poolifier.git diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html index 61cdba86..4486260a 100644 --- a/docs/classes/Deque.html +++ b/docs/classes/Deque.html @@ -1,58 +1,12 @@ -Deque | poolifier - v2.6.41 -

-

-

- -

Class Deque<T>`Internal`

-

-

Deque. +Deque | poolifier - v3.0.7

Class Deque<T>`Internal`

Deque. Implemented with a doubly linked list.

-

-

-

-

Type Parameters

-

-
T
-
Type of deque data.
-
-

-

-

Hierarchy

-

Deque

-

-

-

-

Index

-

-

-

Constructors

-

-

-

Properties

-

Type Parameters

T
Type of deque data.
+

Hierarchy

Deque

Index

Constructors

Properties

head? maxSize size tail? -

-

-

Methods

-

Methods

[iterator] backward clear incrementSize @@ -62,286 +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.
- -
-
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 +

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