Class TreeSet<K, R>

An ordered Set backed by a red-black tree.

Iteration order is ascending by key.
No node exposure: all APIs use keys only.

Type Parameters

K = any
R = K

Implements

Iterable<K>

Index

Constructors

constructor

Accessors

size

Constructors

constructor

new TreeSet<K, R>(elements?, options?): TreeSet<K, R>
Create a TreeSet from an iterable of keys or raw elements.
Type Parameters
- K = any
- R = K
Parameters
- elements: Iterable<K, any, any> | Iterable<R, any, any> = []
  Iterable of keys, or raw elements if toElementFn is provided.
- options: TreeSetOptions<K, R> = {}
  Configuration options including optional toElementFn to transform raw elements.
Returns TreeSet<K, R>
Throws
When using the default comparator and encountering unsupported key types, or invalid keys (e.g. NaN, invalid Date).
Example
```
// Standard usage with keys
const set = new TreeSet([3, 1, 2]);

// Using toElementFn to transform raw objects
const users = [{ id: 3, name: 'Alice' }, { id: 1, name: 'Bob' }];
const set = new TreeSet<number, User>(users, { toElementFn: u => u.id });
```
- Defined in src/data-structures/binary-tree/tree-set.ts:40

Accessors

size

get size(): number
Number of elements in the set.

Returns number
- Defined in src/data-structures/binary-tree/tree-set.ts:96

Methods

add

add(key): this
Add a key to the set (no-op if already present).
Parameters
- key: K
Returns this
Remarks
Expected time O(log n)
- Defined in src/data-structures/binary-tree/tree-set.ts:130

ceiling

ceiling(key): undefined | K
Smallest key that is >= the given key.
Parameters
- key: K
Returns undefined | K
- Defined in src/data-structures/binary-tree/tree-set.ts:352

clear

clear(): void
Remove all keys.

Returns void
- Defined in src/data-structures/binary-tree/tree-set.ts:160

delete

delete(key): boolean
Delete a key.
Parameters
- key: K
Returns boolean
true if the key existed; otherwise false.

Remarks
Expected time O(log n)
- Defined in src/data-structures/binary-tree/tree-set.ts:151

entries

entries(): IterableIterator<[K, K], any, any>
Iterate over [value, value] pairs (native Set convention).

Note: TreeSet stores only keys internally; [k, k] is created on-the-fly during iteration.

Returns IterableIterator<[K, K], any, any>
- Defined in src/data-structures/binary-tree/tree-set.ts:185

every

