Interface IHashContainer<Key, T, SourceT, IteratorT, ReverseIteratorT, Elem>

Common interface for hash containers

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

Type parameters

Key
T: Elem
SourceT: IHashContainer<Key, T, SourceT, IteratorT, ReverseIteratorT, Elem>
IteratorT: Iterator<T, SourceT, IteratorT, ReverseIteratorT, Elem>
ReverseIteratorT: ReverseIterator<T, SourceT, IteratorT, ReverseIteratorT, Elem>
Elem

Hierarchy

IAssociativeContainer<Key, T, SourceT, IteratorT, ReverseIteratorT, Elem>
- IHashContainer
  - IHashMap
  - IHashSet

Index

Methods

Methods

[Symbol.iterator]

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

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

Returns IterableIterator<T>

assign

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

Inherited from IContainer.assign
- Defined in tstl/src/base/container/IContainer.ts:44
Range Assigner.

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

begin

begin(): IteratorT

Inherited from IContainer.begin

Overrides IForwardContainer.begin
- Defined in tstl/src/base/container/IContainer.ts:75
inheritdoc

Returns IteratorT

bucket

bucket(key: Key): number

- Defined in tstl/src/internal/container/associative/IHashContainer.ts:54
Compute bucket index for the key.

Parameters
- key: Key
  
  Target key.
Returns number

Index number.

bucket_count

bucket_count(): number

- Defined in tstl/src/internal/container/associative/IHashContainer.ts:59
Get number of buckets.

Returns number

bucket_size

bucket_size(index: number): number

- Defined in tstl/src/internal/container/associative/IHashContainer.ts:67
Get size of a specific bucket.

Parameters
- index: number
  
  Specific position.
Returns number

Size of the specific bucket.

clear

clear(): void

Inherited from IContainer.clear
- Defined in tstl/src/base/container/IContainer.ts:50
inheritdoc

Returns void

count

count(key: Key): number

Inherited from IAssociativeContainer.count
- Defined in tstl/src/internal/container/associative/IAssociativeContainer.ts:43
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

Inherited from IContainer.empty

Overrides IEmpty.empty
- Defined in tstl/src/base/container/IContainer.ts:67
inheritdoc

Returns boolean

end

end(): IteratorT

Inherited from IContainer.end

Overrides IForwardContainer.end
- Defined in tstl/src/base/container/IContainer.ts:80
inheritdoc

Returns IteratorT

erase

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

Inherited from IAssociativeContainer.erase

Overrides IContainer.erase
- Defined in tstl/src/internal/container/associative/IAssociativeContainer.ts:51
Erase elements with a specified key.

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

Number of erased elements.
Inherited from IAssociativeContainer.erase

Overrides IContainer.erase
- Defined in tstl/src/internal/container/associative/IAssociativeContainer.ts:56
inheritdoc

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

Overrides IContainer.erase
- Defined in tstl/src/internal/container/associative/IAssociativeContainer.ts:61
inheritdoc

Parameters
- first: IteratorT
- last: IteratorT
Returns IteratorT

find

find(key: Key): IteratorT

Inherited from IAssociativeContainer.find
- Defined in tstl/src/internal/container/associative/IAssociativeContainer.ts:27
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

Inherited from IAssociativeContainer.has
- Defined in tstl/src/internal/container/associative/IAssociativeContainer.ts:35
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>

- Defined in tstl/src/internal/container/associative/IHashContainer.ts:36
Get hash function.

Returns Hasher<Key>

The hash function.

key_eq

key_eq(): BinaryPredicator<Key>

- Defined in tstl/src/internal/container/associative/IHashContainer.ts:43
Get key equality predicator.

Returns BinaryPredicator<Key>

The key equality predicator.

load_factor

load_factor(): number

- Defined in tstl/src/internal/container/associative/IHashContainer.ts:74
Compute load factor.

Returns number

this.size() / this.bucket_count()

max_load_factor

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

- Defined in tstl/src/internal/container/associative/IHashContainer.ts:81
Get maximum load factor that allowable.

Returns number

The maximum load factor.
- Defined in tstl/src/internal/container/associative/IHashContainer.ts:91
Set maximum load factor.

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

push

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

Inherited from IContainer.push
- Defined in tstl/src/internal/container/partial/IPush.ts:15
Insert items at the end.

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

Number of elements in the container after insertion.

rbegin

rbegin(): ReverseIteratorT

Inherited from IContainer.rbegin

Overrides IBidirectionalContainer.rbegin
- Defined in tstl/src/base/container/IContainer.ts:85
inheritdoc

Returns ReverseIteratorT

rehash

rehash(n: number): void

- Defined in tstl/src/internal/container/associative/IHashContainer.ts:105
Change of bucktes.

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

rend

rend(): ReverseIteratorT

Inherited from IContainer.rend

Overrides IBidirectionalContainer.rend
- Defined in tstl/src/base/container/IContainer.ts:90
inheritdoc

Returns ReverseIteratorT

reserve

reserve(n: number): void

- Defined in tstl/src/internal/container/associative/IHashContainer.ts:98
Reserve buckets enable to store n elements.

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

size

size(): number

Inherited from IContainer.size

Overrides IForwardContainer.size
- Defined in tstl/src/base/container/IContainer.ts:62
inheritdoc

Returns number

swap

swap(obj: SourceT): void

Inherited from IContainer.swap
- Defined in tstl/src/base/container/IContainer.ts:127
Swap elements.

Parameters
- obj: SourceT
  
  Target container to swap.
Returns void

toJSON

toJSON(): Array<T>

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

Returns Array<T>

An array containing children elements.

Generated using TypeDoc