interface OrderedHashSet<T>

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 namespace: OrderedHashSet

Extends: OrderedSetBase<T,Tp>

Implemented by: OrderedHashSet.NonEmpty<T>

Type parameters

Name	Description
T	the value type

note

• The OrderedHashSet keeps the insertion order of values, thus iterators and stream will also reflect this order. - The OrderedHashSet wraps around a HashSet instance, thus has the same time complexity as the HashSet. - The OrderedHashSet keeps the key insertion order in a List, thus its space complexity is higher than a regular HashSet.

example

const s1 = OrderedHashSet.empty<string>()
const s2 = OrderedHashSet.of('a', 'b', 'c')

Properties

context

Returns the context associated to this collection instance.

Definition

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

Overrides

RSetBase.context

isEmpty

Returns true if the collection is empty.

Definition

readonly isEmpty: boolean;

Overrides

VariantSetBase.isEmpty

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

size

Returns the number of values in the collection.

Definition

readonly size: number;

Overrides

VariantSetBase.size

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

Methods

[Symbol.iterator]

Returns a FastIterator instance used to iterate over the values of this Iterable.

Definition

[Symbol.iterator](): FastIterator<T>;

Overrides

FastIterable.[Symbol.iterator]

add

Returns the collection with given value added.

Definition

add(value: T): WithElem<Tp, T>['nonEmpty'];

Parameters

Name	Type	Description
value	T	the value to add

example

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

Overrides

RSetBase.add

addAll

Returns the collection with the values in given values StreamSource added.

Definitions

addAll(values: StreamSource.NonEmpty<T>): WithElem<Tp, T>['nonEmpty'];

addAll(values: StreamSource<T>): WithElem<Tp, T>['normal'];

Parameters

Name	Type	Description
values	StreamSource.NonEmpty<T>	a StreamSource containing values to add

example

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

Overrides

RSetBase.addAll

assumeNonEmpty

Returns the same collection typed as non-empty.

Definition

assumeNonEmpty(): WithElem<Tp, T>['nonEmpty'];

throws

RimbuError.EmptyCollectionAssumedNonEmptyError if the collection is empty

example

HashSet.empty().assumeNonEmpty()          // => throws RimbuError.EmptyCollectionAssumedNonEmptyError
HashSet.from([[0, 1]]).assumeNonEmpty()   // => List.NonEmpty(0, 1, 2)

Overrides

VariantSetBase.assumeNonEmpty

difference

Returns a collection where each value of given other StreamSource is removed from this collection.

Definition

difference<U = T>(other: StreamSource<RelatedTo<T, U>>): WithElem<Tp, T>['normal'];

Type parameters

Name	Default	Description
U	T

Parameters

Name	Type	Description
other	StreamSource<RelatedTo<T, U>>	a StreamSource containing values

example

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

Overrides

VariantSetBase.difference

filter

Returns a collection containing only those entries that satisfy given pred predicate.

Definition

filter(pred: (value: T, index: number, halt: () => void) => boolean): WithElem<Tp, T>['normal'];

Parameters

Name	Type	Description
pred	(value: T, index: number, halt: () => void) => boolean	a predicate function receiving: - value: the next value - index: the entry index - halt: a function that, when called, ensures no next elements are passed

example

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

Overrides

VariantSetBase.filter

forEach

Performs given function f for each value of the collection, using given state as initial traversal state.

Definition

forEach(f: (value: T, index: number, halt: () => void) => void, state?: TraverseState): void;

Parameters

Name	Type	Description
f	(value: T, index: number, halt: () => void) => void	the function to perform for each element, receiving: - value: the next element - index: the index of the element - halt: a function that, if called, ensures that no new elements are passed
state	TraverseState	(optional) the traverse state

example

HashSet.of(1, 2, 3).forEach((value, i, halt) => {
console.log([value, i]);
if (i >= 1) halt();
})
// => logs [1, 0]  [2, 1]

note

O(N)

Overrides

VariantSetBase.forEach

has

Returns true if given value is in the collection.

Definition

