class MultiSetNonEmpty<T,Tp,TpG>

undocumented

Extends: NonEmptyBase<E>

Implements: MultiSetBase.NonEmpty<T,Tp>

Type parameters

Name	Constraints	Default	Description
T			undocumented
Tp	ContextImplTypes		undocumented
TpG	WithElem<Tp, T>	WithElem<Tp, T>	undocumented

Properties

_NonEmptyType

undocumented

Definition

_NonEmptyType: TpG['nonEmpty'];

Overrides

NonEmptyBase._NonEmptyType

context

undocumented

Definition

readonly context: TpG['context'];

Overrides

MultiSetBase.context

countMap

undocumented

Definition

readonly countMap: TpG['countMapNonEmpty'];

Overrides

NonEmpty.countMap

isEmpty

Returns false since the collection is known to be non-empty.

Definition

get isEmpty(): false;

Overrides

NonEmptyBase.isEmptyNonEmpty.isEmpty

size

undocumented

Definition

readonly size: number;

Overrides

VariantMultiSetBase.size

sizeDistinct

undocumented

Definition

get sizeDistinct(): number;

Overrides

VariantMultiSetBase.sizeDistinct

Methods

[Symbol.iterator]

Returns a fast iterator over the elements of the collection.

Definition

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

Overrides

NonEmptyBase.[Symbol.iterator], FastIterable.[Symbol.iterator]

add

undocumented

Definition

add(elem: T, amount?: number): WithElem<Tp, T>['nonEmpty'];

Parameters

Name	Type	Description
elem	T
amount	number

Overrides

NonEmpty.add

addAll

undocumented

Definition

addAll(values: StreamSource<T>): TpG['nonEmpty'];

Parameters

Name	Type	Description
values	StreamSource<T>

Overrides

NonEmpty.addAll

addEntries

undocumented

Definition

addEntries(entries: StreamSource<readonly [T, number]>): TpG['nonEmpty'];

Parameters

Name	Type	Description
entries	StreamSource<readonly [T, number]>

Overrides

NonEmpty.addEntries

asNormal

Returns this typed as a possibly-empty collection type.

Definition

asNormal(): any;

Overrides

NonEmptyBase.asNormal, NonEmpty.asNormal

assumeNonEmpty

undocumented

Definition

assumeNonEmpty(): any;

Overrides

NonEmptyBase.assumeNonEmpty, VariantMultiSetBase.assumeNonEmpty

copy

undocumented

Definition

copy(countMap: TpG['countMapNonEmpty'], size: number): TpG['nonEmpty'];

Parameters

Name	Type	Description
countMap	TpG['countMapNonEmpty']
size	number

copyE

undocumented

Definition

copyE(countMap: TpG['countMap'], size: number): TpG['normal'];

Parameters

Name	Type	Description
countMap	TpG['countMap']
size	number

count

undocumented

Definition

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

Type parameters

Name	Description
U

Parameters

Name	Type	Description
elem	RelatedTo<T, U>

Overrides

VariantMultiSetBase.count

filterEntries

undocumented

Definition

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

Parameters

Name	Type	Description
pred	(entry: readonly [T, number], index: number) => boolean
options	{     negate?: boolean | undefined;   }

Overrides

VariantMultiSetBase.filterEntries

forEach

undocumented

Definition

forEach(f: (value: T, index: number, halt: () => void) => void, options?: {
    reversed?: boolean;
    state?: TraverseState;
  }): void;

Parameters

Name	Type	Description
f	(value: T, index: number, halt: () => void) => void
options	{     reversed?: boolean;     state?: TraverseState;   }

Overrides

VariantMultiSetBase.forEach

has

undocumented

Definition

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

Type parameters

Name	Description
U

Parameters

Name	Type	Description
elem	RelatedTo<T, U>

Overrides

VariantMultiSetBase.has

modifyCount

undocumented

Definition

modifyCount(value: T, update: (currentCount: number) => number): TpG['normal'];

Parameters

Name	Type	Description
value	T
update	(currentCount: number) => number

Overrides

MultiSetBase.modifyCount

nonEmpty

Returns true and instructs the compiler to treat the instance as non-empty.

Definition

nonEmpty(): this is this['_NonEmptyType'];

Overrides

NonEmptyBase.nonEmpty, NonEmpty.nonEmpty

remove

undocumented

Definition

remove<U>(elem: RelatedTo<T, U>, options?: {
    amount?: number | 'ALL';
  }): TpG['normal'];

Type parameters

Name	Description
U

Parameters

Name	Type	Description
elem	RelatedTo<T, U>
options	{     amount?: number | 'ALL';   }

Overrides

VariantMultiSetBase.remove

removeAllEvery

undocumented

Definition

removeAllEvery<U>(elems: StreamSource<RelatedTo<T, U>>): TpG['normal'];

Type parameters

Name	Description
U

Parameters

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

Overrides

VariantMultiSetBase.removeAllEvery

removeAllSingle

undocumented

Definition

removeAllSingle<U>(elems: StreamSource<RelatedTo<T, U>>): TpG['normal'];

Type parameters

Name	Description
U

Parameters

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

Overrides

VariantMultiSetBase.removeAllSingle

setCount

undocumented

Definition

setCount(elem: T, amount: number): TpG['normal'];

Parameters

Name	Type	Description
elem	T
amount	number

Overrides

MultiSetBase.setCount

stream

undocumented

Definition

stream(): Stream.NonEmpty<T>;

Overrides

NonEmptyBase.stream, NonEmpty.stream

streamDistinct

undocumented

Definition

streamDistinct(): Stream.NonEmpty<T>;

Overrides

NonEmpty.streamDistinct

toArray

undocumented

Definition

toArray(): ArrayNonEmpty<T>;

Overrides

NonEmpty.toArray

toBuilder

undocumented

Definition

toBuilder(): TpG['builder'];

Overrides

MultiSetBase.toBuilder

toJSON

undocumented

Definition

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

Overrides

VariantMultiSetBase.toJSON

toString

undocumented

Definition

toString(): string;

Overrides

VariantMultiSetBase.toString