every(callbackfn, thisArg?): boolean
Test whether all values satisfy a predicate.
Parameters
- callbackfn: TreeSetElementCallback<K, boolean, TreeSet<K, K>>
- OptionalthisArg: unknown
Returns boolean
Remarks
Time O(n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-set.ts:255

filter

filter(callbackfn, thisArg?): TreeSet<K, K>
Create a new TreeSet containing only values that satisfy the predicate.
Parameters
- callbackfn: TreeSetElementCallback<K, boolean, TreeSet<K, K>>
- OptionalthisArg: unknown
Returns TreeSet<K, K>
Remarks
Time O(n log n) expected, Space O(n)
- Defined in src/data-structures/binary-tree/tree-set.ts:228

find

find(callbackfn, thisArg?): undefined | K
Find the first value that satisfies a predicate.
Parameters
- callbackfn: TreeSetElementCallback<K, boolean, TreeSet<K, K>>
- OptionalthisArg: unknown
Returns undefined | K
Remarks
Time O(n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-set.ts:285

first

first(): undefined | K
Smallest key in the set.

Returns undefined | K
- Defined in src/data-structures/binary-tree/tree-set.ts:318

floor

floor(key): undefined | K
Largest key that is <= the given key.
Parameters
- key: K
Returns undefined | K
- Defined in src/data-structures/binary-tree/tree-set.ts:360

forEach

forEach(cb, thisArg?): void
Visit each value in ascending order.

Callback follows native Set convention: (value, value2, set).
Parameters
- cb: ((value: K, value2: K, set: TreeSet<K, K>) => void)
  - - (value, value2, set): void
    - Parameters
      value: K
      value2: K
      set: TreeSet<K, K>
      Returns void
- OptionalthisArg: any
Returns void
- Defined in src/data-structures/binary-tree/tree-set.ts:198

has

has(key): boolean
Test whether a key exists.
Parameters
- key: K
Returns boolean
Remarks
Expected time O(log n)
- Defined in src/data-structures/binary-tree/tree-set.ts:141

higher

higher(key): undefined | K
Smallest key that is > the given key.
Parameters
- key: K
Returns undefined | K
- Defined in src/data-structures/binary-tree/tree-set.ts:368

isEmpty

isEmpty(): boolean
Whether the set is empty.

Returns boolean
- Defined in src/data-structures/binary-tree/tree-set.ts:103

keys

keys(): IterableIterator<K, any, any>
Iterate over keys in ascending order.

Returns IterableIterator<K, any, any>
- Defined in src/data-structures/binary-tree/tree-set.ts:167

last

last(): undefined | K
Largest key in the set.

Returns undefined | K
- Defined in src/data-structures/binary-tree/tree-set.ts:325

lower

lower(key): undefined | K
Largest key that is < the given key.
Parameters
- key: K
Returns undefined | K
- Defined in src/data-structures/binary-tree/tree-set.ts:376

map

map<MK>(callbackfn, options?, thisArg?): TreeSet<MK, MK>
Create a new TreeSet by mapping each value to a new key.

This mirrors RedBlackTree.map: mapping produces a new ordered container.
Type Parameters
- MK
Parameters
- callbackfn: TreeSetElementCallback<K, MK, TreeSet<K, K>>
- options: Omit<TreeSetOptions<MK, MK>, "toElementFn"> & {
  comparator?: ((a: MK, b: MK) => number);
  } = {}
- OptionalthisArg: unknown
Returns TreeSet<MK, MK>
Remarks
Time O(n log n) expected, Space O(n)
- Defined in src/data-structures/binary-tree/tree-set.ts:208

pollFirst

pollFirst(): undefined | K
Remove and return the smallest key.

Returns undefined | K
- Defined in src/data-structures/binary-tree/tree-set.ts:332

pollLast

pollLast(): undefined | K
Remove and return the largest key.

Returns undefined | K
- Defined in src/data-structures/binary-tree/tree-set.ts:342

print

print(): void
Print a human-friendly representation.

Returns void
Remarks
Time O(n), Space O(n)
- Defined in src/data-structures/binary-tree/tree-set.ts:308

rangeSearch

rangeSearch(range, options?): K[]
Return all keys in a given range.
Parameters
- range: [K, K]
  [low, high]
- options: TreeSetRangeOptions = {}
  Inclusive/exclusive bounds (defaults to inclusive).
Returns K[]
- Defined in src/data-structures/binary-tree/tree-set.ts:387

reduce

reduce<A>(callbackfn, initialValue): A
Reduce values into a single accumulator.
Type Parameters
- A
Parameters
- callbackfn: TreeSetReduceCallback<K, A, TreeSet<K, K>>
- initialValue: A
Returns A
Remarks
Time O(n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-set.ts:244

some

some(callbackfn, thisArg?): boolean
Test whether any value satisfies a predicate.
Parameters
- callbackfn: TreeSetElementCallback<K, boolean, TreeSet<K, K>>
- OptionalthisArg: unknown
Returns boolean
Remarks
Time O(n), Space O(1)
- Defined in src/data-structures/binary-tree/tree-set.ts:270

toArray

toArray(): K[]
Materialize the set into an array of keys.

Returns K[]
Remarks
Time O(n), Space O(n)
- Defined in src/data-structures/binary-tree/tree-set.ts:300

values

values(): IterableIterator<K, any, any>
Iterate over values in ascending order.

Note: for Set-like containers, values() is the same as keys().

Returns IterableIterator<K, any, any>
- Defined in src/data-structures/binary-tree/tree-set.ts:176

`Static`createDefaultComparator

createDefaultComparator<K>(): Comparator<K>
Create the strict default comparator.

Supports:
- number (rejects NaN; treats -0 and 0 as equal)
- string
- Date (orders by getTime(), rejects invalid dates)
For other key types, a custom comparator must be provided.
Type Parameters
- K
Returns Comparator<K>
- Defined in src/data-structures/binary-tree/tree-set.ts:65

Class TreeSet<K, R>

Type Parameters

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TreeSet<K, R>

Throws

Example

Accessors

size

Returns number

Methods

add

Parameters

Returns this

Remarks

ceiling

Parameters

Returns undefined | K

clear

Returns void

delete

Parameters

Returns boolean

Remarks

entries

Returns IterableIterator<[K, K], any, any>

every

Parameters

Returns boolean

Remarks

filter

Parameters

Returns TreeSet<K, K>

Remarks

find

Parameters

Returns undefined | K

Remarks

first

Returns undefined | K

floor

Parameters

Returns undefined | K

forEach

Parameters

Parameters

Returns void

Returns void

has

Parameters

Returns boolean

Remarks

higher

Parameters

Returns undefined | K

isEmpty

Returns boolean

keys

Returns IterableIterator<K, any, any>

last

Returns undefined | K

lower

Parameters

Returns undefined | K

map

Type Parameters

Parameters

Returns TreeSet<MK, MK>

Remarks

pollFirst

Returns undefined | K

pollLast

Returns undefined | K

`Static`createDefaultComparator