Class SequentialContainer<T>`Abstract`

Type Parameters

Hierarchy

Container<T>
- SequentialContainer
  - Vector
  - LinkList
  - Deque

Index

Constructors

constructor

Accessors

length

Constructors

constructor

new SequentialContainer<T>(): SequentialContainer<T>
Type Parameters
- T
Returns SequentialContainer<T>

Inherited from Container.constructor

Accessors

length

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

Example
```
const container = new Vector([1, 2]);
console.log(container.length); // 2
```
Returns number
Inherited from Container.length
- Defined in src/container/ContainerBase/index.ts:101

Methods

size

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

Example
```
const container = new Vector([1, 2]);
console.log(container.size()); // 2
```
Returns number
Inherited from Container.size
- Defined in src/container/ContainerBase/index.ts:110

empty

empty(): boolean
Returns
Whether the container is empty.

Example
```
container.clear();
console.log(container.empty());  // true
```
Returns boolean
Inherited from Container.empty
- Defined in src/container/ContainerBase/index.ts:119

`Abstract` clear

clear(): void
Description
Clear the container.

Example
```
container.clear();
console.log(container.empty());  // true
```
Returns void
Inherited from Container.clear
- Defined in src/container/ContainerBase/index.ts:128

`Abstract` begin

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

Example
```
const begin = container.begin();
const end = container.end();
for (const it = begin; !it.equals(end); it.next()) {
  doSomething(it.pointer);
}
```
Returns ContainerIterator<T>
Inherited from Container.begin
- Defined in src/container/ContainerBase/index.ts:141

`Abstract` end

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

Example
```
const begin = container.begin();
const end = container.end();
for (const it = begin; !it.equals(end); it.next()) {
  doSomething(it.pointer);
}
```
Returns ContainerIterator<T>
Inherited from Container.end
- Defined in src/container/ContainerBase/index.ts:151

`Abstract` rBegin

rBegin(): ContainerIterator<T>

Returns

Iterator pointing to the end element.

Example

const rBegin = container.rBegin();
const rEnd = container.rEnd();
for (const it = rBegin; !it.equals(rEnd); it.next()) {
  doSomething(it.pointer);
}

Returns ContainerIterator<T>

`Abstract` rEnd

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

Example
```
const rBegin = container.rBegin();
const rEnd = container.rEnd();
for (const it = rBegin; !it.equals(rEnd); it.next()) {
  doSomething(it.pointer);
}
```
Returns ContainerIterator<T>
Inherited from Container.rEnd
- Defined in src/container/ContainerBase/index.ts:171

`Abstract` front

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

Returns undefined | T
Inherited from Container.front
- Defined in src/container/ContainerBase/index.ts:175

`Abstract` back

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

Returns undefined | T
Inherited from Container.back
- Defined in src/container/ContainerBase/index.ts:179

`Abstract` find

find(element: T): ContainerIterator<T>
Returns
An iterator pointing to the element if found, or super end if not found.

Example
```
container.find(1).equals(container.end());
```
Parameters
- element: T
  
  The element you want to find.
Returns ContainerIterator<T>
Inherited from Container.find
- Defined in src/container/ContainerBase/index.ts:186

`Abstract` forEach

forEach(callback: ((element: T, index: number, container: Container<T>) => void)): void
Description
Iterate over all elements in the container.

Example
```
container.forEach((element, index) => console.log(element, index));
```
Parameters
- callback: ((element: T, index: number, container: Container<T>) => void)
  
  Callback function like Array.forEach.
  - - (element: T, index: number, container: Container<T>): void
    - Parameters
      
      element: T
      
      index: number
      
      container: Container<T>
      
      Returns void
Returns void
Inherited from Container.forEach
- Defined in src/container/ContainerBase/index.ts:193

`Abstract` getElementByPos

getElementByPos(pos: number): T
Description
Gets the value of the element at the specified position.

Example
```
const val = container.getElementByPos(-1); // throw a RangeError
```
Parameters
- pos: number
Returns T
Inherited from Container.getElementByPos
- Defined in src/container/ContainerBase/index.ts:199

`Abstract` eraseElementByPos

eraseElementByPos(pos: number): number
Description
Removes the element at the specified position.

Returns
The container length after erasing.

Example
```
container.eraseElementByPos(-1); // throw a RangeError
```
Parameters
- pos: number
  
  The element's position you want to remove.
Returns number
Inherited from Container.eraseElementByPos
- Defined in src/container/ContainerBase/index.ts:207

`Abstract` eraseElementByIterator

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

Returns
The next iterator.

Example
```
container.eraseElementByIterator(container.begin());
container.eraseElementByIterator(container.end()); // throw a RangeError
```
Parameters
- iter: ContainerIterator<T>
  
  The iterator you want to erase.
Returns ContainerIterator<T>
Inherited from Container.eraseElementByIterator
- Defined in src/container/ContainerBase/index.ts:216

`Abstract` [iterator]

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

