HashSet | tstl

Unique-key Set based on Hash buckets.

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

Type parameters

Hierarchy

UniqueSet<Key, HashSet<Key>, Iterator<Key>, ReverseIterator<Key>>
- HashSet

Implements

IContainer<Key, HashSet<Key>, Iterator<Key>, ReverseIterator<Key>, Key>
IAssociativeContainer<Key, Key, HashSet<Key>, Iterator<Key>, ReverseIterator<Key>, Key>
IHashSet<Key, true, HashSet<Key>>

Index

Type aliases

Constructors

constructor

Methods

Type aliases

Static Iterator

Iterator<Key, SourceT, IteratorT, ReverseT, Key>: Iterator<Key, true, HashSet<Key>>

Iterator of UniqueSet Iterator of HashSet

author: Jenogho Nam http://samchon.org

Type parameters

Key
SourceT: UniqueSet<Key, SourceT, IteratorT, ReverseT>
IteratorT: Iterator<Key, SourceT, IteratorT, ReverseT>
ReverseT: ReverseIterator<Key, SourceT, IteratorT, ReverseT>
Key

Static ReverseIterator

ReverseIterator<Key, SourceT, IteratorT, ReverseT, Key>: ReverseIterator<Key, true, HashSet<Key>>

Reverse iterator of UniqueSet Reverse iterator of HashSet

author: Jenogho Nam http://samchon.org

Type parameters

Key
SourceT: UniqueSet<Key, SourceT, IteratorT, ReverseT>
IteratorT: Iterator<Key, SourceT, IteratorT, ReverseT>
ReverseT: ReverseIterator<Key, SourceT, IteratorT, ReverseT>
Key

Constructors

constructor

new HashSet(hash?: Hasher<Key>, equal?: BinaryPredicator<Key>): HashSet
new HashSet(items: Key[], hash?: Hasher<Key>, equal?: BinaryPredicator<Key>): HashSet
new HashSet(obj: HashSet<Key>): HashSet
new HashSet(first: Readonly<IForwardIterator<Key>>, last: Readonly<IForwardIterator<Key>>, hash?: Hasher<Key>, equal?: BinaryPredicator<Key>): HashSet

Overrides SetContainer.constructor
- Defined in container/HashSet.ts:33
Default Constructor.

Parameters
- Optional hash: Hasher<Key>
  
  An unary function returns hash code. Default is {hash}.
- Optional equal: BinaryPredicator<Key>
  
  A binary function predicates two arguments are equal. Default is equal_to.
Returns HashSet
Overrides SetContainer.constructor
- Defined in container/HashSet.ts:48
Initializer Constructor.

Parameters
- items: Key[]
  
  Items to assign.
- Optional hash: Hasher<Key>
  
  An unary function returns hash code. Default is {hash}.
- Optional equal: BinaryPredicator<Key>
  
  A binary function predicates two arguments are equal. Default is equal_to.
Returns HashSet
Overrides SetContainer.constructor
- Defined in container/HashSet.ts:57
Copy Constructor.

Parameters
- obj: HashSet<Key>
  
  Object to copy.
Returns HashSet
Overrides SetContainer.constructor
- Defined in container/HashSet.ts:64
Range Constructor.

Parameters
- first: Readonly<IForwardIterator<Key>>
  
  Input iterator of the first position.
- last: Readonly<IForwardIterator<Key>>
  
  Input iterator of the last position.
- Optional hash: Hasher<Key>
  
  An unary function returns hash code. Default is {hash}.
- Optional equal: BinaryPredicator<Key>
  
  A binary function predicates two arguments are equal. Default is equal_to.
Returns HashSet

Methods

[Symbol.iterator]

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

Implementation of IHashSet.[Symbol.iterator]

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

Returns IterableIterator<Key>

assign

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

Implementation of IHashSet.assign

Inherited from SetContainer.assign

Overrides Container.assign
- Defined in 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(): Iterator<Key>
begin(index: number): Iterator<Key>

Implementation of IHashSet.begin

Overrides SetContainer.begin
- Defined in container/HashSet.ts:145
inheritdoc

Returns Iterator<Key>
Implementation of IHashSet.begin

Overrides SetContainer.begin
- Defined in container/HashSet.ts:149
Iterator to the first element in a specific bucket.

Parameters
- index: number
  
  Index number of the specific bucket.
