Class Vector<T>

Type Parameters

Hierarchy

SequentialContainer<T>
- Vector

Index

Constructors

constructor

new Vector<T>(container?: initContainer<T>, copy?: boolean): Vector<T>
Description
Vector's constructor.
Type Parameters
- T
Parameters
- container: initContainer<T> = []
  
  Initialize container, must have a forEach function.
- copy: boolean = true
  
  When the container is an array, you can choose to directly operate on the original object of the array or perform a shallow copy. The default is shallow copy.
Returns Vector<T>
Overrides SequentialContainer.constructor
- Defined in src/container/SequentialContainer/Vector.ts:29

Methods

[iterator]

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

Returns Generator<T, any, undefined>
Overrides SequentialContainer.[iterator]
- Defined in src/container/SequentialContainer/Vector.ts:161

back

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

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

begin

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

Returns VectorIterator<T>
Overrides SequentialContainer.begin
- Defined in src/container/SequentialContainer/Vector.ts:46

clear

clear(): void
Description
Clear the container.

Returns void
Overrides SequentialContainer.clear
- Defined in src/container/SequentialContainer/Vector.ts:42

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(): VectorIterator<T>
Returns
Iterator pointing to the super end like c++.

Returns VectorIterator<T>
Overrides SequentialContainer.end
- Defined in src/container/SequentialContainer/Vector.ts:54

eraseElementByIterator

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

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

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/Vector.ts:95

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/Vector.ts:100

find

find(element: T): VectorIterator<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 VectorIterator<T>
Overrides SequentialContainer.find
- Defined in src/container/SequentialContainer/Vector.ts:133

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/Vector.ts:86

front

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

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

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/Vector.ts:91

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/Vector.ts:128

popBack

popBack(): void
Description
Removes the last element.

Returns void
Overrides SequentialContainer.popBack
- Defined in src/container/SequentialContainer/Vector.ts:119

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/Vector.ts:115

rBegin

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

Returns VectorIterator<T>
Overrides SequentialContainer.rBegin
- Defined in src/container/SequentialContainer/Vector.ts:62

rEnd

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

Returns VectorIterator<T>
Overrides SequentialContainer.rEnd
- Defined in src/container/SequentialContainer/Vector.ts:71

reverse

reverse(): void
Description
Reverses the container.

Returns void
Overrides SequentialContainer.reverse
- Defined in src/container/SequentialContainer/Vector.ts:146

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/Vector.ts:124

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/Vector.ts:158

unique

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

Returns void
Overrides SequentialContainer.unique
- Defined in src/container/SequentialContainer/Vector.ts:149

Class Vector<T>

Type Parameters

T

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Description

Type Parameters

T

Parameters

container: initContainer<T> = []

copy: boolean = true

Returns Vector<T>

Methods

[iterator]

Description

Returns Generator<T, any, undefined>

back

Returns

Returns undefined | T

begin

Returns

Returns VectorIterator<T>

clear

Description

Returns void

empty

Returns

Returns boolean

end

Returns

Returns VectorIterator<T>

eraseElementByIterator

Description

Example

Parameters

iter: VectorIterator<T>

Returns VectorIterator<T>

eraseElementByPos

Description

Parameters

pos: number

Returns void

eraseElementByValue

Description

Parameters

value: T

Returns void

find

Returns

Parameters

element: T

Returns VectorIterator<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

Parameters

pos: number

element: T

num: number = 1

Returns void

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