Class ArrayDeque<T>

A double-ended queue using a circular buffer.

Type Parameters

T

Implements

MaybeAsyncReadonlyMap<number, T>
PeekableDeque<T>
SyncDeque<T>
Iterable<T>
KeyValueIterable<number, T>

Index

Constructors

Properties

_capacity backIdx buffer frontIdx resizeFactor

Accessors

[toStringTag] capacity size

Methods

[iterator] back clear entries front get has isEmpty isFull keys pop push resize shift unshift values

Constructors

constructor

new ArrayDeque<T>(_capacity?, resizeFactor?): ArrayDeque<T>
Type Parameters
- T
Parameters
- _capacity: number = DEFAULT_DEQUE_CAPACITY
  The initial capacity.
- resizeFactor: number = DEFAULT_DEQUE_RESIZE_FACTOR
  The resize factor. When the buffer is full, it will resize to resizeFactor * capacity.
Returns ArrayDeque<T>
- Defined in collections/src/impl/arraydeque.ts:16

Properties

`Private` _capacity

_capacity: number = DEFAULT_DEQUE_CAPACITY

The initial capacity.

`Private` backIdx

backIdx: number = -1

`Private` buffer

buffer: T[]

`Private` frontIdx

frontIdx: number = -1

`Private` `Readonly` resizeFactor

resizeFactor: number = DEFAULT_DEQUE_RESIZE_FACTOR

The resize factor. When the buffer is full, it will resize to resizeFactor * capacity.

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in collections/src/impl/arraydeque.ts:25

capacity

get capacity(): number
Returns the current capacity of this ArrayDeque.

Returns number
- Defined in collections/src/impl/arraydeque.ts:30

size

get size(): number
Returns the size of this ArrayDeque.

Returns number
- Defined in collections/src/impl/arraydeque.ts:35

Methods

[iterator]

[iterator](): IterableIterator<T>
Returns IterableIterator<T>
Implementation of Iterable.[iterator]
- Defined in collections/src/impl/arraydeque.ts:183

back

back(): undefined | T
Returns the top element of this Stack, or undefined if empty.

Returns undefined | T
Implementation of SyncDeque.back
- Defined in collections/src/impl/arraydeque.ts:55

clear

clear(): void
Clears this ArrayDeque.

Returns void
- Defined in collections/src/impl/arraydeque.ts:76

entries

entries(): IterableIterator<[number, T]>
Queries key-value pairs by given criteria.

Returns IterableIterator<[number, T]>
Implementation of KeyValueIterable.entries
- Defined in collections/src/impl/arraydeque.ts:162

front

front(): undefined | T
Returns the first item of this Queue, or undefined if empty.

Returns undefined | T
Implementation of SyncDeque.front
- Defined in collections/src/impl/arraydeque.ts:47

get

get(i): undefined | T
Gets a value by key from the map.
Parameters
- i: number
Returns undefined | T
Implementation of MaybeAsyncReadonlyMap.get
- Defined in collections/src/impl/arraydeque.ts:63

has

has(index): boolean
Returns whether a key exists in the map.
Parameters
- index: number
Returns boolean
Implementation of MaybeAsyncReadonlyMap.has
- Defined in collections/src/impl/arraydeque.ts:71

`Private` isEmpty

isEmpty(): boolean
Returns boolean
- Defined in collections/src/impl/arraydeque.ts:187

`Private` isFull

isFull(): boolean
Returns boolean
- Defined in collections/src/impl/arraydeque.ts:191

keys

keys(): IterableIterator<number>
Queries keys by given criteria.

Returns IterableIterator<number>
Implementation of KeyValueIterable.keys
- Defined in collections/src/impl/arraydeque.ts:169

pop

pop(): undefined | T
Removes and returns the last element of this ArrayDeque, or undefined if empty.

Returns undefined | T
Implementation of SyncDeque.pop
- Defined in collections/src/impl/arraydeque.ts:127

push

push(item): void
Adds an element to the end of this ArrayDeque.
Parameters
- item: T
Returns void
Implementation of SyncDeque.push
- Defined in collections/src/impl/arraydeque.ts:112

resize

resize(newCapacity?): void
Resizes this ArrayDeque to the new capacity. By default, it expands to 2x the current capacity. Does nothing if new capacity is less than current size.
Parameters
- newCapacity: number = ...
Returns void
- Defined in collections/src/impl/arraydeque.ts:147

shift

shift(): undefined | T
Removes and returns the first element of this ArrayDeque, or undefined if empty.

Returns undefined | T
Implementation of SyncDeque.shift
- Defined in collections/src/impl/arraydeque.ts:96

unshift

unshift(item): void
Adds an element to the beginning of this ArrayDeque.
Parameters
- item: T
Returns void
Implementation of SyncDeque.unshift
- Defined in collections/src/impl/arraydeque.ts:81

values

values(): IterableIterator<T>
Queries values by given criteria.

Returns IterableIterator<T>
Implementation of KeyValueIterable.values
- Defined in collections/src/impl/arraydeque.ts:176

Generated using TypeDoc