Returns Iterator<Key>

Iterator from the specific bucket.

bucket

bucket(key: Key): number

Implementation of IHashSet.bucket
- Defined in container/HashSet.ts:249
Compute bucket index for the key.

Parameters
- key: Key
  
  Target key.
Returns number

Index number.

bucket_count

bucket_count(): number

Implementation of IHashSet.bucket_count
- Defined in container/HashSet.ts:209
Get number of buckets.

Returns number

bucket_size

bucket_size(n: number): number

Implementation of IHashSet.bucket_size
- Defined in container/HashSet.ts:217
Get size of a specific bucket.

Parameters
- n: number
  
  Specific position.
Returns number

Size of the specific bucket.

clear

clear(): void

Implementation of IHashSet.clear

Overrides SetContainer.clear
- Defined in container/HashSet.ts:106
inheritdoc

Returns void

count

count(key: Key): number

Implementation of IHashSet.count

Inherited from UniqueSet.count

Overrides SetContainer.count
- Defined in base/container/UniqueSet.ts:35
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 IHashSet.empty

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

Returns boolean

end

end(): Iterator<Key>
end(index: number): Iterator<Key>

Implementation of IHashSet.end

Overrides SetContainer.end
- Defined in container/HashSet.ts:161
inheritdoc

Returns Iterator<Key>
Implementation of IHashSet.end

Overrides SetContainer.end
- Defined in container/HashSet.ts:165
Iterator to the end in a specific bucket.

Parameters
- index: number
  
  Index number of the specific bucket.
Returns Iterator<Key>

Iterator from the specific bucket.

erase

erase(key: Key): number
erase(pos: Iterator<Key>): Iterator<Key>
erase(first: Iterator<Key>, last: Iterator<Key>): Iterator<Key>

Implementation of IHashSet.erase

Inherited from SetContainer.erase

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

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

Number of erased elements.
Implementation of IHashSet.erase

Inherited from SetContainer.erase

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

Parameters
- pos: Iterator<Key>
Returns Iterator<Key>
Implementation of IHashSet.erase

Inherited from SetContainer.erase

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

Parameters
- first: Iterator<Key>
- last: Iterator<Key>
Returns Iterator<Key>

extract

extract(key: Key): Key
extract(it: Iterator<Key>): Iterator<Key>

Inherited from UniqueSet.extract
- Defined in base/container/UniqueSet.ts:90
Extract an element by key.

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

The extracted element.
Inherited from UniqueSet.extract
- Defined in base/container/UniqueSet.ts:98
Extract an element by iterator.

Parameters
- it: Iterator<Key>
Returns Iterator<Key>

Iterator following the pos, strained by the extraction.

find

find(key: Key): Iterator<Key>

Implementation of IHashSet.find

Overrides SetContainer.find
- Defined in container/HashSet.ts:137
Get iterator to element.

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

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

has

has(key: Key): boolean

Implementation of IHashSet.has

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

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

Whether the specified key exists.

hash_function

hash_function(): Hasher<Key>

Implementation of IHashSet.hash_function
- Defined in container/HashSet.ts:233
Get hash function.

Returns Hasher<Key>

The hash function.

insert

insert(key: Key): Pair<Iterator<Key>, boolean>
insert(hint: Iterator<Key>, key: Key): Iterator<Key>
insert<InputIterator>(first: InputIterator, last: InputIterator): void

Inherited from UniqueSet.insert
- Defined in base/container/UniqueSet.ts:49
Insert an element.

Parameters
- key: Key
  
  Key to insert.
Returns Pair<Iterator<Key>, boolean>

Pair of an iterator to the newly inserted element and true, if the specified key doesn't exist, otherwise Pair of iterator to ordinary element and false.
Inherited from UniqueSet.insert
- Defined in base/container/UniqueSet.ts:58
Insert an element with hint.

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

An iterator to the newly inserted element, if the specified key doesn't exist, otherwise an iterator to the ordinary element.
Inherited from UniqueSet.insert
- Defined in base/container/UniqueSet.ts:66
Insert range elements.

Type parameters
- InputIterator: Readonly<IForwardIterator<Key, InputIterator>>
Parameters
- first: InputIterator
  
  Input iterator of the first position.
- last: InputIterator
  
  Input iteartor of the last position.
Returns void

key_eq

key_eq(): BinaryPredicator<Key>

