MultiTreeMap

Basic tree map allowing duplicated keys.

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

Type parameters

Key

Key type
T

Mapped type
Source: MultiTreeMap<Key, T, Source, IteratorT, ReverseT>

Derived type extending this MultiTreeMap
IteratorT: Iterator<Key, T, Source, IteratorT, ReverseT>

Iterator type
ReverseT: ReverseIterator<Key, T, Source, IteratorT, ReverseT>

Reverse iterator type

Hierarchy

MultiMap<Key, T, Source, IteratorT, ReverseT>
- MultiTreeMap
  - TreeMultiMap
  - FlatMultiMap

Implements

IContainer<Entry<Key, T>, Source, IteratorT, ReverseT, IPair<Key, T>>
IAssociativeContainer<Key, Entry<Key, T>, Source, IteratorT, ReverseT, IPair<Key, T>>
ITreeContainer<Key, Entry<Key, T>, Source, IteratorT, ReverseT, IPair<Key, T>>

Index

Type aliases

Constructors

constructor

Methods

Type aliases

Static Iterator

Iterator<Key, T, SourceT, IteratorT, ReverseT>: Iterator<Key, T, false, SourceT, IteratorT, ReverseT>

Iterator of MultiMap

author: Jenogho Nam http://samchon.org

Type parameters

Key
T
SourceT: MultiMap<Key, T, SourceT, IteratorT, ReverseT>
IteratorT: Iterator<Key, T, SourceT, IteratorT, ReverseT>
ReverseT: ReverseIterator<Key, T, SourceT, IteratorT, ReverseT>

Static ReverseIterator

ReverseIterator<Key, T, SourceT, IteratorT, ReverseT>: ReverseIterator<Key, T, false, SourceT, IteratorT, ReverseT>

Reverse iterator of MultiMap

author: Jenogho Nam http://samchon.org

Type parameters

Key
T
SourceT: MultiMap<Key, T, SourceT, IteratorT, ReverseT>
IteratorT: Iterator<Key, T, SourceT, IteratorT, ReverseT>
ReverseT: ReverseIterator<Key, T, SourceT, IteratorT, ReverseT>

Constructors

Protected constructor

new MultiTreeMap(factory: (thisArg: Source) => ILinearContainerBase<Entry<Key, T>, Source, IteratorT, ReverseT>): MultiTreeMap

Inherited from MapContainer.constructor
- Defined in base/container/MapContainer.ts:40
Default Constructor.

Parameters
- factory: (thisArg: Source) => ILinearContainerBase<Entry<Key, T>, Source, IteratorT, ReverseT>
  - - (thisArg: Source): ILinearContainerBase<Entry<Key, T>, Source, IteratorT, ReverseT>
    - Parameters
      - thisArg: Source
      Returns ILinearContainerBase<Entry<Key, T>, Source, IteratorT, ReverseT>
Returns MultiTreeMap

Methods

[Symbol.iterator]

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

Implementation of ITreeContainer.[Symbol.iterator]

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

Returns IterableIterator<Entry<Key, T>>

assign

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

Implementation of ITreeContainer.assign

Inherited from MapContainer.assign

Overrides Container.assign
- Defined in base/container/MapContainer.ts:57
Range Assigner.

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

begin

begin(): IteratorT

Implementation of ITreeContainer.begin

Inherited from MapContainer.begin

Overrides Container.begin
- Defined in base/container/MapContainer.ts:89
inheritdoc

Returns IteratorT

clear

clear(): void

Implementation of ITreeContainer.clear

Inherited from MapContainer.clear

Overrides Container.clear
- Defined in base/container/MapContainer.ts:68
inheritdoc

Returns void

count

count(key: Key): number

Implementation of ITreeContainer.count

Overrides MapContainer.count
- Defined in internal/container/associative/MultiTreeMap.ts:54
Count elements with a specified key.

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

Number of elements with the specified key.

emplace

emplace(key: Key, val: T): IteratorT

Overrides MultiMap.emplace
- Defined in internal/container/associative/MultiTreeMap.ts:107
inheritdoc

Parameters
- key: Key
- val: T
Returns IteratorT

emplace_hint

emplace_hint(hint: IteratorT, key: Key, val: T): IteratorT

Overrides MultiMap.emplace_hint
- Defined in internal/container/associative/MultiTreeMap.ts:122
inheritdoc

Parameters
- hint: IteratorT
- key: Key
- val: T
Returns IteratorT

empty

empty(): boolean

Implementation of ITreeContainer.empty

Inherited from Container.empty
- Defined in base/container/Container.ts:59
inheritdoc

Returns boolean

end

end(): IteratorT

Implementation of ITreeContainer.end

Inherited from MapContainer.end

Overrides Container.end
- Defined in base/container/MapContainer.ts:97
inheritdoc

Returns IteratorT

equal_range

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

Implementation of ITreeContainer.equal_range
- Defined in internal/container/associative/MultiTreeMap.ts:78
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(it: IteratorT): IteratorT
erase(begin: IteratorT, end: IteratorT): IteratorT

Implementation of ITreeContainer.erase

Inherited from MapContainer.erase

Overrides Container.erase
- Defined in base/container/MapContainer.ts:177
Erase elements with a specified key.

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

Number of erased elements.
Inherited from MapContainer.erase

Overrides Container.erase
- Defined in base/container/MapContainer.ts:182
inheritdoc

Parameters
- it: IteratorT
Returns IteratorT
Inherited from MapContainer.erase

Overrides Container.erase
- Defined in base/container/MapContainer.ts:187
inheritdoc

Parameters
- begin: IteratorT
- end: IteratorT
Returns IteratorT

