interface 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

Extends: Streamable.NonEmpty<T>, RSetBase.NonEmpty<T,Tp>, SortedSet<T>

Implemented by: SortedSetNode<T>

Type parameters

Name	Description
T	the value type

note

• The SortedSet keeps the inserted values in sorted order according to the context's comp Comp instance.

example

const s1 = SortedSet.empty<string>()
const s2 = SortedSet.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 false since this collection is known to be non-empty

Definition

readonly isEmpty: false;

example

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

Overrides

VariantSetBase.isEmptyNonEmpty.isEmpty

size

Returns the number of values in the collection.

Definition

readonly size: number;

Overrides

VariantSetBase.size

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, NonEmpty.add

addAll

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

Definition

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

Parameters

Name	Type	Description
values	StreamSource<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, NonEmpty.addAll

asNormal

Returns this collection typed as a 'possibly empty' collection.

Definition

asNormal(): WithElem<Tp, T>['normal'];

example

HashSet.of(1, 2).asNormal();  // type: HashSet<number>

Overrides

NonEmpty.asNormal

assumeNonEmpty

Returns a self reference since this collection is known to be non-empty.

Definition

assumeNonEmpty(): this;

example

const m = HashSet.of(1, 2, 3);
m === m.assumeNonEmpty()  // => true

Overrides

VariantSetBase.assumeNonEmpty, NonEmpty.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

drop

Returns a SortedSet containing all but the the first amount of value of this SortedSet.

Definition

drop(amount: number): SortedSet<T>;

Parameters

Name	Type	Description
amount	number	the amount of elements to keep

note

a negative amount drops the last values instead of the first, e.g. -2 is the last 2 elements

example

const m = SortedSet.of('b', 'd', 'a', 'c').asNormal();
console.log(m.drop(2).toArray())
// => ['c', 'd']
console.log(m.drop(-2).toArray())
// => ['a', 'b']

Overrides

SortedSet.drop

filter

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

Definitions

filter<TF extends T>(pred: (value: T, index: number, halt: () => void) => value is TF, options?: {
    negate?: false | undefined;
  }): WithElem<Tp, TF>['normal'];

filter<TF extends T>(pred: (value: T, index: number, halt: () => void) => value is TF, options: {
    negate: true;
  }): WithElem<Tp, Exclude<T, TF>>['normal'];

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

Type parameters

Name	Constraints	Description
TF	T

Parameters

Name	Type	Description
pred	(value: T, index: number, halt: () => void) => value is TF	a predicate function receiving: - value: the next value - index: the entry index - halt: a function that, when called, ensures no next elements are passed
options	{     negate?: false | undefined;   }	(optional) an object containing the following properties: - negate: (default: false) when true will negate the predicate

note

if the predicate is a type guard, the return type is automatically inferred

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, options?: {
    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
options	{     state?: TraverseState;   }

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

getAtIndex

Returns the value at the given index of the value sort order of the SortedSet, or a fallback value (default: undefined) if the index is out of bounds.

Definitions

getAtIndex(index: number): T | undefined;

getAtIndex<O>(index: number, otherwise: OptLazy<O>): T | O;

Parameters

Name	Type	Description
index	number	the index in the key sort order

note

negative index values will retrieve the values from the end of the sort order, e.g. -1 is the last value

example

const m = SortedSet.of('b', 'd', 'a', 'c').asNormal();
console.log(m.getAtIndex(1))
// => 'b'
console.log(m.getAtIndex(-1))
// => 'd'
console.log(m.getAtIndex(10))
// => undefined
console.log(m.getAtIndex(10, 'q'))
// => 'q'

Overrides

SortedSet.getAtIndex

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

max

Returns the maximum value of the SortedSet.

Definition

max(): T;

example

const m = SortedSet.of('b', 'd', 'a', 'c');
console.log(m.max())
// => 'd'

Overrides

SortedSet.max

min

Returns the minimum value of the SortedSet.

Definition

min(): T;

example

const m = SortedSet.of('b', 'd', 'a', 'c');
console.log(m.min())
// => 'a'

Overrides

SortedSet.min

nonEmpty

Returns true since this collection is know to be non-empty

Definition

nonEmpty(): true;

example

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

Overrides

VariantSetBase.nonEmpty, NonEmpty.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

slice

Returns a SortedSet containing only those values that are within the given keyRange.

Definition

slice(range: Range<T>): SortedSet<T>;

Parameters

Name	Type	Description
range	Range<T>	a Range defining the values to include

example

const m = SortedSet.of('b', 'd', 'a', 'c').asNormal();
console.log(m.slice({ start: 'b', end: 'c' }).toArray())
// => ['b', 'c']

Overrides

SortedSet.slice

sliceIndex

Returns a SortedSet containing only those values that are within the given range index range of the value sort order.

Definition

sliceIndex(range: IndexRange): SortedSet<T>;

Parameters

Name	Type	Description
range	IndexRange	an IndexRange defining the sort order indices to include.

example

const m = SortedSet.of('b', 'd', 'a', 'c').asNormal();
console.log(m.sliceIndex({ start: 1, amount: 2 }).toArray())
// => ['b', 'c']

Overrides

SortedSet.sliceIndex

stream

undocumented

Definition

stream(options?: {
      reversed?: boolean;
    }): Stream.NonEmpty<T>;

Parameters

Name	Type	Description
options	{       reversed?: boolean;     }

Overrides

NonEmpty.stream, NonEmpty.stream, SortedSet.stream

streamRange

Returns a Stream of sorted values of this collection within the given keyRange.

Definition

streamRange(range: Range<T>, options?: {
    reversed?: boolean;
  }): Stream<T>;

Parameters

Name	Type	Description
range	Range<T>
options	{     reversed?: boolean;   }	(optional) an object containing the following properties: - reversed: (default: false) when true will reverse the stream element order

example

const m = SortedSet.of('b', 'd', 'a', 'c');
console.log(m.streamRange({ start: 'b', end: 'c' }).toArray())
// => ['b', 'c']

Overrides

SortedSet.streamRange

streamSliceIndex

Returns a Stream of sorted values of this collection within the given range index range.

Definition

streamSliceIndex(range: IndexRange, options?: {
    reversed?: boolean;
  }): Stream<T>;

Parameters

Name	Type	Description
range	IndexRange	the range of values to include in the stream
options	{     reversed?: boolean;   }	(optional) an object containing the following properties: - reversed: (default: false) when true will reverse the stream element order

example

const m = SortedSet.of('b', 'd', 'a', 'c');
console.log(m.streamSliceIndex({ start: 1, amount: 2 }).toArray())
// => ['b', 'c']

Overrides

SortedSet.streamSliceIndex

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

take

undocumented

Definition

take<N extends number>(amount: N): 0 extends N ? SortedSet<T> : SortedSet.NonEmpty<T>;

Type parameters

Name	Constraints	Description
N	number

Parameters

Name	Type	Description
amount	N

Overrides

SortedSet.take

toArray

Returns a non-empty array containing all values in this collection.

Definition

toArray(): ArrayNonEmpty<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, NonEmpty.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.

Definition

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

Parameters

Name	Type	Description
other	StreamSource<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, NonEmpty.union