Class SortedMap<K, V>

An abstract helper class that implements the common base functionality of a Map.

Type Parameters

Hierarchy

AbstractMap<K, V>
- SortedMap

Index

Constructors

constructor

new SortedMap<K, V>(comparator: Comparator<K>, entries?: Iterable<Entry<K, V>>): SortedMap<K, V>
Type Parameters
- K
- V
Parameters
- comparator: Comparator<K>
- Optional entries: Iterable<Entry<K, V>>
Returns SortedMap<K, V>
Overrides AbstractMap.constructor
- Defined in packages/collections/src/sortedMap.ts:18

Properties

`Private` `Readonly` #comparator

#comparator: Comparator<K>

`Private` `Readonly` #value

#value: Entry<K, V>[]

[toStringTag]

[toStringTag]: string = "SortedMap"

See

Map[Symbol.toStringTag]

Accessors

size

get size(): number
See
Map.size

Returns number
Overrides AbstractMap.size
- Defined in packages/collections/src/sortedMap.ts:151

Methods

[iterator]

[iterator](): IterableIterator<[K, V]>
See
Map[Symbol.iterator]

Returns IterableIterator<[K, V]>
Inherited from AbstractMap.[iterator]
- Defined in packages/collections/src/abstractMap.ts:74

at

at(index: number): undefined | [K, V]
Parameters
- index: number
Returns undefined | [K, V]
- Defined in packages/collections/src/sortedMap.ts:69

clear

clear(): void
See
Map.clear

Returns void
Overrides AbstractMap.clear
- Defined in packages/collections/src/sortedMap.ts:28

delete

delete(key: K): boolean
See
Map.delete
Parameters
- key: K
Returns boolean
Overrides AbstractMap.delete
- Defined in packages/collections/src/sortedMap.ts:32

deleteAll

deleteAll(keys: SortedSet<K>): boolean
Parameters
- keys: SortedSet<K>
Returns boolean
- Defined in packages/collections/src/sortedMap.ts:38

deleteAt

deleteAt(index: number, deleteCount?: number): boolean
Parameters
- index: number
- Optional deleteCount: number
Returns boolean
- Defined in packages/collections/src/sortedMap.ts:65

entries

entries(): IterableIterator<[K, V]>
See
Map.entries

Returns IterableIterator<[K, V]>
Overrides AbstractMap.entries
- Defined in packages/collections/src/sortedMap.ts:155

forEach

forEach(callbackfn: ((value: V, key: K, sortedMap: SortedMap<K, V>) => void)): void
See
Map.forEach
Parameters
- callbackfn: ((value: V, key: K, sortedMap: SortedMap<K, V>) => void)
  - - (value: V, key: K, sortedMap: SortedMap<K, V>): void
    - Parameters
      
      value: V
      
      key: K
      
      sortedMap: SortedMap<K, V>
      
      Returns void
Returns void
Inherited from AbstractMap.forEach
- Defined in packages/collections/src/abstractMap.ts:51

get

get(key: K): undefined | V
See
Map.get
Parameters
- key: K
Returns undefined | V
Overrides AbstractMap.get
- Defined in packages/collections/src/sortedMap.ts:73

has

has(key: K, fromIndex?: number): boolean
See
Map.has
Parameters
- key: K
- Optional fromIndex: number
Returns boolean
Overrides AbstractMap.has
- Defined in packages/collections/src/sortedMap.ts:84

hasAll

hasAll(keys: SortedSet<K>): boolean
Parameters
- keys: SortedSet<K>
Returns boolean
- Defined in packages/collections/src/sortedMap.ts:88

indexOf

indexOf(key: K, fromIndex?: number): number
Parameters
- key: K
- Optional fromIndex: number
Returns number
- Defined in packages/collections/src/sortedMap.ts:77

keys

keys(): IterableIterator<K>
See
Map.keys

Returns IterableIterator<K>
Inherited from AbstractMap.keys
- Defined in packages/collections/src/abstractMap.ts:60

set

set(key: K, value: V): SortedMap<K, V>
See
Map.set
Parameters
- key: K
- value: V
Returns SortedMap<K, V>
Overrides AbstractMap.set
- Defined in packages/collections/src/sortedMap.ts:96

setAll

setAll(entries: SortedMap<K, V>): SortedMap<K, V>
Parameters
- entries: SortedMap<K, V>
Returns SortedMap<K, V>
- Defined in packages/collections/src/sortedMap.ts:118

values

values(): IterableIterator<V>
See
Map.values

Returns IterableIterator<V>
Inherited from AbstractMap.values
- Defined in packages/collections/src/abstractMap.ts:67

Class SortedMap<K, V>

Type Parameters

K

V

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

K

V

Parameters

comparator: Comparator<K>

Optional entries: Iterable<Entry<K, V>>

Returns SortedMap<K, V>

Properties

Private Readonly #comparator

Private Readonly #value

[toStringTag]

See

Accessors

size

See

Returns number

Methods

[iterator]

See

Returns IterableIterator<[K, V]>

at

Parameters

index: number

Returns undefined | [K, V]

clear

See

Returns void

delete

See

Parameters

key: K

Returns boolean

deleteAll

Parameters

keys: SortedSet<K>

Returns boolean

deleteAt

Parameters

index: number

Optional deleteCount: number

Returns boolean

entries

See

Returns IterableIterator<[K, V]>

forEach

See

Parameters

callbackfn: ((value: V, key: K, sortedMap: SortedMap<K, V>) => void)

Parameters

value: V

key: K

sortedMap: SortedMap<K, V>

Returns void

Returns void

get

See

Parameters

key: K

Returns undefined | V

has

See

Parameters

key: K

Optional fromIndex: number

Returns boolean

hasAll

Parameters

keys: SortedSet<K>

`Optional` entries: Iterable<Entry<K, V>>

`Private` `Readonly` #comparator

`Private` `Readonly` #value

`Optional` deleteCount: number

`Optional` fromIndex: number

`Optional` fromIndex: number