find

find(key: Key): IteratorT

Implementation of ITreeContainer.find

Overrides MapContainer.find
- Defined in internal/container/associative/MultiTreeMap.ts:42
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

Implementation of ITreeContainer.has

Inherited from MapContainer.has
- Defined in base/container/MapContainer.ts:108
Test whether a key exists.

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

Whether the specified key exists.

insert

insert(pair: IPair<Key, T>): IteratorT
insert(hint: IteratorT, pair: IPair<Key, T>): IteratorT
insert<InputIterator>(first: InputIterator, last: InputIterator): void

Inherited from MultiMap.insert
- Defined in base/container/MultiMap.ts:57
Insert an element.

Parameters
- pair: IPair<Key, T>
  
  A tuple to be referenced for the insert.
Returns IteratorT

An iterator to the newly inserted element.
Inherited from MultiMap.insert
- Defined in base/container/MultiMap.ts:66
Insert an element with hint.

Parameters
- hint: IteratorT
  
  Hint for the position where the element can be inserted.
- pair: IPair<Key, T>
  
  A tuple to be referenced for the insert.
Returns IteratorT

An iterator to the newly inserted element.
Inherited from MultiMap.insert
- Defined in base/container/MultiMap.ts:74
Insert range elements.

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

Abstract key_comp

key_comp(): Comparator<Key>

Implementation of ITreeContainer.key_comp
- Defined in internal/container/associative/MultiTreeMap.ts:86
Get key comparison function.

Returns Comparator<Key>

The key comparison function.

Abstract lower_bound

lower_bound(key: Key): IteratorT

Implementation of ITreeContainer.lower_bound
- Defined in internal/container/associative/MultiTreeMap.ts:68
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.

merge

merge(source: Source): void

Inherited from MultiMap.merge

Overrides MapContainer.merge
- Defined in base/container/MultiMap.ts:111
inheritdoc

Parameters
- source: Source
Returns void

push

push(...items: IPair<Key, T>[]): number

Inherited from MapContainer.push

Overrides Container.push
- Defined in base/container/MapContainer.ts:138
inheritdoc

Parameters
- Rest ...items: IPair<Key, T>[]
Returns number

rbegin

rbegin(): ReverseT

Implementation of ITreeContainer.rbegin

Inherited from Container.rbegin
- Defined in base/container/Container.ts:80
inheritdoc

Returns ReverseT

rend

rend(): ReverseT

Implementation of ITreeContainer.rend

Inherited from Container.rend
- Defined in base/container/Container.ts:88
inheritdoc

Returns ReverseT

size

size(): number

Implementation of ITreeContainer.size

Inherited from MapContainer.size

Overrides Container.size
- Defined in base/container/MapContainer.ts:121
inheritdoc

Returns number

Abstract swap

swap(obj: Source): void

Inherited from MapContainer.swap

Overrides Container.swap
- Defined in base/container/MapContainer.ts:219
inheritdoc

Parameters
- obj: Source
Returns void

toJSON

toJSON(): Array<Entry<Key, T>>

Implementation of ITreeContainer.toJSON

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

Returns Array<Entry<Key, T>>

An array containing children elements.

Abstract upper_bound

upper_bound(key: Key): IteratorT

Implementation of ITreeContainer.upper_bound
- Defined in internal/container/associative/MultiTreeMap.ts:73
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<IPair<Key, T>>

Implementation of ITreeContainer.value_comp
- Defined in internal/container/associative/MultiTreeMap.ts:91
Get value comparison function.

Returns Comparator<IPair<Key, T>>

The value comparison function.

Type parameters

Key

T

Source: MultiTreeMap<Key, T, Source, IteratorT, ReverseT>

IteratorT: Iterator<Key, T, Source, IteratorT, ReverseT>

ReverseT: ReverseIterator<Key, T, Source, IteratorT, ReverseT>

Hierarchy

Implements

Index

Type aliases

Constructors

Methods

Type aliases

Static Iterator

Type parameters

Key

T

SourceT: MultiMap<Key, T, SourceT, IteratorT, ReverseT>

IteratorT: Iterator<Key, T, SourceT, IteratorT, ReverseT>

ReverseT: ReverseIterator<Key, T, SourceT, IteratorT, ReverseT>

Static ReverseIterator

Type parameters

Key

T

SourceT: MultiMap<Key, T, SourceT, IteratorT, ReverseT>

IteratorT: Iterator<Key, T, SourceT, IteratorT, ReverseT>

ReverseT: ReverseIterator<Key, T, SourceT, IteratorT, ReverseT>

Constructors

Protected constructor

Parameters

factory: (thisArg: Source) => ILinearContainerBase<Entry<Key, T>, Source, IteratorT, ReverseT>

Parameters

thisArg: Source

Returns ILinearContainerBase<Entry<Key, T>, Source, IteratorT, ReverseT>

Returns MultiTreeMap

Methods

[Symbol.iterator]

Returns IterableIterator<Entry<Key, T>>

assign

Type parameters

InputIterator: Readonly<IForwardIterator<IPair<Key, T>, InputIterator>>

Parameters

first: InputIterator

last: InputIterator

Returns void

begin

Returns IteratorT

clear

Returns void

count

Parameters

key: Key

Returns number

emplace

Parameters

key: Key

val: T

Returns IteratorT

emplace_hint

Parameters

hint: IteratorT

key: Key

val: T

Returns IteratorT

empty

Returns boolean

end

Returns IteratorT

equal_range

Parameters

key: Key

Returns Pair<IteratorT, IteratorT>

erase

Parameters

key: Key

Returns number

Parameters

it: IteratorT

Returns IteratorT

Parameters