ITreeMap | tstl

Common interface for tree maps.

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: ITreeMap<Key, T, Unique, Source, IteratorT, ReverseT>

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

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

Reverse iterator type

Hierarchy

MapContainer<Key, T, Unique, Source, IteratorT, ReverseT>
ITreeContainer<Key, Entry<Key, T>, Source, IteratorT, ReverseT, IPair<Key, T>>
- 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

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>

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>

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 ITreeMap(factory: (thisArg: Source) => ILinearContainerBase<Entry<Key, T>, Source, IteratorT, ReverseT>): ITreeMap

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 ITreeMap

Methods

[Symbol.iterator]

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

Inherited from Container.[Symbol.iterator]

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

Returns IterableIterator<Entry<Key, T>>

assign

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

Inherited from MapContainer.assign

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

Type parameters
- InputIterator: Readonly<IForwardIterator<IPair<Key, T>, InputIterator>>
Parameters
- first: InputIterator
- last: InputIterator
Returns void

begin

begin(): IteratorT

Inherited from MapContainer.begin

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

Returns IteratorT

clear

clear(): void

Inherited from MapContainer.clear

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

Returns void

Abstract count

count(key: Key): number

Inherited from MapContainer.count

Overrides IAssociativeContainer.count
- Defined in base/container/MapContainer.ts:116
inheritdoc

Parameters
- key: Key
Returns number

empty

empty(): boolean

Inherited from Container.empty

Overrides IContainer.empty
- Defined in base/container/Container.ts:59
inheritdoc

Returns boolean

end

end(): IteratorT

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>

Inherited from ITreeContainer.equal_range
- 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(it: IteratorT): IteratorT
erase(begin: IteratorT, end: IteratorT): IteratorT

Inherited from MapContainer.erase

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

Parameters
- key: Key
Returns number
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

Abstract find

find(key: Key): IteratorT

Inherited from MapContainer.find

Overrides IAssociativeContainer.find
- Defined in base/container/MapContainer.ts:84
inheritdoc

Parameters
- key: Key
Returns IteratorT

has

has(key: Key): boolean

Inherited from MapContainer.has

Overrides IAssociativeContainer.has
- Defined in base/container/MapContainer.ts:108
inheritdoc

Parameters
- key: Key
Returns boolean

key_comp

key_comp(): Comparator<Key>

Inherited from ITreeContainer.key_comp
- 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

Inherited from ITreeContainer.lower_bound
- 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.

Abstract merge

merge(source: Source): void

Inherited from MapContainer.merge
- 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

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

Inherited from Container.rbegin

Overrides IContainer.rbegin
- Defined in base/container/Container.ts:80
inheritdoc

Returns ReverseT

rend

rend(): ReverseT

Inherited from Container.rend

Overrides IContainer.rend
- Defined in base/container/Container.ts:88
inheritdoc

Returns ReverseT

size

size(): number

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

Inherited from Container.toJSON

Overrides IContainer.toJSON
- Defined in base/container/Container.ts:130
inheritdoc

Returns Array<Entry<Key, T>>

upper_bound

upper_bound(key: Key): IteratorT

Inherited from ITreeContainer.upper_bound
- 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<IPair<Key, T>>

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

Returns Comparator<IPair<Key, T>>

The value comparison function.

Type parameters

Key

T

Unique: boolean

Source: ITreeMap<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

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>

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>

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 ITreeMap

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

equal_range

Parameters

key: Key

Returns Pair<IteratorT, IteratorT>

erase

Parameters

key: Key

Returns number

Parameters

it: IteratorT

Returns IteratorT

Parameters