MultiSet | mutex-server

Basic set container allowing multiple keys.

template: Mapped type
author: Jeongho Nam - https://github.com/samchon

Type parameters

Key

Key type
Source: MultiSet<Key, Source, IteratorT, ReverseT>

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

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

Reverse iterator type

Hierarchy

SetContainer<Key, false, Source, IteratorT, ReverseT>
- MultiSet
  - HashMultiSet
  - MultiTreeSet

Implements

IContainer<Key, Source, IteratorT, ReverseT, Key>
IAssociativeContainer<Key, Key, Source, IteratorT, ReverseT, Key>

Index

Type aliases

Constructors

constructor

Methods

Type aliases

Static InsertRet

InsertRet<Key, Unique, Source, IteratorT, ReverseT>: Unique extends true ? Pair<IteratorT, boolean> : IteratorT

Return type of {@link SetContainer.insert}

Type parameters

Key
Unique: boolean
Source: SetContainer<Key, Unique, Source, IteratorT, ReverseT>
IteratorT: Iterator<Key, Unique, Source, IteratorT, ReverseT>
ReverseT: ReverseIterator<Key, Unique, Source, IteratorT, ReverseT>

Static Iterator

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

Iterator of SetContainer

author: Jenogho Nam http://samchon.org

Type parameters

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

Static ReverseIterator

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

Reverse iterator of SetContainer

author: Jenogho Nam http://samchon.org

Type parameters

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

Constructors

Protected constructor

new MultiSet(factory: (thisArg: Source) => ILinearContainerBase<Key, Source, IteratorT, ReverseT>): MultiSet

Inherited from SetContainer.constructor
- Defined in tstl/src/base/container/SetContainer.ts:37
Default Constructor.

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

Methods

[Symbol.iterator]

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

Implementation of IAssociativeContainer.[Symbol.iterator]

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

Returns IterableIterator<Key>

assign

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

Implementation of IAssociativeContainer.assign

Inherited from SetContainer.assign

Overrides Container.assign
- Defined in tstl/src/base/container/SetContainer.ts:54
Range Assigner.

Type parameters
- InputIterator: Readonly<IForwardIterator<Key, 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

Inherited from SetContainer.begin

Overrides Container.begin
- Defined in tstl/src/base/container/SetContainer.ts:86
inheritdoc

Returns IteratorT

clear

clear(): void

Implementation of IAssociativeContainer.clear

Inherited from SetContainer.clear

Overrides Container.clear
- Defined in tstl/src/base/container/SetContainer.ts:65
inheritdoc

Returns void

Abstract count

count(key: Key): number

Implementation of IAssociativeContainer.count

Inherited from SetContainer.count
- Defined in tstl/src/base/container/SetContainer.ts:113
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 tstl/src/base/container/Container.ts:59
inheritdoc

Returns boolean

end

end(): IteratorT

Implementation of IAssociativeContainer.end

Inherited from SetContainer.end

Overrides Container.end
- Defined in tstl/src/base/container/SetContainer.ts:94
inheritdoc

Returns IteratorT

erase

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

Implementation of IAssociativeContainer.erase

Inherited from SetContainer.erase

Overrides Container.erase
- Defined in tstl/src/base/container/SetContainer.ts:176
Erase elements with a specified key.

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

Number of erased elements.
Inherited from SetContainer.erase

Overrides Container.erase
- Defined in tstl/src/base/container/SetContainer.ts:181
inheritdoc

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

Overrides Container.erase
- Defined in tstl/src/base/container/SetContainer.ts:186
inheritdoc

Parameters
- first: IteratorT
- last: IteratorT
Returns IteratorT

Abstract find

find(key: Key): IteratorT

Implementation of IAssociativeContainer.find

Inherited from SetContainer.find
- Defined in tstl/src/base/container/SetContainer.ts:81
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

Inherited from SetContainer.has
- Defined in tstl/src/base/container/SetContainer.ts:105
Test whether a key exists.

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

Whether the specified key exists.

insert

insert(key: Key): IteratorT
insert(hint: IteratorT, key: Key): IteratorT
insert<InputIterator>(begin: InputIterator, end: InputIterator): void

- Defined in tstl/src/base/container/MultiSet.ts:37
Insert an element.

Parameters
- key: Key
Returns IteratorT

An iterator to the newly inserted element.
- Defined in tstl/src/base/container/MultiSet.ts:46
Insert an element with hint.

Parameters
- hint: IteratorT
  
  Hint for the position where the element can be inserted.
- key: Key
Returns IteratorT

An iterator to the newly inserted element.
- Defined in tstl/src/base/container/MultiSet.ts:54
Insert range elements.

Type parameters
- InputIterator: Readonly<IForwardIterator<Key, InputIterator>>
Parameters
- begin: InputIterator
- end: InputIterator
Returns void

merge

merge(source: Source): void

Overrides SetContainer.merge
- Defined in tstl/src/base/container/MultiSet.ts:91
inheritdoc

Parameters
- source: Source
Returns void

push

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

Implementation of IAssociativeContainer.push

Inherited from SetContainer.push

Overrides Container.push
- Defined in tstl/src/base/container/SetContainer.ts:135
Insert items at the end.

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

Number of elements in the container after insertion.

rbegin

rbegin(): ReverseT

Implementation of IAssociativeContainer.rbegin

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

Returns ReverseT

rend

rend(): ReverseT

Implementation of IAssociativeContainer.rend

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

Returns ReverseT

size

size(): number

Implementation of IAssociativeContainer.size

Inherited from SetContainer.size

Overrides Container.size
- Defined in tstl/src/base/container/SetContainer.ts:118
inheritdoc

Returns number

Abstract swap

swap(obj: Source): void

Inherited from SetContainer.swap

Overrides Container.swap
- Defined in tstl/src/base/container/SetContainer.ts:217
inheritdoc

Parameters
- obj: Source
Returns void

toJSON

toJSON(): Array<Key>

Implementation of IAssociativeContainer.toJSON

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

Returns Array<Key>

An array containing children elements.

Type parameters

Key

Source: MultiSet<Key, Source, IteratorT, ReverseT>

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

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

Hierarchy

Implements

Index

Type aliases

Constructors

Methods

Type aliases

Static InsertRet

Type parameters

Key

Unique: boolean

Source: SetContainer<Key, Unique, Source, IteratorT, ReverseT>

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

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

Static Iterator

Type parameters

Key

Unique: boolean

SourceT: SetContainer<Key, Unique, SourceT, IteratorT, ReverseT>

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

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

Static ReverseIterator

Type parameters

Key

Unique: boolean

SourceT: SetContainer<Key, Unique, SourceT, IteratorT, ReverseT>

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

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

Constructors

Protected constructor

Parameters

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

Parameters

thisArg: Source

Returns ILinearContainerBase<Key, Source, IteratorT, ReverseT>

Returns MultiSet

Methods

[Symbol.iterator]

Returns IterableIterator<Key>

assign

Type parameters

InputIterator: Readonly<IForwardIterator<Key, 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

pos: IteratorT

Returns IteratorT

Parameters

first: IteratorT

last: IteratorT

Returns IteratorT

Abstract find

Parameters

key: Key

Returns IteratorT

has

Parameters