class SortedSetLeaf<T>

undocumented

Extends: SortedSetNode<T>

Type parameters

Name	Description
T	undocumented

Properties

_NonEmptyType

undocumented

Definition

_NonEmptyType: SortedSetNode<T>;

Overrides

SortedSetNode._NonEmptyType

context

undocumented

Definition

readonly context: SortedSetContext<T>;

Overrides

SortedSetNode.context

entries

undocumented

Definition

entries: readonly T[];

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

undocumented

Definition

get size(): number;

Overrides

SortedSetNode.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): SortedSet.NonEmpty<T>;

Parameters

Name	Type	Description
value	T

example

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

Overrides

NonEmpty.add, SortedSetNode.add

addAll

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

Definition

addAll(values: StreamSource<T>): SortedSet.NonEmpty<T>;

Parameters

Name	Type	Description
values	StreamSource<T>

example

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

Overrides

NonEmpty.addAll, SortedSetNode.addAll

addInternal

undocumented

Definition

addInternal(value: T): SortedSetNode<T>;

Parameters

Name	Type	Description
value	T

Overrides

SortedSetNode.addInternal

asNormal

undocumented

Definition

asNormal(): this;

Overrides

SortedSetNode.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

copy

undocumented

Definition

copy(entries: readonly T[]): SortedSetLeaf<T>;

Parameters

Name	Type	Description
entries	readonly T[]

deleteMax

undocumented

Definition

deleteMax(): [T, SortedSetLeaf<T>];

deleteMin

undocumented

Definition

deleteMin(): [T, SortedSetLeaf<T>];

difference

undocumented

Definition

difference(other: StreamSource<T>): SortedSet<T>;

Parameters

Name	Type	Description
other	StreamSource<T>

Overrides

SortedSetNode.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

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, SortedSetNode.drop

dropInternal

undocumented

Definition

dropInternal(amount: number): SortedSetLeaf<T>;

Parameters

Name	Type	Description
amount	number

filter

undocumented

Definition

filter(pred: (value: T, index: number, halt: () => void) => boolean, options?: {
    negate?: boolean | undefined;
  }): any;

Parameters

Name	Type	Description
pred	(value: T, index: number, halt: () => void) => boolean
options	{     negate?: boolean | undefined;   }

Overrides

SortedSetNode.filter

forEach

undocumented

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

Overrides

SortedSetNode.forEach

getAtIndex

undocumented

Definition

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

Type parameters

Name	Description
O

Parameters

Name	Type	Description
index	number
otherwise	OptLazy<O>

Overrides

SortedSet.getAtIndex

getInsertIndexOf

undocumented

Definition

getInsertIndexOf(value: T): number;

Parameters

Name	Type	Description
value	T

Overrides

SortedSetNode.getInsertIndexOf

getSliceRange

undocumented

Definition

getSliceRange(range: Range<T>): {
    startIndex: number;
    endIndex: number;
  };

Parameters

Name	Type	Description
range	Range<T>

Overrides

SortedSetNode.getSliceRange

has

undocumented

Definition

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

Type parameters

Name	Description
U

Parameters

Name	Type	Description
value	RelatedTo<T, U>

Overrides

SortedSetNode.has

intersect

undocumented

Definition

intersect(other: StreamSource<T>): SortedSet<T>;

Parameters

Name	Type	Description
other	StreamSource<T>

Overrides

SortedSetNode.intersect

max

undocumented

Definition

max(): T;

Overrides

SortedSetNode.max

min

undocumented

Definition

min(): T;

Overrides

SortedSetNode.min

mutateGetFromLeft

undocumented

Definition

mutateGetFromLeft(left: SortedSetLeaf<T>, toMe: T): [T, SortedSetLeaf<T>];

Parameters

Name	Type	Description
left	SortedSetLeaf<T>
toMe	T

mutateGetFromRight

undocumented

Definition

mutateGetFromRight(right: SortedSetLeaf<T>, toMe: T): [T, SortedSetLeaf<T>];

Parameters

