Interface ITreeContainer<Key, T, SourceT, IteratorT, ReverseIteratorT, Elem>

Common interface for tree containers.

author: Jeongho Nam - https://github.com/samchon

Type parameters

Key
T: Elem
SourceT: ITreeContainer<Key, T, SourceT, IteratorT, ReverseIteratorT, Elem>
IteratorT: Iterator<T, SourceT, IteratorT, ReverseIteratorT, Elem>
ReverseIteratorT: ReverseIterator<T, SourceT, IteratorT, ReverseIteratorT, Elem>
Elem

Hierarchy

IAssociativeContainer<Key, T, SourceT, IteratorT, ReverseIteratorT, Elem>
- ITreeContainer
  - ITreeSet
  - ITreeMap

Implemented by

Index

Methods

Methods

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<T>

Inherited from IContainer.[Symbol.iterator]
- Defined in base/container/IContainer.ts:95
inheritdoc

Returns IterableIterator<T>

assign

assign<InputIterator>(first: InputIterator, last: InputIterator): void

Inherited from IContainer.assign
- Defined in base/container/IContainer.ts:44
Range Assigner.

Type parameters
- InputIterator: Readonly<IForwardIterator<Elem, InputIterator>>
Parameters
- first: InputIterator
  
  Input iteartor of the first position.
- last: InputIterator
  
  Input iterator of the last position.
Returns void

begin

begin(): IteratorT

Inherited from IContainer.begin

Overrides IForwardContainer.begin
- Defined in base/container/IContainer.ts:75
inheritdoc

Returns IteratorT

clear

clear(): void

Inherited from IContainer.clear
- Defined in base/container/IContainer.ts:50
inheritdoc

Returns void

count

count(key: Key): number

Inherited from IAssociativeContainer.count
- Defined in internal/container/associative/IAssociativeContainer.ts:43
Count elements with a specified key.

Parameters
- key: Key
  
  Key to search for.
Returns number

Number of elements with the specified key.

empty

empty(): boolean

Inherited from IContainer.empty

Overrides IEmpty.empty
- Defined in base/container/IContainer.ts:67
inheritdoc

Returns boolean

end

end(): IteratorT

Inherited from IContainer.end

Overrides IForwardContainer.end
- Defined in base/container/IContainer.ts:80
inheritdoc

Returns IteratorT

equal_range

equal_range(key: Key): Pair<IteratorT, IteratorT>

- Defined in internal/container/associative/ITreeContainer.ts:62
Get range of equal elements.

Parameters
- key: Key
  
  Key to search for.
Returns Pair<IteratorT, IteratorT>

Pair of lower_bound and upper_bound.

erase

erase(key: Key): number
erase(pos: IteratorT): IteratorT
erase(first: IteratorT, last: IteratorT): IteratorT

Inherited from IAssociativeContainer.erase

Overrides IContainer.erase
- Defined in internal/container/associative/IAssociativeContainer.ts:51
Erase elements with a specified key.

Parameters
- key: Key
  
  Key to search for.
Returns number

Number of erased elements.
Inherited from IAssociativeContainer.erase

Overrides IContainer.erase
- Defined in internal/container/associative/IAssociativeContainer.ts:56
inheritdoc

Parameters
- pos: IteratorT
Returns IteratorT
Inherited from IAssociativeContainer.erase

Overrides IContainer.erase
- Defined in internal/container/associative/IAssociativeContainer.ts:61
inheritdoc

Parameters
- first: IteratorT
- last: IteratorT
Returns IteratorT

find

find(key: Key): IteratorT

Inherited from IAssociativeContainer.find
- Defined in internal/container/associative/IAssociativeContainer.ts:27
Get iterator to element.

Parameters
- key: Key
  
  Key to search for.
Returns IteratorT

An iterator to the element, if the specified key is found, otherwise this.end().

has

has(key: Key): boolean

Inherited from IAssociativeContainer.has
- Defined in internal/container/associative/IAssociativeContainer.ts:35
Test whether a key exists.

Parameters
- key: Key
  
  Key to search for.
Returns boolean

Whether the specified key exists.

key_comp

key_comp(): Comparator<Key>

- Defined in internal/container/associative/ITreeContainer.ts:31
Get key comparison function.

Returns Comparator<Key>

The key comparison function.

lower_bound

lower_bound(key: Key): IteratorT

- Defined in internal/container/associative/ITreeContainer.ts:46
Get iterator to lower bound.

Parameters
- key: Key
  
  Key to search for.
Returns IteratorT

Iterator to the first element equal or after to the key.

push

push(...items: Elem[]): number

Inherited from IContainer.push
- Defined in internal/container/partial/IPush.ts:15
Insert items at the end.

Parameters
- Rest ...items: Elem[]
  
  Items to insert.
Returns number

Number of elements in the container after insertion.

rbegin

rbegin(): ReverseIteratorT

Inherited from IContainer.rbegin

Overrides IBidirectionalContainer.rbegin
- Defined in base/container/IContainer.ts:85
inheritdoc

Returns ReverseIteratorT

rend

rend(): ReverseIteratorT

Inherited from IContainer.rend

Overrides IBidirectionalContainer.rend
- Defined in base/container/IContainer.ts:90
inheritdoc

Returns ReverseIteratorT

size

size(): number

Inherited from IContainer.size

Overrides IForwardContainer.size
- Defined in base/container/IContainer.ts:62
inheritdoc

Returns number

swap

swap(obj: SourceT): void

Inherited from IContainer.swap
- Defined in base/container/IContainer.ts:127
Swap elements.

Parameters
- obj: SourceT
  
  Target container to swap.
Returns void

toJSON

toJSON(): Array<T>

Inherited from IContainer.toJSON
- Defined in base/container/IContainer.ts:134
Native function for JSON.stringify().

Returns Array<T>

An array containing children elements.

upper_bound

upper_bound(key: Key): IteratorT

- Defined in internal/container/associative/ITreeContainer.ts:54
Get iterator to upper bound.

Parameters
- key: Key
  
  Key to search for.
Returns IteratorT

Iterator to the first element after the key.

value_comp

value_comp(): Comparator<Elem>

- Defined in internal/container/associative/ITreeContainer.ts:38
Get value comparison function.

Returns Comparator<Elem>

The value comparison function.

Generated using TypeDoc