Class Deque<T>

Type Parameters

Hierarchy

SequentialContainer<T>
- Deque

Index

Constructors

constructor

new Deque<T>(container?: initContainer<T>, _bucketSize?: number): Deque<T>
Type Parameters
- T
Parameters
- container: initContainer<T> = []
- _bucketSize: number = ...
Returns Deque<T>
Overrides SequentialContainer.constructor
- Defined in src/container/SequentialContainer/Deque.ts:47

Methods

[iterator]

[iterator](): Generator<T, void, unknown>
Description
Using for for...of syntax like Array.

Returns Generator<T, void, unknown>
Overrides SequentialContainer.[iterator]
- Defined in src/container/SequentialContainer/Deque.ts:382

back

back(): undefined | T
Returns
The last element of the container.

Returns undefined | T
Overrides SequentialContainer.back
- Defined in src/container/SequentialContainer/Deque.ts:123

begin

begin(): DequeIterator<T>
Returns
Iterator pointing to the beginning element.

Returns DequeIterator<T>
Overrides SequentialContainer.begin
- Defined in src/container/SequentialContainer/Deque.ts:126

clear

clear(): void
Description
Clear the container.

Returns void
Overrides SequentialContainer.clear
- Defined in src/container/SequentialContainer/Deque.ts:114

cut

cut(pos: number): void
Description
Remove all elements after the specified position (excluding the specified position).

Example
```
deque.cut(1); // Then deque's size will be 2. deque -> [0, 1]
```
Parameters
- pos: number
  
  The previous position of the _first removed element.
Returns void
- Defined in src/container/SequentialContainer/Deque.ts:279

empty

empty(): boolean
Returns
Boolean about if the container is empty.

Returns boolean
Inherited from SequentialContainer.empty
- Defined in src/container/ContainerBase/index.ts:66

end

end(): DequeIterator<T>
Returns
Iterator pointing to the super end like c++.

Returns DequeIterator<T>
Overrides SequentialContainer.end
- Defined in src/container/SequentialContainer/Deque.ts:134

eraseElementByIterator

eraseElementByIterator(iter: DequeIterator<T>): DequeIterator<T>
Description
Removes element by iterator and move iter to next.

Example
```
container.eraseElementByIterator(container.begin());
```
Parameters
- iter: DequeIterator<T>
  
  The iterator you want to erase.
Returns DequeIterator<T>
Overrides SequentialContainer.eraseElementByIterator
- Defined in src/container/SequentialContainer/Deque.ts:317

eraseElementByPos

eraseElementByPos(pos: number): void
Description
Removes the element at the specified position.
Parameters
- pos: number
  
  The element's position you want to remove.
Returns void
Overrides SequentialContainer.eraseElementByPos
- Defined in src/container/SequentialContainer/Deque.ts:292

eraseElementByValue

eraseElementByValue(value: T): void
Description
Removes the elements of the specified value.
Parameters
- value: T
  
  The value you want to remove.
Returns void
Overrides SequentialContainer.eraseElementByValue
- Defined in src/container/SequentialContainer/Deque.ts:306

find

find(element: T): DequeIterator<T>
Returns
An iterator pointing to the element if found, or super end if not found.
Parameters
- element: T
  
  The element you want to find.
Returns DequeIterator<T>
Overrides SequentialContainer.find
- Defined in src/container/SequentialContainer/Deque.ts:323

forEach

forEach(callback: ((element: T, index: number) => void)): void
Description
Iterate over all elements in the container.
Parameters
- callback: ((element: T, index: number) => void)
  
  Callback function like Array.forEach.
  - - (element: T, index: number): void
    - Parameters
      
      element: T
      
      index: number
      
      Returns void
Returns void
Overrides SequentialContainer.forEach
- Defined in src/container/SequentialContainer/Deque.ts:237

front

front(): undefined | T
Returns
The first element of the container.

Returns undefined | T
Overrides SequentialContainer.front
- Defined in src/container/SequentialContainer/Deque.ts:120

getElementByPos

getElementByPos(pos: number): T
Description
Gets the value of the element at the specified position.
Parameters
- pos: number
Returns T
Overrides SequentialContainer.getElementByPos
- Defined in src/container/SequentialContainer/Deque.ts:242

