Class Queue<T>`Sealed`

A queue implemented using fixed-length arrays

Type Parameters

Hierarchy

Basic<T>
- Queue

Index

Constructors

constructor

new Queue<T>(capacity?: number, opts?: Options<T>): Queue<T>
Type Parameters
- T
Parameters
- capacity: number = 10
  
  if < 1 use default 10
- Optional opts: Options<T>
Returns Queue<T>
Overrides Basic.constructor
- Defined in src/container/queue.ts:24

Properties

`Private` a_

a_: T[]

`Private` offset_

offset_: number = 0

offset of array

`Protected` opts_

opts_: undefined | Options<T>

`Private` size_

size_: number = 0

queue size

Accessors

capacity

get capacity(): number
returns the capacity of the queue

Returns number
Overrides Basic.capacity
- Defined in src/container/queue.ts:43

isEmpty

get isEmpty(): boolean
Returns true if there is no data in the container

Returns boolean
Inherited from Basic.isEmpty
- Defined in src/container/types.ts:135

isFull

get isFull(): boolean
Returns true if the container has reached the container limit

Returns boolean
Inherited from Basic.isFull
- Defined in src/container/types.ts:151

isNotEmpty

get isNotEmpty(): boolean
Returns true if there is data in the container

Returns boolean
Inherited from Basic.isNotEmpty
- Defined in src/container/types.ts:143

isNotFull

get isNotFull(): boolean
Returns true if the container has not reached the container limit

Returns boolean
Inherited from Basic.isNotFull
- Defined in src/container/types.ts:159

length

get length(): number
returns the length of the queue

Returns number
Overrides Basic.length
- Defined in src/container/queue.ts:36

reverse

get reverse(): Iterable<T>
Sealed
Returns an object that implements a js Iterable, but it traverses the data in reverse

Returns Iterable<T>
Inherited from Basic.reverse
- Defined in src/container/types.ts:215

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
implements js Iterable

Sealedl

Returns Iterator<T, any, undefined>
Inherited from Basic.[iterator]
- Defined in src/container/types.ts:208

clear

clear(callback?: DeleteCallback<T>): void
clear the queue
Parameters
- Optional callback: DeleteCallback<T>
  
  call the callback on the removed element
Returns void
- Defined in src/container/queue.ts:168

clone

clone(callback?: CloneCallback<T>): Queue<T>
Create a full copy of the container
Parameters
- Optional callback: CloneCallback<T>
  
  How to create a duplicate copy of an element
Returns Queue<T>
- Defined in src/container/queue.ts:217

compareTo

compareTo(o: Container<T>, callback?: CompareCallback<T>): number
Returns true if the data depth of the two containers is consistent
Parameters
- o: Container<T>
- Optional callback: CompareCallback<T>
Returns number
Inherited from Basic.compareTo
- Defined in src/container/types.ts:181

find

find(callback: ValidCallback<T>, reverse?: boolean): boolean
Traverse the container looking for elements until the callback returns true, then stop looking

Returns
whether the element was found
Parameters
- callback: ValidCallback<T>
  
  Determine whether it is the element to be found
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns boolean
Inherited from Basic.find
- Defined in src/internal/decorator.ts:50

forEach

forEach(callback: ValueCallback<T>, reverse?: boolean): void
call callback on each element in the container in turn
Parameters
- callback: ValueCallback<T>
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns void
Inherited from Basic.forEach
- Defined in src/internal/decorator.ts:36

get

get(i: number): T
get queue element

Throws
TypeError

Throws
RangeError
Parameters
- i: number
Returns T
- Defined in src/container/queue.ts:51

has

has(data: T, reverse?: boolean, callback?: CompareCallback<T>): boolean
Returns whether the data data exists in the container
Parameters
- data: T
- Optional reverse: boolean
- Optional callback: CompareCallback<T>
Returns boolean
Inherited from Basic.has
- Defined in src/internal/decorator.ts:60

iterator

iterator(reverse?: boolean): Iterator<T, any, undefined>
return js iterator
Parameters
- Optional reverse: boolean
  
  If true, returns an iterator to traverse in reverse
Returns Iterator<T, any, undefined>
Overrides Basic.iterator
- Defined in src/container/queue.ts:182

join

join<TO>(separator?: string, callback?: MapCallback<T, TO>, reverse?: boolean): string
Adds all the elements of an container into a string, separated by the specified separator string.
Type Parameters
- TO
Parameters
- Optional separator: string
  
  A string used to separate one element of the container from the next in the resulting string. If omitted, the array elements are separated with a comma.
