Class SortedSet<T>

A SortedSet uses a Comparator for sorting the values and checking for equality.

Example

Add, delete and iterate

const sortedSet = new SortedSet(numberComparator);
sortedSet.add(2);

const otherSortedSet = new SortedSet(numberComparator);
otherSortedSet.add(2);
otherSortedSet.add(3);
otherSortedSet.add(1);

sortedSet.add(otherSortedSet);

sortedSet.delete(1);

const result = sortedSet.has(2);
console.log(result); // true

for(const value of sortedSet) {
  console.log(value); // 2, 3
}

Type Parameters

T

the SortedSet element type

Hierarchy

AbstractSet<T>
- SortedSet

Index

Constructors

constructor

new SortedSet<T>(comparator: Comparator<T>, values?: Iterable<T>): SortedSet<T>
Type Parameters
- T
Parameters
- comparator: Comparator<T>
  
  the Comparator to use for sorting the values
- Optional values: Iterable<T>
  
  optional Array of sorted and unique values for initialization
Returns SortedSet<T>
Overrides AbstractSet.constructor
- Defined in packages/collections/src/sortedSet.ts:47

Properties

`Private` `Readonly` #comparator

#comparator: Comparator<T>

`Private` `Readonly` #values

#values: T[]

[toStringTag]

[toStringTag]: string = "SortedSet"

See

Set[Symbol.toStringTag]

Accessors

size

get size(): number
Returns
the number of elements in this SortedSet

Returns number
Overrides AbstractSet.size
- Defined in packages/collections/src/sortedSet.ts:212

Methods

[iterator]

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

Returns IterableIterator<T>
Inherited from AbstractSet.[iterator]
- Defined in packages/collections/src/abstractSet.ts:69

add

add(value: T): SortedSet<T>
Adds values to this SortedSet if it does not already contain equal values. Values are considered equal if the Comparator returns 0.

Mutation

Example
Add values
```
const sortedSet = new SortedSet(numberComparator);

sortedSet.add(2);
sortedSet.add(0);
sortedSet.add(new SortedSet(numberComparator, [1, 2, 3]));

console.log([...sortedSet.values()]); // [0, 1, 2, 3]
```
Returns
this
Parameters
- value: T
Returns SortedSet<T>
Overrides AbstractSet.add
- Defined in packages/collections/src/sortedSet.ts:74
add(values: SortedSet<T>): SortedSet<T>
Parameters
- values: SortedSet<T>
Returns SortedSet<T>
Overrides AbstractSet.add
- Defined in packages/collections/src/sortedSet.ts:75

at

at(index: number): undefined | T
Returns the value at the specified index.

Returns
the element at the specified index, or undefined if out of bounds
Parameters
- index: number
  
  the index of the element to get
Returns undefined | T
- Defined in packages/collections/src/sortedSet.ts:166

clear

clear(): void
Removes all elements from this SortedSet.

Returns void
Overrides AbstractSet.clear
- Defined in packages/collections/src/sortedSet.ts:111

delete

delete(value: T): boolean
Removes values from this SortedSet if it does contain equal values. Values are considered equal if the Comparator returns 0.

Mutation

Example
Remove values
```
const sortedSet = new SortedSet(numberComparator, [1, 2, 3, 4, 5]);

sortedSet.delete(new SortedSet(numberComparator, [0, 1, 2, 5]))

console.log([...sortedSet.values()]); // [3, 4]
```
Returns
true if this SortedSet has ben modified, otherwise false
Parameters
- value: T
Returns boolean
Overrides AbstractSet.delete
- Defined in packages/collections/src/sortedSet.ts:134
delete(values: SortedSet<T>): boolean
Parameters
- values: SortedSet<T>
Returns boolean
Overrides AbstractSet.delete
- Defined in packages/collections/src/sortedSet.ts:135

entries

entries(): IterableIterator<[T, T]>
See
Set.entries

Returns IterableIterator<[T, T]>
Inherited from AbstractSet.entries
- Defined in packages/collections/src/abstractSet.ts:55

forEach

forEach(callbackfn: ((value: T, value2: T, set: Set<T>) => void)): void
See
Set.forEach
Parameters
- callbackfn: ((value: T, value2: T, set: Set<T>) => void)
  - - (value: T, value2: T, set: Set<T>): void
    - Parameters
      
      value: T
      
      value2: T
      
      set: Set<T>
      
      Returns void
Returns void
Inherited from AbstractSet.forEach
- Defined in packages/collections/src/abstractSet.ts:46

has

has(value: T): boolean
Checks if this SortedSet contains all of the values.

Example
Does the set contain 1 and 2?
```
const sortedSet = new SortedSet(numberComparator, [1, 2, 3]);
const result = sortedSet.has(new SortedSet(numberComparator, [1, 2]));
console.log(result); // true
```
Returns
true if this SortedSet contains all of the values, otherwise false
Parameters
- value: T
Returns boolean
Overrides AbstractSet.has
- Defined in packages/collections/src/sortedSet.ts:184
has(values: SortedSet<T>): boolean
Parameters
- values: SortedSet<T>
Returns boolean
Overrides AbstractSet.has
- Defined in packages/collections/src/sortedSet.ts:185

keys

keys(): IterableIterator<T>
See
Set.keys

Returns IterableIterator<T>
Inherited from AbstractSet.keys
- Defined in packages/collections/src/abstractSet.ts:62

values

values(): IterableIterator<T>
Returns
an Iterable of the values of this SortedSet.

Returns IterableIterator<T>
Overrides AbstractSet.values
- Defined in packages/collections/src/sortedSet.ts:219

Class SortedSet<T>

Example

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

comparator: Comparator<T>

Optional values: Iterable<T>

Returns SortedSet<T>

Properties

Private Readonly #comparator

Private Readonly #values

[toStringTag]

See

Accessors

size

Returns

Returns number

Methods

[iterator]

See

Returns IterableIterator<T>

add

Mutation

Example

Returns

Parameters

value: T

Returns SortedSet<T>

Parameters

values: SortedSet<T>

Returns SortedSet<T>

at

Returns

Parameters

index: number

Returns undefined | T

clear

Returns void

delete

Mutation

Example

Returns

Parameters

value: T

Returns boolean

Parameters

values: SortedSet<T>

Returns boolean

entries

See

Returns IterableIterator<[T, T]>

forEach

See

Parameters

callbackfn: ((value: T, value2: T, set: Set<T>) => void)

Parameters

value: T

value2: T

set: Set<T>

Returns void

Returns void

has

Example

Returns

Parameters

value: T

Returns boolean

Parameters

values: SortedSet<T>

Returns boolean

`Optional` values: Iterable<T>

`Private` `Readonly` #comparator

`Private` `Readonly` #values