MapContainer

Basic map container.

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

Type parameters

Key

Key type
T

Mapped type
Unique: boolean

Whether duplicated key is blocked or not
Source: MapContainer<Key, T, Unique, Source, IteratorT, ReverseT>

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

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

Reverse iterator type

Hierarchy

Container<Entry<Key, T>, Source, IteratorT, ReverseT, IPair<Key, T>>
- MapContainer
  - IHashMap
  - UniqueMap
  - MultiMap
  - ITreeMap

Implements

IContainer<Entry<Key, T>, Source, IteratorT, ReverseT, IPair<Key, T>>
IAssociativeContainer<Key, Entry<Key, T>, Source, IteratorT, ReverseT, 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>
Reverse: ReverseIterator<Key, T, Unique, SourceT, IteratorT, Reverse>

Static Iterator

Iterator<Key, T, Unique, SourceT, IteratorT, ReverseT>: IteratorBase<Key, T> & Readonly<Iterator<Entry<Key, T>, SourceT, IteratorT, ReverseT, IPair<Key, T>>>

Iterator of MapContainer

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>

Static ReverseIterator

ReverseIterator<Key, T, Unique, SourceT, IteratorT, ReverseT>: IteratorBase<Key, T> & Readonly<ReverseIterator<Entry<Key, T>, SourceT, IteratorT, ReverseT, IPair<Key, T>>>

Reverse iterator of MapContainer

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>

Constructors

Protected constructor

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

- 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 MapContainer

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

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 IAssociativeContainer.begin

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

Returns IteratorT

clear

clear(): void

Implementation of IAssociativeContainer.clear

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

Returns void

Abstract count

count(key: Key): number

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

empty

empty(): boolean

Implementation of IAssociativeContainer.empty

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

Returns boolean

end

end(): IteratorT

Implementation of IAssociativeContainer.end

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

Returns IteratorT

erase

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

Implementation of IAssociativeContainer.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.
Overrides Container.erase
- Defined in base/container/MapContainer.ts:182
inheritdoc

Parameters
- it: IteratorT
Returns IteratorT
Overrides Container.erase
- Defined in base/container/MapContainer.ts:187
inheritdoc

Parameters
- begin: IteratorT
- end: IteratorT
Returns IteratorT

Abstract find

find(key: Key): IteratorT

Implementation of IAssociativeContainer.find
- Defined in base/container/MapContainer.ts:84
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 IAssociativeContainer.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.

Abstract merge

merge(source: Source): void

- Defined in base/container/MapContainer.ts:226
Merge two containers.

Parameters
- source: Source
  
  Source container to transfer.
Returns void

push

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

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

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

rbegin

rbegin(): ReverseT

Implementation of IAssociativeContainer.rbegin

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

Returns ReverseT

rend

rend(): ReverseT

Implementation of IAssociativeContainer.rend

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

Returns ReverseT

size

size(): number

Implementation of IAssociativeContainer.size

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

Returns number

Abstract swap

swap(obj: Source): void

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

Unique: boolean

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

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

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

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>

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>

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 MapContainer

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

Abstract count

Parameters

key: Key

Returns number

empty

Returns boolean

end

Returns IteratorT

erase

Parameters

key: Key

Returns number

Parameters

it: IteratorT

Returns IteratorT

Parameters

begin: IteratorT

end: IteratorT

Returns IteratorT

Abstract find