- Optional callback: MapCallback<T, TO>
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns string
Inherited from Basic.join
- Defined in src/internal/decorator.ts:83

map

map<TO>(callback: MapCallback<T, TO>, reverse?: boolean): TO[]
Convert container to array
Type Parameters
- TO
Parameters
- callback: MapCallback<T, TO>
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns TO[]
Inherited from Basic.map
- Defined in src/internal/decorator.ts:72

popBack

popBack(callback?: DeleteCallback<T>): ReturnValue<T>
If the queue is not empty delete the element at the back

Returns
deleted data
Parameters
- Optional callback: DeleteCallback<T>
  
  call the callback on the removed element
Returns ReturnValue<T>
- Defined in src/container/queue.ts:143

popBackRaw

popBackRaw(callback?: DeleteCallback<T>): ReturnValueRaw<T>
If the queue is not empty delete the element at the back

Returns
deleted data
Parameters
- Optional callback: DeleteCallback<T>
  
  call the callback on the removed element
Returns ReturnValueRaw<T>
- Defined in src/container/queue.ts:151

popFront

popFront(callback?: DeleteCallback<T>): ReturnValue<T>
If the queue is not empty delete the element at the front

Returns
deleted data
Parameters
- Optional callback: DeleteCallback<T>
  
  call the callback on the removed element
Returns ReturnValue<T>
- Defined in src/container/queue.ts:113

popFrontRaw

popFrontRaw(callback?: DeleteCallback<T>): ReturnValueRaw<T>
If the queue is not empty delete the element at the front

Returns
deleted data
Parameters
- Optional callback: DeleteCallback<T>
  
  call the callback on the removed element
Returns ReturnValueRaw<T>
- Defined in src/container/queue.ts:121

pushBack

pushBack(val: T): boolean
inserts val at the back of queue

Returns
Returns true if successful, if queue is full do nothing and return false
Parameters
- val: T
Returns boolean
- Defined in src/container/queue.ts:80

pushFront

pushFront(val: T): boolean
inserts val at the front of queue

Returns
Returns true if successful, if queue is full do nothing and return false
Parameters
- val: T
Returns boolean
- Defined in src/container/queue.ts:94

pushList

pushList(vals: Iterable<T>, callback?: CloneCallback<T>): void
push a copy of another container of queue.
Parameters
- vals: Iterable<T>
- Optional callback: CloneCallback<T>
Returns void
- Defined in src/container/queue.ts:230

set

set(i: number, val: T): void
set queue element

Throws
TypeError

Throws
RangeError
Parameters
- i: number
- val: T
Returns void
- Defined in src/container/queue.ts:66

Class Queue<T>Sealed

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

capacity: number = 10

Optional opts: Options<T>

Returns Queue<T>

Properties

Private a_

Private offset_

Protected opts_

Private size_

Accessors

capacity

Returns number

isEmpty

Returns boolean

isFull

Returns boolean

isNotEmpty

Returns boolean

isNotFull

Returns boolean

length

Returns number

reverse

Returns Iterable<T>

Methods

[iterator]

Sealedl

Returns Iterator<T, any, undefined>

clear

Parameters

Optional callback: DeleteCallback<T>

Returns void

clone

Parameters

Optional callback: CloneCallback<T>

Returns Queue<T>

compareTo

Parameters

o: Container<T>

Optional callback: CompareCallback<T>

Returns number

find

Returns

Parameters

callback: ValidCallback<T>

Optional reverse: boolean

Returns boolean

forEach

Parameters

callback: ValueCallback<T>

Optional reverse: boolean

Returns void

get

Throws

Throws

Parameters

i: number

Returns T

has

Parameters

data: T

Optional reverse: boolean

Optional callback: CompareCallback<T>

Returns boolean

iterator

Parameters

Optional reverse: boolean

Class Queue<T>`Sealed`

`Optional` opts: Options<T>

`Private` a_

`Private` offset_

`Protected` opts_

`Private` size_

`Optional` callback: DeleteCallback<T>

`Optional` callback: CloneCallback<T>

`Optional` callback: CompareCallback<T>

`Optional` reverse: boolean

`Optional` reverse: boolean

`Optional` reverse: boolean

`Optional` callback: CompareCallback<T>

`Optional` reverse: boolean

`Optional` separator: string

`Optional` callback: MapCallback<T, TO>

`Optional` reverse: boolean

`Optional` reverse: boolean

`Optional` callback: DeleteCallback<T>

`Optional` callback: DeleteCallback<T>

`Optional` callback: DeleteCallback<T>

`Optional` callback: DeleteCallback<T>

`Optional` callback: CloneCallback<T>