Class SortedSet<T, C>

SortedSet is a sorted mutable set.

SortedSet values are maintained in sorted order. The design of SortedSet is simple: SortedSet is implemented as a SortedArray that prevents duplicates to be inserted. It does not use the native Set type at all.

SortedSet values must have a total ordering. They are compared using the provided comparator function only; they do not have to be the same object to be considered equal.

The total ordering of values must not change while they are stored in the SortedSet.

Set methods and properties:

SortedSet#add
SortedSet#clear
SortedSet#delete
SortedSet#forEach
SortedSet#has
SortedSet#size
SortedSet#entries
SortedSet#keys
SortedSet#values
SortedSet#[Symbol.iterator]

SortedArray methods:

SortedSet#at
SortedSet#bisectLeft
SortedSet#bisectRight
SortedSet#deleteAt
SortedSet#deleteSlice
SortedSet#indexOf
SortedSet#irange
SortedSet#islice
SortedSet#pop
SortedSet#reversed

Set-operation methods:

SortedSet#union
SortedSet#update
SortedSet#intersection
SortedSet#intersectionUpdate
SortedSet#difference
SortedSet#differenceUpdate
SortedSet#symmetricDifference
SortedSet#symmetricDifferenceUpdate
SortedSet#isSubsetOf
SortedSet#isSupersetOf
SortedSet#isDisjointFrom

Miscellaneous methods:

SortedSet#clone
SortedSet#count
SortedSet#toString
SortedSet#toJSON

Type Parameters

T extends C
The element type.
C = T
Part of the element that the comparator function sees.

Hierarchy

AbstractSortedArray<T, C>
- SortedSet

Index

Constructors

constructor

new SortedSet<T, C = T>(
iterable?: Iterable<T, any, any>,
options?: SortedArrayConstructorOptions<C>,
): SortedSet<T, C>
Initialize a sorted container instance.

Optional iterable argument provides an initial iterable of values to initialize the sorted container.
Type Parameters
- T
- C = T
Parameters
- Optionaliterable: Iterable<T, any, any>
  Initial values (optional).
- Optionaloptions: SortedArrayConstructorOptions<C>
  An object that specifies characteristics about the sorted container.
Returns SortedSet<T, C>
Inherited from AbstractSortedArray<T, C>.constructor
- Defined in abstract-sorted-array.ts:73

Properties

`Static`DEFAULT_LOAD_FACTOR

DEFAULT_LOAD_FACTOR: number = 1000

The default load factor. Override it with option loadFactor at construction time.

Accessors

size

get size(): number
Return the size of the SortedSet.

Returns number
The size of the SortedSet.
- Defined in sorted-set.ts:148

Methods

_iter

_iter(): IteratorObject<T, undefined, unknown>
Return an iterator over the sorted container.

Iterating a sorted container while adding or deleting elements may throw an error or silently fail to iterate over all elements.

Returns IteratorObject<T, undefined, unknown>
Inherited from AbstractSortedArray._iter
- Defined in abstract-sorted-array.ts:582

[iterator]

"[iterator]"(): ArrayIterator<T>
An alias for values.

Returns ArrayIterator<T>
- Defined in sorted-set.ts:168

add

add(value: T): void
Add value to SortedSet if it does not already exist.
Parameters
- value: T
  Value to add to the SortedSet.
Returns void
Example
```
const ss = new SortedSet();
ss.add(3);
ss.add(1);
ss.add(2);
ss // SortedSet [1, 2, 3]
```
- Defined in sorted-set.ts:207

at

at(index: number): undefined | T
Lookup value at index in sorted container.

If index is out of range, returns undefined.
Parameters
- index: number
  The zero-based index of the desired code unit. A negative index will count back from the last item.
Returns undefined | T
The item located at the specified index, or undefined if index out of range.
Example
```
const sl = new SortedList('abcde');
sl.at(1) // 'b'
sl.at(-1) // 'e'
sl.at(7) // undefined
```
Inherited from AbstractSortedArray.at
- Defined in abstract-sorted-array.ts:552

bisectLeft

bisectLeft(value: C): number
Return an index to insert value in the sorted container.

