MultiMap | tstl

Basic map container allowing duplicated keys.

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

Type parameters

Key

Key type
T

Mapped type
Source: MultiMap<Key, T, Source, Iterator, Reverse>

Derived type extending this MultiMap
Iterator: Iterator<Key, T, Source, Iterator, Reverse>
Reverse: ReverseIterator<Key, T, Source, Iterator, Reverse>

Hierarchy

MapContainer<Key, T, false, Source, Iterator, Reverse>
- MultiMap
  - HashMultiMap
  - MultiTreeMap

Implements

IContainer<Entry<Key, T>, Source, Iterator, Reverse, IPair<Key, T>>
IAssociativeContainer<Key, Entry<Key, T>, Source, Iterator, Reverse, IPair<Key, T>>

Index

Type aliases

Constructors

constructor

Methods

Type aliases

Static InsertRet

InsertRet<Key, T, Unique, SourceT, IteratorT, Reverse>: Unique extends true ? Pair<IteratorT, boolean> : IteratorT

Return type of {@link MapContainer.insert}

Type parameters

Key
T
Unique: boolean
SourceT: MapContainer<Key, T, Unique, SourceT, IteratorT, Reverse>
IteratorT: Iterator<Key, T, Unique, SourceT, IteratorT, Reverse>

Iterator type
Reverse: ReverseIterator<Key, T, Unique, SourceT, IteratorT, Reverse>

Static Iterator

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

Iterator of MapContainer Iterator of MultiMap

author: Jenogho Nam http://samchon.org
author: Jenogho Nam http://samchon.org

Type parameters

Key
T
Unique: boolean
SourceT: MapContainer<Key, T, Unique, SourceT, IteratorT, ReverseT>
IteratorT: Iterator<Key, T, Unique, SourceT, IteratorT, ReverseT>
ReverseT: ReverseIterator<Key, T, Unique, SourceT, IteratorT, ReverseT>

Reverse iterator type
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, Unique, SourceT, IteratorT, ReverseT, Key, T, SourceT, IteratorT, ReverseT>: ReverseIterator<Key, T, false, SourceT, IteratorT, ReverseT>

Reverse iterator of MapContainer Reverse iterator of MultiMap

author: Jenogho Nam http://samchon.org
author: Jenogho Nam http://samchon.org

Type parameters

Key
T
Unique: boolean
SourceT: MapContainer<Key, T, Unique, SourceT, IteratorT, ReverseT>
IteratorT: Iterator<Key, T, Unique, SourceT, IteratorT, ReverseT>
ReverseT: ReverseIterator<Key, T, Unique, SourceT, IteratorT, ReverseT>
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 MultiMap(factory: (thisArg: Source) => ILinearContainerBase<Entry<Key, T>, Source, Iterator, Reverse>): MultiMap

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

Parameters
- factory: (thisArg: Source) => ILinearContainerBase<Entry<Key, T>, Source, Iterator, Reverse>
  - - (thisArg: Source): ILinearContainerBase<Entry<Key, T>, Source, Iterator, Reverse>
    - Parameters
      - thisArg: Source
      Returns ILinearContainerBase<Entry<Key, T>, Source, Iterator, Reverse>
Returns MultiMap

Methods

[Symbol.iterator]

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

Implementation of IAssociativeContainer.[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 IAssociativeContainer.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(): Iterator

Implementation of IAssociativeContainer.begin

Inherited from MapContainer.begin

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

Returns Iterator

clear

clear(): void

Implementation of IAssociativeContainer.clear

Inherited from MapContainer.clear

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

Returns void

Abstract count

count(key: Key): number

Implementation of IAssociativeContainer.count

Inherited from MapContainer.count
- Defined in base/container/MapContainer.ts:116
Count elements with a specified key.

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

Number of elements with the specified key.

Abstract emplace

emplace(key: Key, value: T): Iterator

- Defined in base/container/MultiMap.ts:39
Construct and insert an element.

Parameters
- key: Key
  
  Key to be mapped.
- value: T
  
  Value to emplace.
Returns Iterator

An iterator to the newly inserted element.

Abstract emplace_hint

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

- Defined in base/container/MultiMap.ts:49
Construct and insert element with hint.

Parameters
- hint: Iterator
  
  Hint for the position where the element can be inserted.
- key: Key
  
  Key of the new element.
- val: T
  
  Value of the new element.
Returns Iterator

An iterator to the newly inserted element.

empty

empty(): boolean

Implementation of IAssociativeContainer.empty

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

Returns boolean

end

end(): Iterator

Implementation of IAssociativeContainer.end

Inherited from MapContainer.end

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

Returns Iterator

erase

erase(key: Key): number
erase(it: Iterator): Iterator
erase(begin: Iterator, end: Iterator): Iterator

Implementation of IAssociativeContainer.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: Iterator
Returns Iterator
Inherited from MapContainer.erase

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

Parameters
- begin: Iterator
- end: Iterator
Returns Iterator

Abstract find

find(key: Key): Iterator

Implementation of IAssociativeContainer.find

Inherited from MapContainer.find
- Defined in base/container/MapContainer.ts:84
Get iterator to element.

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

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

has

has(key: Key): boolean

Implementation of IAssociativeContainer.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>): Iterator
insert(hint: Iterator, pair: IPair<Key, T>): Iterator
insert<InputIterator>(first: InputIterator, last: InputIterator): void

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

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

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

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

An iterator to the newly inserted element.
- 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

merge

merge(source: Source): void

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(): Reverse

Implementation of IAssociativeContainer.rbegin

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

Returns Reverse

rend

rend(): Reverse

Implementation of IAssociativeContainer.rend

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

Returns Reverse

size

size(): number

Implementation of IAssociativeContainer.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 IAssociativeContainer.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.

Type parameters

Key

T

Source: MultiMap<Key, T, Source, Iterator, Reverse>

Iterator: Iterator<Key, T, Source, Iterator, Reverse>

Reverse: ReverseIterator<Key, T, Source, Iterator, Reverse>

Hierarchy

Implements

Index

Type aliases

Constructors

Methods

Type aliases

Static InsertRet

Type parameters

Key

T

Unique: boolean

SourceT: MapContainer<Key, T, Unique, SourceT, IteratorT, Reverse>

IteratorT: Iterator<Key, T, Unique, SourceT, IteratorT, Reverse>

Reverse: ReverseIterator<Key, T, Unique, SourceT, IteratorT, Reverse>

Static Iterator

Type parameters

Key

T

Unique: boolean

SourceT: MapContainer<Key, T, Unique, SourceT, IteratorT, ReverseT>

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

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

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

Unique: boolean

SourceT: MapContainer<Key, T, Unique, SourceT, IteratorT, ReverseT>

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

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

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, Iterator, Reverse>

Parameters

thisArg: Source

Returns ILinearContainerBase<Entry<Key, T>, Source, Iterator, Reverse>

Returns MultiMap

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 Iterator

clear

Returns void

Abstract count

Parameters

key: Key

Returns number

Abstract emplace

Parameters

key: Key

value: T

Returns Iterator

Abstract emplace_hint

Parameters