Skip to main content

interface OrderedSet<T>

A type-invariant immutable Ordered Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the OrderedSet API documentation

Companion namespace: OrderedSet

Extends: OrderedSetBase<T,Tp>

Implemented by: OrderedSet.NonEmpty<T>

Type parameters

NameDescription
Tthe value type
note
  • The OrderedSet keeps the insertion order of values, thus iterators and stream will also reflect this order. - The OrderedSet wraps around an RSet instance, thus has the same time complexity as the source set. - The OrderedSet keeps the key insertion order in a List, thus its space complexity is higher than the source set.
example
const s1 = OrderedSortedSet.empty<string>()
const s2 = OrderedSortedSet.of('a', 'b', 'c')

Properties

order

Returns a List instance containing the order of the elements.

Definition

readonly order: List<T>;

example
const s = OrderedHashSet.of('b', 'a', 'c')
console.log(s.order.toArray())
// => ['b', 'a', 'c']

Overrides

OrderedSetBase.order

sourceSet

Returns the contained Set instance.

Definition

readonly sourceSet: WithElem<Tp, T>['sourceSet'];

example
const s = OrderedHashSet.of('b', 'a', 'c')
console.log(m.sourceSet.toString())
// => HashSet('a', 'b', 'c')

Overrides

OrderedSetBase.sourceSet