Skip to main content

namespace OrderedSet

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 interface: OrderedSet<T>

Interfaces

NameDescription
OrderedSet.Builder<T>A mutable OrderedSet builder used to efficiently create new immutable instances. See the Set documentation and the OrderedSet.Builder API documentation
OrderedSet.Context<UT>undocumented
OrderedSet.NonEmpty<T>A non-empty type-invariant immutable Ordered SortedSet of value type T. In the Set, there are no duplicate values. See the Set documentation and the OrderedSet API documentation
OrderedSet.TypesUtility interface that provides higher-kinded types for this collection.

Static Methods

createContext

Returns a new OrderedSet context instance based on the given options.

Definition

createContext<UT>(options: {
    listContext?: List.Context;
    setContext: RSet.Context<UT>;
  }): OrderedSet.Context<UT>;

Type parameters

NameDescription
UTthe upper element type for which the context can create instances

Parameters

NameTypeDescription
options{
    listContext?: List.Context;
    setContext: RSet.Context<UT>;
  }
an object containing the following properties:
- listContext - the list context to use for element ordering
- setContext - the set context to use for element sets