If the value is already present, the insertion point will be before (to the left of) any existing values.
Parameters
- value: C
  Value to find the insertion point of.
Returns number
Insertion index of value in the sorted container.
Example
```
const sl = new SortedArray([10, 11, 12, 13, 14]);
sl.bisectLeft(12) // 2
```
Inherited from AbstractSortedArray.bisectLeft
- Defined in abstract-sorted-array.ts:791

bisectRight

bisectRight(value: C): number
Return an index to insert value in the sorted container.

Similar to bisectLeft, but if value is already present, the insertion point will be after (to the right of) any existing values.
Parameters
- value: C
  Value to find the insertion point of.
Returns number
Insertion index of value in the sorted container.
Example
```
const sl = new SortedArray([10, 11, 12, 13, 14]);
sl.bisectRight(12) // 3
```
Inherited from AbstractSortedArray.bisectRight
- Defined in abstract-sorted-array.ts:811

clear

clear(): void
Remove all values from sorted container.

Returns void
Inherited from AbstractSortedArray.clear
- Defined in abstract-sorted-array.ts:84

clone

clone(): this
Return a shallow copy of the sorted container.

Returns this
A new sorted container.
Inherited from AbstractSortedArray.clone
- Defined in abstract-sorted-array.ts:824

count

count(value: T): 0 | 1
Return number of occurrences of value in the SortedSet.
Parameters
- value: T
  Value to count in the SortedSet.
Returns 0 | 1
Count.
Example
```
const ss = new SortedSet([1, 2, 3, 4, 5]);
ss.count(3) // 1
```
- Defined in sorted-set.ts:241

delete

delete(value: C): boolean
Remove one value from sorted container if it is a member.

If value is not a member, do nothing.
Parameters
- value: C
  Value to discard from SortedArray.
Returns boolean
Returns true if an element in the SortedArray existed and has been removed, or false if the element does not exist.
Example
```
const sl = new SortedArray([1, 2, 3, 4, 5])
sl.delete(5)
sl.delete(0)
Array.from(sl) // [1, 2, 3, 4]
```
Inherited from AbstractSortedArray.delete
- Defined in abstract-sorted-array.ts:178

deleteAt

deleteAt(index: number): undefined | T
Remove and return value at index in sorted container.

If the sorted container is empty or index is out of range, undefined is returned and the sorted container is not modified.

Negative indices count back from the last item.
Parameters
- index: number
  Index of value. Negative integers count back from the last item in the array.
Returns undefined | T
The removed value or undefined.
Example
```
const sl = new SortedArray('abcde');
sl.deleteAt(-1) // 'e'
sl.deleteAt(2) // 'c'
sl // SortedArray ['a', 'b', 'd']
```
Inherited from AbstractSortedArray.deleteAt
- Defined in abstract-sorted-array.ts:413

deleteSlice

deleteSlice(start?: number, end?: number): void
Removes elements from sorted container by index.
Parameters
- start: number = 0
  The zero-based location in the array from which to start removing elements. Negative integers count back from the last item in the array.
- end: number = ...
  The zero-based location in the array at which to stop removing elements. Negative integers count back from the last item in the array. Elements up to but not including end are removed.
Returns void
Example
```
const sl = new SortedArray('abcde');
sl.deleteSlice(0, 2);
sl // SortedArray ['c', 'd', 'e']
```
Inherited from AbstractSortedArray.deleteSlice
- Defined in abstract-sorted-array.ts:468

difference

difference(other: Iterable<T>): SortedSet<T>
Return the difference of two sets as a new SortedSet.

The difference is all values that are in this SortedSet but not the other iterable.
Parameters
- other: Iterable<T>
  An iterable. It does not have to be a Set-like.
Returns SortedSet<T>
The difference as a new SortedSet.
Example
```
const ss = new SortedSet([1, 2, 3, 4, 5]);
ss.difference([4, 5, 6, 7, 5]) // SortedSet [1, 2, 3]
```
- Defined in sorted-set.ts:257

differenceUpdate

differenceUpdate(other: Iterable<T>): void
Remove all values of an iterable from this SortedSet.
Parameters
- other: Iterable<T>
  An iterable.