Implementation of IHashSet.key_eq
- Defined in container/HashSet.ts:241
Get key equality predicator.

Returns BinaryPredicator<Key>

The key equality predicator.

load_factor

load_factor(): number

Implementation of IHashSet.load_factor
- Defined in container/HashSet.ts:225
Compute load factor.

Returns number

this.size() / this.bucket_count()

max_load_factor

max_load_factor(): number
max_load_factor(z: number): void

Implementation of IHashSet.max_load_factor
- Defined in container/HashSet.ts:257
Get maximum load factor that allowable.

Returns number

The maximum load factor.
Implementation of IHashSet.max_load_factor
- Defined in container/HashSet.ts:261
Set maximum load factor.

Parameters
- z: number
  
  The new value to change.
Returns void

merge

merge(source: HashSet<Key>): void

Inherited from UniqueSet.merge

Overrides SetContainer.merge
- Defined in base/container/UniqueSet.ts:143
inheritdoc

Parameters
- source: HashSet<Key>
Returns void

push

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

Implementation of IHashSet.push

Inherited from SetContainer.push

Overrides Container.push
- Defined in 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(): ReverseIterator<Key>
rbegin(index: number): ReverseIterator<Key>

Implementation of IHashSet.rbegin

Overrides Container.rbegin
- Defined in container/HashSet.ts:180
inheritdoc

Returns ReverseIterator<Key>
Overrides Container.rbegin
- Defined in container/HashSet.ts:184
inheritdoc

Parameters
- index: number
Returns ReverseIterator<Key>

rehash

rehash(n: number): void

Implementation of IHashSet.rehash
- Defined in container/HashSet.ts:278
Change of bucktes.

Parameters
- n: number
  
  The number to change.
Returns void

rend

rend(): ReverseIterator<Key>
rend(index: number): ReverseIterator<Key>

Implementation of IHashSet.rend

Overrides Container.rend
- Defined in container/HashSet.ts:193
inheritdoc

Returns ReverseIterator<Key>
Overrides Container.rend
- Defined in container/HashSet.ts:197
inheritdoc

Parameters
- index: number
Returns ReverseIterator<Key>

reserve

reserve(n: number): void

Implementation of IHashSet.reserve
- Defined in container/HashSet.ts:270
Reserve buckets enable to store n elements.

Parameters
- n: number
  
  The capacity to reserve.
Returns void

size

size(): number

Implementation of IHashSet.size

Inherited from SetContainer.size

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

Returns number

swap

swap(obj: HashSet<Key>): void

Overrides SetContainer.swap
- Defined in container/HashSet.ts:116
inheritdoc

Parameters
- obj: HashSet<Key>
Returns void

toJSON

toJSON(): Array<Key>

Implementation of IHashSet.toJSON

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

Returns Array<Key>

An array containing children elements.

Type parameters

Key

Hierarchy

Implements

Index

Type aliases

Constructors

Methods

Type aliases

Static Iterator

Type parameters

Key

SourceT: UniqueSet<Key, SourceT, IteratorT, ReverseT>

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

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

Key

Static ReverseIterator

Type parameters

Key

SourceT: UniqueSet<Key, SourceT, IteratorT, ReverseT>

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

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

Key

Constructors

constructor

Parameters

Optional hash: Hasher<Key>

Optional equal: BinaryPredicator<Key>

Returns HashSet

Parameters

items: Key[]

Optional hash: Hasher<Key>

Optional equal: BinaryPredicator<Key>

Returns HashSet

Parameters

obj: HashSet<Key>

Returns HashSet

Parameters

first: Readonly<IForwardIterator<Key>>

last: Readonly<IForwardIterator<Key>>

Optional hash: Hasher<Key>

Optional equal: BinaryPredicator<Key>

Returns HashSet

Methods

[Symbol.iterator]

Returns IterableIterator<Key>

assign

Type parameters

InputIterator: Readonly<IForwardIterator<Key, InputIterator>>

Parameters

first: InputIterator

last: InputIterator

Returns void

begin

Returns Iterator<Key>

Parameters

index: number

Returns Iterator<Key>

bucket

Parameters

key: Key

Returns number

bucket_count

Returns number

bucket_size

Parameters

n: number

Returns number

clear

Returns void

count

Parameters

key: Key

Returns number

empty

Returns boolean

end

Returns Iterator<Key>

Parameters

index: number