SetContainer | mutex-server

Basic set container.

template: Derived type extending this SetContainer
author: Jeongho Nam - https://github.com/samchon

Type parameters

Key

Key type
Unique: boolean

Whether duplicated key is blocked or not
SourceT: SetContainer<Key, Unique, SourceT, IteratorT, ReverseT>
IteratorT: SetContainer.Iterator<Key, Unique, SourceT, IteratorT, ReverseT>

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

Reverse iterator type

Hierarchy

Container<Key, SourceT, IteratorT, ReverseT, Key>
- SetContainer
  - IHashSet
  - UniqueSet
  - MultiSet
  - ITreeSet

Implements

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

Index

Constructors

constructor

Methods

Constructors

Protected constructor

new SetContainer(factory: (thisArg: SourceT) => ILinearContainerBase<Key, SourceT, IteratorT, ReverseT>): SetContainer

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

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

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

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

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

Returns IteratorT

clear

clear(): void

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

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

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.
Overrides Container.erase
- Defined in tstl/src/base/container/SetContainer.ts:181
inheritdoc

Parameters
- pos: IteratorT
Returns IteratorT
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
- 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
- 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.

Abstract merge

merge(source: SourceT): void

- Defined in tstl/src/base/container/SetContainer.ts:222
inheritdoc

Parameters
- source: SourceT
Returns void

push

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

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

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

Returns number

Abstract swap

swap(obj: SourceT): void

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

Parameters
- obj: SourceT
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

Unique: boolean

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

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

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

Hierarchy

Implements

Index

Constructors

Methods

Constructors

Protected constructor

Parameters

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

Parameters

thisArg: SourceT

Returns ILinearContainerBase<Key, SourceT, IteratorT, ReverseT>

Returns SetContainer

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

key: Key

Returns boolean

Abstract merge

Parameters

source: SourceT

Returns void

push

Parameters

Rest ...items: Key[]

Returns number

rbegin

Returns ReverseT

rend

Returns ReverseT

size

Returns number

Abstract swap

Parameters

obj: SourceT

Returns void

toJSON

Returns Array<Key>