Example
```
for (const element of container) {
  console.log(element);
}
```
Returns Generator<T, void, unknown>
Inherited from Container.[iterator]
- Defined in src/container/ContainerBase/index.ts:226

`Abstract` pushBack

pushBack(element: T): number
Description
Push the element to the back.

Returns
The size of container after pushing.
Parameters
- element: T
  
  The element you want to push.
Returns number
- Defined in src/container/SequentialContainer/Base/index.ts:9

`Abstract` popBack

popBack(): undefined | T
Description
Removes the last element.

Returns
The element you popped.

Returns undefined | T
- Defined in src/container/SequentialContainer/Base/index.ts:14

`Abstract` setElementByPos

setElementByPos(pos: number, element: T): void
Description
Sets element by position.

Example
```
container.setElementByPos(-1, 1); // throw a RangeError
```
Parameters
- pos: number
  
  The position you want to change.
- element: T
  
  The element's value you want to update.
Returns void
- Defined in src/container/SequentialContainer/Base/index.ts:22

`Abstract` eraseElementByValue

eraseElementByValue(value: T): number
Description
Removes the elements of the specified value.

Returns
The size of container after erasing.

Example
```
container.eraseElementByValue(-1);
```
Parameters
- value: T
  
  The value you want to remove.
Returns number
- Defined in src/container/SequentialContainer/Base/index.ts:30

`Abstract` insert

insert(pos: number, element: T, num?: number): number
Description
Insert several elements after the specified position.

Returns
The size of container after inserting.

Example
```
const container = new Vector([1, 2, 3]);
container.insert(1, 4);  // [1, 4, 2, 3]
container.insert(1, 5, 3); // [1, 5, 5, 5, 4, 2, 3]
```
Parameters
- pos: number
  
  The position you want to insert.
- element: T
  
  The element you want to insert.
- Optional num: number
  
  The number of elements you want to insert (default 1).
Returns number
- Defined in src/container/SequentialContainer/Base/index.ts:42

`Abstract` reverse

reverse(): SequentialContainer<T>
Description
Reverses the container.

Returns
The container's self.

Example
```
const container = new Vector([1, 2, 3]);
container.reverse(); // [3, 2, 1]
```
Returns SequentialContainer<T>
- Defined in src/container/SequentialContainer/Base/index.ts:50

`Abstract` unique

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

Returns
The size of container after inserting.

Example
```
const container = new Vector([1, 1, 3, 2, 2, 5, 5, 2]);
container.unique(); // [1, 3, 2, 5, 2]
```
Returns number
- Defined in src/container/SequentialContainer/Base/index.ts:58

`Abstract` sort

sort(cmp?: ((x: T, y: T) => number)): SequentialContainer<T>
Description
Sort the container.

Returns
The container's self.

Example
```
const container = new Vector([3, 1, 10]);
container.sort();  // [1, 10, 3]
container.sort((x, y) => x - y); // [1, 3, 10]
```
Parameters
- Optional cmp: ((x: T, y: T) => number)
  
  Comparison function to sort.
  - - (x: T, y: T): number
    - Parameters
      
      x: T
      
      y: T
      
      Returns number
Returns SequentialContainer<T>
- Defined in src/container/SequentialContainer/Base/index.ts:68

Class SequentialContainer<T>Abstract

Type Parameters

T

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

T

Returns SequentialContainer<T>

Accessors

length

Returns

Example

Returns number

Methods

size

Returns

Example

Returns number

empty

Returns

Example

Returns boolean

Abstract clear

Description

Example

Returns void

Abstract begin

Returns

Example

Returns ContainerIterator<T>

Abstract end

Returns

Example

Returns ContainerIterator<T>

Abstract rBegin

Returns

Example

Returns ContainerIterator<T>

Abstract rEnd

Returns

Example

Returns ContainerIterator<T>

Abstract front

Returns

Returns undefined | T

Abstract back

Returns

Returns undefined | T

Abstract find

Returns

Example

Parameters

element: T

Returns ContainerIterator<T>

Abstract forEach

Description

Example

Parameters

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

Parameters

element: T

index: number

container: Container<T>

Returns void

Returns void

Abstract getElementByPos

Description

Example

Parameters

pos: number

Returns T

Abstract eraseElementByPos

Description

Returns

Example

Class SequentialContainer<T>`Abstract`

`Abstract` clear

`Abstract` begin

`Abstract` end

`Abstract` rBegin

`Abstract` rEnd

`Abstract` front

`Abstract` back

`Abstract` find

`Abstract` forEach

`Abstract` getElementByPos

`Abstract` eraseElementByPos

`Abstract` eraseElementByIterator

`Abstract` [iterator]

`Abstract` pushBack

`Abstract` popBack

`Abstract` setElementByPos

`Abstract` eraseElementByValue

`Abstract` insert

`Optional` num: number

`Abstract` reverse

`Abstract` unique

`Abstract` sort

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