Returns void
Example
```
const ss = new SortedSet([1, 2, 3, 4, 5]);
ss.differenceUpdate([4, 5, 6, 7, 5]);
ss // SortedSet [1, 2, 3]
```
- Defined in sorted-set.ts:273

entries

entries(): SetIterator<[T, T]>
Returns an iterable of [value, value] pairs for every value in the SortedSet.

Returns SetIterator<[T, T]>
- Defined in sorted-set.ts:189

find

find(value: C): undefined | T
Return the first element in the sorted container that is equal to the provided value. If it is not found, undefined is returned.

With the default comparator and primitive elements, this method does not tell anything beyond whether the value exists in the sorted container. However, it can turn out to be useful with a custom comparator.
Parameters
- value: C
  The value to find.
Returns undefined | T
Example
```
const sl = new SortedArray(
  [
    { id: 1, value: 'one' },
    { id: 2, value: 'two' },
    { id: 3, value: 'three' },
  ],
  { comparator: (a, b) => a.id - b.id }
);
sl.find({ id: 2 }) // { id: 2, value: 'two' }
```
Inherited from AbstractSortedArray.find
- Defined in abstract-sorted-array.ts:935

forEach

forEach(fn: (value: T, value2: T, set: this) => void, thisArg?: any): void
Executes a callback function once for each element in a SortedSet.
Parameters
- fn: (value: T, value2: T, set: this) => void
  The function to execute.
- OptionalthisArg: any
  An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used.
Returns void
- Defined in sorted-set.ts:159

has

has(value: C): boolean
Return true if value is an element of the SortedSet.
Parameters
- value: C
  Search for this value in the SortedSet.
Returns boolean
true if value is in the SortedSet.
Example
```
const ss = new SortedSet([1, 2, 3, 4, 5]);
ss.has(3) // true
```
- Defined in sorted-set.ts:96

indexOf

indexOf(value: C, start?: number, end?: number): number
Return first index of value in the sorted container, or -1 if value is not present.

Index must be between start and end for the value to be considered present. Negative indices count back from the last item.
Parameters
- value: C
  Value in sorted container.
- start: number = 0
  The array index at which to start the search. If omitted, defaults to 0.
- end: number = ...
  The array index at which to end the search. If omitted, defaults to the end of the sorted container.
Returns number
The index of the first occurrence of value in the sorted container, or -1 if it is not present.
Example
```
const sl = new SortedArray('abcde');
sl.indexOf('d') // 3
sl.indexOf('z') // -1
```
Inherited from AbstractSortedArray.indexOf
- Defined in abstract-sorted-array.ts:882

intersection

intersection(other: Iterable<T>): SortedSet<T>
Return the intersection of two sets as a new SortedSet.

The intersection is all values that are in this sorted set and the other iterable.
Parameters
- other: Iterable<T>
  An iterable. It does not have to be a Set-like.
Returns SortedSet<T>
The intersection as a new SortedSet.
Example
```
const ss = new SortedSet([1, 2, 3, 4, 5]);
ss.intersection([4, 5, 6, 7, 5]) // SortedSet [4, 5]
```
- Defined in sorted-set.ts:305

intersectionUpdate

intersectionUpdate(other: Iterable<T>): void
Update the sorted set with the intersection of two sets.

Keep only values found in itself and other.
Parameters
- other: Iterable<T>
  An iterable.
Returns void
Example
```
const ss = new SortedSet([1, 2, 3, 4, 5]);
ss.intersectionUpdate([4, 5, 6, 7, 5]);
ss // SortedSet [4, 5]
```
- Defined in sorted-set.ts:323

irange

irange(
    minimum?: C,
    maximum?: C,
    includeMinimum?: boolean,
    includeMaximum?: boolean,
    reverse?: boolean,
): IteratorObject<T, undefined, unknown>
Create an iterator of values between minimum and maximum.

Both minimum and maximum default to undefined which is automatically inclusive of the beginning and end of the sorted container.

The argument includeMinimum and includeMaximum is a pair of booleans that indicates whether the minimum and maximum ought to be included in the range, respectively. Both arguments default to true such that the range is inclusive of both minimum and maximum.

When reverse is true the values are yielded from the iterator in reverse order; reverse defaults to false.

