Class Container<T>`Abstract`

Type Parameters

T

Hierarchy

Base
- Container
  - SequentialContainer
  - TreeContainer

Index

Constructors

Methods

[iterator] back begin clear empty end eraseElementByIterator eraseElementByPos find forEach front getElementByPos rBegin rEnd size

Constructors

constructor

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

Inherited from Base.constructor

Methods

`Abstract` [iterator]

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

Returns Generator<T, void, undefined>
- Defined in src/container/ContainerBase/index.ts:130

`Abstract` back

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

Returns undefined | T
- Defined in src/container/ContainerBase/index.ts:99

`Abstract` begin

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

Returns ContainerIterator<T>
- Defined in src/container/ContainerBase/index.ts:79

`Abstract` clear

clear(): void
Description
Clear the container.

Returns void
Inherited from Base.clear
- Defined in src/container/ContainerBase/index.ts:72

empty

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

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

`Abstract` end

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

Returns ContainerIterator<T>
- Defined in src/container/ContainerBase/index.ts:83

`Abstract` eraseElementByIterator

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

Example
```
container.eraseElementByIterator(container.begin());
```
Parameters
- iter: ContainerIterator<T>
  
  The iterator you want to erase.
Returns ContainerIterator<T>
- Defined in src/container/ContainerBase/index.ts:124

`Abstract` 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
- Defined in src/container/ContainerBase/index.ts:118

`Abstract` find

find(element: T): ContainerIterator<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 ContainerIterator<T>
- Defined in src/container/ContainerBase/index.ts:109

`Abstract` 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
- Defined in src/container/ContainerBase/index.ts:104

`Abstract` front

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

Returns undefined | T
- Defined in src/container/ContainerBase/index.ts:95

`Abstract` getElementByPos

getElementByPos(pos: number): T
Description
Gets the value of the element at the specified position.
Parameters
- pos: number
Returns T
- Defined in src/container/ContainerBase/index.ts:113

`Abstract` rBegin

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

Returns ContainerIterator<T>
- Defined in src/container/ContainerBase/index.ts:87

`Abstract` rEnd

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

Returns ContainerIterator<T>
- Defined in src/container/ContainerBase/index.ts:91

size

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

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

Generated using TypeDoc