interface VariantMultiSet<T>

A type-variant immutable MultiSet of value type T. In the MultiSet, each value can occur multiple times. See the MultiSet documentation and the VariantMultiSet API documentation

Companion namespace: VariantMultiSet

Extends: VariantMultiSetBase<T,Tp>

Implemented by: VariantMultiSet.NonEmpty<T>

Type parameters

Name	Description
T	the value type

note

Type-variance means that both the value type can be widened in a type-safe way without casting. @note As a consequence of being variant, the type does not contain methods that (can) add new elements to the collection.

Properties

countMap

Returns the Map representation of this collection.

Definition

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

example

const m = HashMultiSet.of(1, 2, 2)
const map: HashMap.NonEmpty<number, number> = m.countMap

Overrides

VariantMultiSetBase.countMap

isEmpty

Returns true if the collection is empty.

Definition

readonly isEmpty: boolean;

example

HashMultiSet.empty<number>().isEmpty     // => true
HashMultiSet.of(1, 2, 2).isEmpty         // => false

Overrides

VariantMultiSetBase.isEmpty

size

Returns the number of values in the collection.

Definition

readonly size: number;

example

HashMultiSet.of(1, 2).size         // => 2
HashMultiSet.of(1, 2, 2).size      // => 3

Overrides

VariantMultiSetBase.size

sizeDistinct

Returns the number of distinct values in the collection.

Definition

readonly sizeDistinct: number;

example

HashMultiSet.of(1, 2).sizeDistinct       // => 2
HashMultiSet.of(1, 2, 2).sizeDistinct    // => 2

Overrides

VariantMultiSetBase.sizeDistinct

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]

assumeNonEmpty

Returns the collection as a .NonEmpty type

Definition

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

throws

RimbuError.EmptyCollectionAssumedNonEmptyError if the collection is empty

example

HashMultiSet.empty<number>().assumeNonEmpty()   // => throws
const m: HashMultiSet<number> = HashMultiSet.of(1, 2)
const m2: HashMultiSet.NonEmpty<number> = m     // => compiler error
const m3: HashMultiSet.NonEmpty<number> = m.assumeNonEmpty()

note

returns reference to this collection

Overrides

VariantMultiSetBase.assumeNonEmpty

count

Returns the amount of occurrances of the given value in the collection.

Definition

count<U = T>(value: RelatedTo<T, U>): number;

Type parameters

Name	Default	Description
U	T

Parameters

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

example

const m = HashMultiSet.of(1, 2, 2)
m.count(5)   // => 0
m.count(2)   // => 2

Overrides

VariantMultiSetBase.count

filterEntries

Returns the collection containing only those values for which the given pred function returns true.

Definitions

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

filterEntries<TF extends T>(pred: (entry: readonly [T, number], index: number) => entry is [TF, number], options: {
    negate: true;
  }): WithElem<Tp, Exclude<T, TF>>['normal'];

filterEntries(pred: (entry: readonly [T, number], index: number) => boolean, options?: {
    negate?: boolean;
  }): WithElem<Tp, T>['normal'];

Type parameters

Name	Constraints	Description
TF	T

Parameters

Name	Type	Description
pred	(entry: readonly [T, number], index: number) => entry is [TF, number]	a predicate function receiving: - entry: the next entry consisting of the value and its count - index: the entry index - halt: a function that, when called, ensures no next entries 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

HashMultiSet.of(1, 2, 2, 3)
.filterEntries(entry => entry[1] > 1)
.toArray()
// => [[2, 2]]

Overrides

VariantMultiSetBase.filterEntries

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 value, receiving: - value: the next value - index: the index of the value - halt: a function that, if called, ensures that no new values are passed
options	{     state?: TraverseState;   }	(optional) an object containing the following properties: - state: (optional) the traversal state

example

HashMultiSet.of(1, 2, 2, 3).forEach((entry, i, halt) => {
console.log(entry)
if (i >= 1) halt()
})
// => logs [1, 1]  [2, 2]

Overrides

VariantMultiSetBase.forEach

has

Returns true if the given value exists 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

const m = HashMultiSet.of(1, 2, 2)
m.has(5)   // => false
m.has(2)   // => true

Overrides

VariantMultiSetBase.has

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: HashMultiSet<number> = HashMultiSet.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

VariantMultiSetBase.nonEmpty

remove

Returns the collection where the given amount (default: 'ALL') of the given value are removed.

Definition

remove<U = T>(value: RelatedTo<T, U>, options?: {
    amount?: number | 'ALL';
  }): WithElem<Tp, T>['normal'];

Type parameters

Name	Default	Description
U	T

Parameters

Name	Type	Description
value	RelatedTo<T, U>	the value to remove
options	{     amount?: number | 'ALL';   }	(optional) an object containing the following properties: - amount: (default: 'ALL') the amount of values to remove, or 'ALL' to remove all values.

example

const m = HashMultiSet.of(1, 2, 2)
m.remove(5).toArray()     // => [1, 2, 2]
m.remove(2).toArray()     // => [1]
m.remove(2, 1).toArray()  // => [1, 2]

Overrides

VariantMultiSetBase.remove

removeAllEvery

Returns the collection where for every value from given values StreamSource, all values in the collection are removed.

Definition

removeAllEvery<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

const m = HashMultiSet.of(1, 2, 2)
m.removeAllEvery([5, 6]).toArray()    // => [1, 2, 2]
m.removeAllEvery([2, 3]).toArray()    // => [1]

Overrides

VariantMultiSetBase.removeAllEvery

removeAllSingle

Returns the collection where every single value from given values StreamSource is removed.

Definition

removeAllSingle<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

const m = HashMultiSet.of(1, 2, 2)
m.removeAllSingle([5, 6]).toArray()    // => [1, 2, 2]
m.removeAllSingle([2, 3]).toArray()    // => [1, 2]
m.removeAllSingle([2, 3, 2]).toArray() // => [1]

Overrides

VariantMultiSetBase.removeAllSingle

stream

Returns a Stream containing all values of this collection.

Definition

stream(): Stream<T>;

example

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

Overrides

VariantMultiSetBase.stream

streamDistinct

Returns a Stream containing all distinct values of this collection.

Definition

streamDistinct(): Stream<T>;

example

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

Overrides

VariantMultiSetBase.streamDistinct

toArray

Returns an array containing all values in this collection.

Definition

toArray(): T[];

example

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

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

VariantMultiSetBase.toArray

toJSON

Returns a JSON representation of this collection.

Definition

toJSON(): ToJSON<(readonly [T, number])[]>;

example

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

Overrides

VariantMultiSetBase.toJSON

toString

Returns a string representation of this collection.

Definition

toString(): string;

example

HashMultiSet.of(1, 2, 2).toString()  // => HashMultiSet(1, 2, 2)

Overrides

VariantMultiSetBase.toString