Iterating a sorted container while adding or deleting elements may throw an error or silently fail to iterate over all elements.
Parameters
- Optionalminimum: C
  Minimum value to start iterating.
- Optionalmaximum: C
  Maximum value to stop iterating.
- includeMinimum: boolean = true
  Whether the minimum ought to be included in the range.
- includeMaximum: boolean = true
  Whether the maximum ought to be included in the range.
- reverse: boolean = false
  Whether to yield values in reverse order.
Returns IteratorObject<T, undefined, unknown>
Iterator.
Example
```
const sl = new SortedArray('abcdefghij');
const it = sl.irange('c', 'f');
Array.from(it) // ['c', 'd', 'e', 'f']
```
Inherited from AbstractSortedArray.irange
- Defined in abstract-sorted-array.ts:729

isDisjointFrom

isDisjointFrom(other: Iterable<T>): boolean
Check if this SortedSet has no elements in common with the given set.
Parameters
- other: Iterable<T>
  An iterable.
Returns boolean
true if this SortedSet has no elements in common with the other set, and false otherwise.
- Defined in sorted-set.ts:136

islice

islice(
    start?: number,
    end?: number,
    reverse?: boolean,
): IteratorObject<T, undefined, unknown>
Return an iterator that slices sorted container from start to end.

The start and end index are treated inclusive and exclusive, respectively.

A negative index will count back from the last item.

Both start and end default to undefined which is automatically inclusive of the beginning and end of the sorted container.

When reverse is true the values are yielded from the iterator in reverse order; reverse defaults to false.

Iterating a sorted container while adding or deleting elements may throw an error or silently fail to iterate over all elements.
Parameters
- start: number = 0
  Start index (inclusive).
- end: number = ...
  Stop index (exclusive).
- reverse: boolean = false
  Whether to yield values in reverse order.
Returns IteratorObject<T, undefined, unknown>
Iterator.
Example
```
const sl = new SortedArray('abcdefghij');
const it = sl.islice(2, 6);
Array.from(it) // ['c', 'd', 'e', 'f']
```
Inherited from AbstractSortedArray.islice
- Defined in abstract-sorted-array.ts:622

isSubsetOf

isSubsetOf(other: Iterable<T>): boolean
Check if all elements of this SortedSet are in the given set.
Parameters
- other: Iterable<T>
  An iterable.
Returns boolean
true if all elements in this SortedSet are also in the other set, and false otherwise.
- Defined in sorted-set.ts:106

isSupersetOf

isSupersetOf(other: Iterable<C>): boolean
Check if all elements of the given set are in this SortedSet.
Parameters
- other: Iterable<C>
  An iterable.
Returns boolean
true if all elements in the other set are also in this SortedSet, and false otherwise.
- Defined in sorted-set.ts:123

keys

keys(): SetIterator<T>
Despite its name, returns an iterable of the values in the SortedSet.

Returns SetIterator<T>
- Defined in sorted-set.ts:175

pop

pop(): undefined | T
Remove the last element from the sorted container and return it. If the sorted container is empty, undefined is returned and the sorted container is not modified.

Returns undefined | T
Popped value or undefined.
Example
```
const sl = new SortedArray('abcde');
sl.pop() // 'e'
sl.pop() // 'd'
sl // SortedArray ['a', 'b', 'c']
```
Inherited from AbstractSortedArray.pop
- Defined in abstract-sorted-array.ts:862

reversed

reversed(): IteratorObject<T, undefined, unknown>
Return a reverse iterator over the sorted container.

Iterating a sorted container while adding or deleting elements may throw an error or silently fail to iterate over all elements.

Returns IteratorObject<T, undefined, unknown>
Inherited from AbstractSortedArray.reversed
- Defined in abstract-sorted-array.ts:593

shift

shift(): undefined | T
Remove the first element from the sorted container and return it. If the sorted container is empty, undefined is returned and the sorted container is not modified.

Returns undefined | T
Shifted value or undefined.
Example
```
const sl = new SortedArray('abcde');
sl.shift() // 'a'
sl.shift() // 'b'
sl // SortedArray ['c', 'd', 'e']
```
Inherited from AbstractSortedArray.shift
- Defined in abstract-sorted-array.ts:846

slice

