Skip to main content

Class: SortedSet<T>

Defined in: utilities/sorted-set.ts:8

A small SortedSet implementation keyed by item value with a numeric priority.

  • Lower priority values come first.
  • Items with the same priority preserve insertion order (stable).
  • No duplicate items (by reference equality) are allowed.
  • Iteration uses an internal cached, sorted array for efficiency.

Type Parameters​

T​

T

Constructors​

Constructor​

new SortedSet<T>(): SortedSet<T>

Defined in: utilities/sorted-set.ts:16

Create a new SortedSet.

Returns​

SortedSet<T>

Accessors​

size​

Get Signature​

get size(): number

Defined in: utilities/sorted-set.ts:79

Number of items in the set.

Returns​

number

Methods​

[iterator]()​

[iterator](): IterableIterator<T>

Defined in: utilities/sorted-set.ts:124

Default iterator yields values.

Returns​

IterableIterator<T>

add()​

add(item, priority): boolean

Defined in: utilities/sorted-set.ts:29

Add an item with the provided priority.

Parameters​

item​

T

The item to add (unique by reference).

priority​

number

Numeric priority; lower numbers sort earlier.

Returns​

boolean

true when the set changed (item added or priority updated), false when the item already existed with the same priority.

clear()​

clear(): void

Defined in: utilities/sorted-set.ts:68

Remove all items.

Returns​

void

delete()​

delete(item): boolean

Defined in: utilities/sorted-set.ts:52

Remove an item. Returns true if the item was present.

Parameters​

item​

T

Returns​

boolean

entries()​

entries(): IterableIterator<readonly [T, number]>

Defined in: utilities/sorted-set.ts:107

Iterate entries as [item, priority].

Returns​

IterableIterator<readonly [T, number]>

forEach()​

forEach(callback): void

Defined in: utilities/sorted-set.ts:117

forEach helper that visits entries in sorted order.

Parameters​

callback​

(item, priority) => void

Invoked with (item, priority) for each entry.

Returns​

void

getPriority()​

getPriority(item): undefined | number

Defined in: utilities/sorted-set.ts:89

Get the numeric priority for an item.

Parameters​

item​

T

The item to query.

Returns​

undefined | number

The priority number or undefined when the item is not present.

has()​

has(item): boolean

Defined in: utilities/sorted-set.ts:63

Returns true when the item exists in the set.

Parameters​

item​

T

Returns​

boolean

values()​

values(): IterableIterator<T>

Defined in: utilities/sorted-set.ts:100

Iterate items in sorted order (by priority asc, then insertion order).

Returns​

IterableIterator<T>