namespace SortedSet
A type-invariant immutable Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the SortedSet API documentation
Companion interface: SortedSet<T>
Interfaces
| Name | Description |
|---|---|
SortedSet.Builder<T> | A mutable SortedSet builder used to efficiently create new immutable instances. See the Set documentation and the SortedSet.Builder API documentation |
SortedSet.Context<UT> | A context instance for a SortedSet that acts as a factory for every instance of this type of collection. |
SortedSet.NonEmpty<T> | A non-empty type-invariant immutable Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the SortedSet API documentation |
SortedSet.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.
buildercreateContext
Returns a new SortedSet context instance based on the given options.
createContextoptions.Definition
createContext<UT>(options?: {
comp?: Comp<UT>;
blockSizeBits?: number;
}): SortedSet.Context<UT>;
Type parameters
| Name | Description |
|---|---|
| UT | the upper element type for which the context can create instances |
Parameters
| Name | Type | Description |
|---|---|---|
options | {comp?: Comp<UT>;blockSizeBits?: number;} | (optional) an object containing the following properties: - comp: (optional) the comparator instance for elements - blockSizeBits: (default: 5) the power of 2 to to blockSizeBits to use as block size for all instances that are created from the context. |
defaultContext
Returns the default context for SortedSets.
defaultContextDefinition
defaultContext<UT>(): SortedSet.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.
emptyfrom
Returns an immutable set of this collection type and context, containing the given values in source.
fromsource.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 |
HashSet.from([1, 2, 3], [4, 5]) // => HashSet.NonEmpty<number>
Overrides
of
Returns an immutable set of this type and context, containing the given values.
ofvalues.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 |
HashSet.of(1, 2, 3).toArray() // => [1, 2, 3]
Overrides
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.
reducerReducer 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 |
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]
uses an RSet builder under the hood. If the given source is a RSet in the same context, it will directly call .toBuilder().