slice(start?: number, end?: number): T[]
Returns a copy of a section of sorted container as an ordinary Array.

For both start and end, a negative index can be used to indicate an offset from the end of the array.
Parameters
- start: number = 0
  The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
- end: number = ...
  The end index of the specified portion of the array. This is exclusive of the element at the index end. If end is undefined, then the slice extends to the end of the array.
Returns T[]
Inherited from AbstractSortedArray.slice
- Defined in abstract-sorted-array.ts:502

symmetricDifference

symmetricDifference(other: Iterable<T>): SortedSet<T>
Return the symmetric difference with other as a new SortedSet.

The symmetric difference is all values tha are in exactly one of the sets.
Parameters
- other: Iterable<T>
  An iterable. It does not have to be a Set-like.
Returns SortedSet<T>
The symmetric difference as a new SortedSet.
Example
```
const ss = new SortedSet([1, 2, 3, 4, 5]);
ss.symmetricDifference([4, 5, 6, 7, 5]) // SortedSet [1, 2, 3, 6, 7]
```
- Defined in sorted-set.ts:365

symmetricDifferenceUpdate

symmetricDifferenceUpdate(other: Iterable<T>): void
Update the sorted set with the symmetric difference with other.

Keep only values found in exactly one of itself and other.
Parameters
- other: Iterable<T>
  An iterable.
Returns void
Example
```
const ss = new SortedSet([1, 2, 3, 4, 5]);
ss.symmetricDifferenceUpdate([4, 5, 6, 7, 5]);
ss // SortedSet [1, 2, 3, 6, 7]
```
- Defined in sorted-set.ts:383

toJSON

toJSON(): T[]
Return sorted container as an ordinary Array.

Returns T[]
Inherited from AbstractSortedArray.toJSON
- Defined in abstract-sorted-array.ts:950

toString

toString(): string
Return a string representation of sorted container.

Returns string
Inherited from AbstractSortedArray.toString
- Defined in abstract-sorted-array.ts:957

union

union(other: Iterable<T>): SortedSet<T>
Return new SortedSet with values from itself and other.
Parameters
- other: Iterable<T>
  An iterable. It does not have to be a Set-like.
Returns SortedSet<T>
The union as a new SortedSet.
Example
```
const ss = new SortedSet([1, 2, 3, 4, 5]);
ss.union([4, 5, 6, 7, 5]) // SortedSet [1, 2, 3, 4, 5, 6, 7]
```
See
update for an in-place version of this method.
- Defined in sorted-set.ts:409

update

update(other: Iterable<T>): void
Update the sorted set adding values from other.
Parameters
- other: Iterable<T>
  An iterable.
Returns void
Example
```
const ss = new SortedSet([1, 2, 3, 4, 5]);
ss.update([4, 5, 6, 7, 5]);
ss // SortedSet [1, 2, 3, 4, 5, 6, 7]
```
See
union for a similar method that returns a new SortedSet.
Overrides AbstractSortedArray.update
- Defined in sorted-set.ts:427

values

values(): SetIterator<T>
Returns an iterable of values in the SortedSet.

Returns SetIterator<T>
- Defined in sorted-set.ts:182

Class SortedSet<T, C>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SortedSet<T, C>

Properties

StaticDEFAULT_LOAD_FACTOR

Accessors

size

Returns number

Methods

_iter

Returns IteratorObject<T, undefined, unknown>

[iterator]

Returns ArrayIterator<T>

add

Parameters

Returns void

Example

at

Parameters

Returns undefined | T

Example

bisectLeft

Parameters

Returns number

Example

bisectRight

Parameters

Returns number

Example

clear

Returns void

clone

Returns this

count

Parameters

Returns 0 | 1

Example

delete

Parameters

Returns boolean

Example

deleteAt

Parameters

Returns undefined | T

Example

deleteSlice

Parameters

Returns void

Example

difference

Parameters

Returns SortedSet<T>

Example

differenceUpdate

Parameters

Returns void

Example

entries

Returns SetIterator<[T, T]>

find

Parameters

Returns undefined | T

Example

forEach

Parameters

Returns void

has

Parameters

Returns boolean

Example

`Static`DEFAULT_LOAD_FACTOR