namespace OrderedHashSet

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

Companion interface: OrderedHashSet<T>

Interfaces

Name	Description
OrderedHashSet.Builder<T>	A mutable OrderedHashSet builder used to efficiently create new immutable instances. See the Set documentation and the OrderedHashSet.Builder API documentation
OrderedHashSet.Context<UT>	A context instance for an OrderedHashSet that acts as a factory for every instance of this type of collection.
OrderedHashSet.NonEmpty<T>	A non-empty type-invariant immutable Ordered HashSet of value type T. In the Set, there are no duplicate values. See the Set documentation and the OrderedHashSet API documentation
OrderedHashSet.Types	Utility interface that provides higher-kinded types for this collection.

Static Methods

builder

Returns an empty builder instance for this type of collection and context.

Definition

builder<T extends UT>(): WithElem<Tp, T>['builder'];

Type parameters

Name	Constraints	Description
T	UT

example

HashSet.builder<number>()     // => HashSet.Builder<number>

Overrides

Factory.builder

createContext

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

Definition

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

Type parameters

Name	Description
UT	the upper element type for which the context can create instances

Parameters

Name	Type	Description
options	{     listContext?: List.Context;     setContext?: HashSet.Context<UT>;   }	(optional) an object containing the following properties: - listContext: (optional) the list context to use for element ordering - setContext: (optional) the set context to use for element sets

defaultContext

Returns the default context for OrderedHashSets.

Definition

defaultContext<UT>(): OrderedHashSet.Context<UT>;

Type parameters

Name	Description
UT	the upper element type for which the context can create instances

empty

Returns the (singleton) empty instance of this type and context with given value type.

Definition

empty<T extends UT>(): WithElem<Tp, T>['normal'];

Type parameters

Name	Constraints	Description
T	UT

example

HashSet.empty<number>()    // => HashSet<number>
HashSet.empty<string>()    // => HashSet<string>

Overrides

Factory.empty

from

Returns an immutable set of this collection type and context, containing the given values in source.

Definitions

from<T extends UT>(...sources: ArrayNonEmpty<StreamSource.NonEmpty<T>>): WithElem<Tp, T>['nonEmpty'];

from<T extends UT>(...sources: ArrayNonEmpty<StreamSource<T>>): WithElem<Tp, T>['normal'];

Type parameters

Name	Constraints	Description
T	UT

Parameters

Name	Type	Description
sources	ArrayNonEmpty<StreamSource.NonEmpty<T>>	an array of StreamSource instances containing values

example

HashSet.from([1, 2, 3], [4, 5])   // => HashSet.NonEmpty<number>

Overrides

Factory.from

of

Returns an immutable set of this type and context, containing the given values.

Definition

of<T extends UT>(...values: ArrayNonEmpty<T>): WithElem<Tp, T>['nonEmpty'];

Type parameters

Name	Constraints	Description
T	UT

Parameters

Name	Type	Description
values	ArrayNonEmpty<T>	a non-empty array of values

example

HashSet.of(1, 2, 3).toArray()   // => [1, 2, 3]

Overrides

Factory.of

reducer

Returns a Reducer that appends received items to an RSet and returns the RSet as a result. When a source is given, the reducer will first create an RSet from the source, and then append elements to it.

Definition

reducer<T extends UT>(source?: StreamSource<T>): Reducer<T, WithElem<Tp, T>['normal']>;

Type parameters

Name	Constraints	Description
T	UT

Parameters

Name	Type	Description
source	StreamSource<T>	(optional) an initial source of elements to append to

example

const someList = SortedSet.of(1, 2, 3);
const result = Stream.range({ start: 20, amount: 5 }).reduce(SortedSet.reducer(someList))
result.toArray()   // => [1, 2, 3, 20, 21, 22, 23, 24]

note

uses an RSet builder under the hood. If the given source is a RSet in the same context, it will directly call .toBuilder().

Overrides

Factory.reducer