has<U = T>(value: RelatedTo<T, U>): boolean;

Type parameters

Name	Default	Description
U	T

Parameters

Name	Type	Description
value	RelatedTo<T, U>	the value to look for

example

HashSet.of(1, 2, 3).has(2)  // => true
HashSet.of(1, 2, 3).has(10) // => false

Overrides

VariantSetBase.has

intersect

Returns a collection containing values that are both in this collection, and in the given other StreamSource.

Definition

intersect<U = T>(other: StreamSource<RelatedTo<T, U>>): WithElem<Tp, T>['normal'];

Type parameters

Name	Default	Description
U	T

Parameters

Name	Type	Description
other	StreamSource<RelatedTo<T, U>>	a StreamSource containing values

example

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

Overrides

VariantSetBase.intersect

nonEmpty

Returns true if there is at least one entry in the collection, and instructs the compiler to treat the collection as a .NonEmpty type.

Definition

nonEmpty(): this is WithElem<Tp, T>['nonEmpty'];

example

const m: HashSet<number> = HashSet.of(1, 2, 2)
m.stream().first(0)     // compiler allows fallback value since the Stream may be empty
if (m.nonEmpty()) {
m.stream().first(0)   // compiler error: fallback value not allowed since Stream is not empty
}

Overrides

VariantSetBase.nonEmpty

remove

Returns the collection with given value removed.

Definition

remove<U = T>(value: RelatedTo<T, U>): WithElem<Tp, T>['normal'];

Type parameters

Name	Default	Description
U	T

Parameters

Name	Type	Description
value	RelatedTo<T, U>	the value to remove

example

const s = HashSet.of(1, 2, 3)
s.remove(2).toArray()   // => [1, 3]
s.remove(10).toArray()  // => [1, 2, 3]

Overrides

VariantSetBase.remove

removeAll

Returns the collection with all values in the given values StreamSource removed.

Definition

removeAll<U = T>(values: StreamSource<RelatedTo<T, U>>): WithElem<Tp, T>['normal'];

Type parameters

Name	Default	Description
U	T

Parameters

Name	Type	Description
values	StreamSource<RelatedTo<T, U>>	a StreamSource containing values to remove

example

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

Overrides

VariantSetBase.removeAll

stream

Returns a Stream containing all elements of this collection.

Definition

stream(): Stream<T>;

example

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

Overrides

VariantSetBase.stream

symDifference

Returns a collection of the values that are either in this collection or in the other StreamSource, but not in both.

Definition

symDifference(other: StreamSource<T>): WithElem<Tp, T>['normal'];

Parameters

Name	Type	Description
other	StreamSource<T>	a StreamSource containing values

example

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

Overrides

RSetBase.symDifference

toArray

Returns an array containing all values in this collection.

Definition

toArray(): T[];

example

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

note

O(log(N)) @note it is safe to mutate the returned array, however, the array elements are not copied, thus should be treated as read-only

Overrides

VariantSetBase.toArray

toBuilder

Returns a builder object containing the values of this collection.

Definition

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

example

const builder: HashSet.Builder<number> = HashSet.of(1, 2, 3).toBuilder()

Overrides

RSetBase.toBuilder

toJSON

Returns a JSON representation of this collection.

Definition

toJSON(): ToJSON<T[]>;

example

HashSet.of(1, 2, 3).toJSON()   // => { dataType: 'HashSet', value: [1, 2, 3] }

Overrides

VariantSetBase.toJSON

toString

Returns a string representation of this collection.

Definition

toString(): string;

example

HashSet.of(1, 2, 3).toString()   // => HashSet(1, 2, 3)

Overrides

VariantSetBase.toString

union

Returns a collection containing all values from this collection and all values of given other StreamSource.

Definitions

union(other: StreamSource.NonEmpty<T>): WithElem<Tp, T>['nonEmpty'];

union(other: StreamSource<T>): WithElem<Tp, T>['normal'];

Parameters

Name	Type	Description
other	StreamSource.NonEmpty<T>	a StreamSource containing values

example

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

Overrides

RSetBase.union