Name	Type	Description
right	SortedSetLeaf<T>
toMe	T

mutateGiveToLeft

undocumented

Definition

mutateGiveToLeft(left: SortedSetLeaf<T>, toLeft: T): [T, SortedSetLeaf<T>];

Parameters

Name	Type	Description
left	SortedSetLeaf<T>
toLeft	T

mutateGiveToRight

undocumented

Definition

mutateGiveToRight(right: SortedSetLeaf<T>, toRight: T): [T, SortedSetLeaf<T>];

Parameters

Name	Type	Description
right	SortedSetLeaf<T>
toRight	T

mutateJoinLeft

undocumented

Definition

mutateJoinLeft(left: SortedSetLeaf<T>, entry: T): void;

Parameters

Name	Type	Description
left	SortedSetLeaf<T>
entry	T

mutateJoinRight

undocumented

Definition

mutateJoinRight(right: SortedSetLeaf<T>, entry: T): void;

Parameters

Name	Type	Description
right	SortedSetLeaf<T>
entry	T

mutateSplitRight

undocumented

Definition

mutateSplitRight(index?: number): [T, SortedSetLeaf<T>];

Parameters

Name	Type	Description
index	number

nonEmpty

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

Definition

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

example

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

Overrides

VariantSetBase.nonEmpty, NonEmpty.nonEmpty

normalize

undocumented

Definition

normalize(): SortedSet<T>;

Overrides

SortedSetNode.normalize

remove

undocumented

Definition

remove<U>(value: RelatedTo<T, U>): SortedSet<T>;

Type parameters

Name	Description
U

Parameters

Name	Type	Description
value	RelatedTo<T, U>

Overrides

SortedSetNode.remove

removeAll

undocumented

Definition

removeAll<U>(values: StreamSource<RelatedTo<T, U>>): SortedSet<T>;

Type parameters

Name	Description
U

Parameters

Name	Type	Description
values	StreamSource<RelatedTo<T, U>>

Overrides

SortedSetNode.removeAll

removeInternal

undocumented

Definition

removeInternal(value: T): SortedSetNode<T>;

Parameters

Name	Type	Description
value	T

Overrides

SortedSetNode.removeInternal

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>

example

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

Overrides

SortedSet.slice, SortedSetNode.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

example

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

Overrides

SortedSet.sliceIndex, SortedSetNode.sliceIndex

stream

undocumented

Definition

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

Parameters

Name	Type	Description
options	{     reversed?: boolean;   }

Overrides

SortedSetNode.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;   }

example

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

Overrides

SortedSet.streamRange, SortedSetNode.streamRange

streamSliceIndex

undocumented

Definition

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

Parameters

Name	Type	Description
range	IndexRange
options	{     reversed?: boolean;   }

Overrides

SortedSetNode.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>): SortedSet<T>;

Parameters

Name	Type	Description
other	StreamSource<T>

example

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

Overrides

RSetBase.symDifference, SortedSetNode.symDifference

take

undocumented

Definition

take(amount: number): SortedSet<T> | any;

Parameters

Name	Type	Description
amount	number

Overrides

NonEmpty.take, SortedSetNode.take

takeInternal

undocumented

Definition

takeInternal(amount: number): SortedSetLeaf<T>;

Parameters

Name	Type	Description
amount	number

toArray

undocumented

Definition

toArray(): ArrayNonEmpty<T>;

Overrides

SortedSetNode.toArray

toBuilder

Returns a builder object containing the values of this collection.

Definition

toBuilder(): SortedSet.Builder<T>;

example

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

Overrides

RSetBase.toBuilder, SortedSetNode.toBuilder

toJSON

undocumented

Definition

toJSON(): ToJSON<T[]>;

Overrides

SortedSetNode.toJSON

toString

undocumented

Definition

toString(): string;

Overrides

SortedSetNode.toString

union

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

Definition

union(other: StreamSource<T>): SortedSet<T> | any;

Parameters

Name	Type	Description
other	StreamSource<T>

example

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

Overrides

NonEmpty.union, SortedSetNode.union