insert

insert(pos: number, element: T, num?: number): void
Description
Insert several elements after the specified position.
Parameters
- pos: number
  
  The position you want to insert.
- element: T
  
  The element you want to insert.
- num: number = 1
  
  The number of elements you want to insert (default 1).
Returns void
Overrides SequentialContainer.insert
- Defined in src/container/SequentialContainer/Deque.ts:258

popBack

popBack(): void
Description
Removes the last element.

Returns void
Overrides SequentialContainer.popBack
- Defined in src/container/SequentialContainer/Deque.ts:179

popFront

popFront(): void
Description
Remove the _first element.

Returns void
- Defined in src/container/SequentialContainer/Deque.ts:221

pushBack

pushBack(element: T): void
Description
Push the element to the back.
Parameters
- element: T
  
  The element you want to push.
Returns void
Overrides SequentialContainer.pushBack
- Defined in src/container/SequentialContainer/Deque.ts:160

pushFront

pushFront(element: T): void
Description
Push the element to the front.
Parameters
- element: T
  
  The element you want to push.
Returns void
- Defined in src/container/SequentialContainer/Deque.ts:199

rBegin

rBegin(): DequeIterator<T>
Returns
Iterator pointing to the end element.

Returns DequeIterator<T>
Overrides SequentialContainer.rBegin
- Defined in src/container/SequentialContainer/Deque.ts:142

rEnd

rEnd(): DequeIterator<T>
Returns
Iterator pointing to the super begin like c++.

Returns DequeIterator<T>
Overrides SequentialContainer.rEnd
- Defined in src/container/SequentialContainer/Deque.ts:151

reverse

reverse(): void
Description
Reverses the container.

Returns void
Overrides SequentialContainer.reverse
- Defined in src/container/SequentialContainer/Deque.ts:336

setElementByPos

setElementByPos(pos: number, element: T): void
Description
Sets element by position.
Parameters
- pos: number
  
  The position you want to change.
- element: T
  
  The element's value you want to update.
Returns void
Overrides SequentialContainer.setElementByPos
- Defined in src/container/SequentialContainer/Deque.ts:250

shrinkToFit

shrinkToFit(): void
Description
Remove as much useless space as possible.

Returns void
- Defined in src/container/SequentialContainer/Deque.ts:370

size

size(): number
Returns
The size of the container.

Returns number
Inherited from SequentialContainer.size
- Defined in src/container/ContainerBase/index.ts:60

sort

sort(cmp?: ((x: T, y: T) => number)): void
Description
Sort the container.
Parameters
- Optional cmp: ((x: T, y: T) => number)
  
  Comparison function.
  - - (x: T, y: T): number
    - Parameters
      
      x: T
      
      y: T
      
      Returns number
Returns void
Overrides SequentialContainer.sort
- Defined in src/container/SequentialContainer/Deque.ts:359

unique

unique(): void
Description
Removes the duplication of elements in the container.

Returns void
Overrides SequentialContainer.unique
- Defined in src/container/SequentialContainer/Deque.ts:346

Class Deque<T>

Type Parameters

T

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

T

Parameters

container: initContainer<T> = []

_bucketSize: number = ...

Returns Deque<T>

Methods

[iterator]

Description

Returns Generator<T, void, unknown>

back

Returns

Returns undefined | T

begin

Returns

Returns DequeIterator<T>

clear

Description

Returns void

cut

Description

Example

Parameters

pos: number

Returns void

empty

Returns

Returns boolean

end

Returns

Returns DequeIterator<T>

eraseElementByIterator

Description

Example

Parameters

iter: DequeIterator<T>

Returns DequeIterator<T>

eraseElementByPos

Description

Parameters

pos: number

Returns void

eraseElementByValue

Description

Parameters

value: T

Returns void

find

Returns

Parameters

element: T

Returns DequeIterator<T>

forEach

Description

Parameters

callback: ((element: T, index: number) => void)

Parameters

element: T

index: number

Returns void

Returns void

front

Returns

Returns undefined | T

getElementByPos

Description

Parameters

pos: number

Returns T

insert

Description

`Optional` cmp: ((x: T, y: T) => number)