Skip to main content

class ValuedGraphNonEmpty<N,V,Tp,TpG>

undocumented

Extends: NonEmptyBase<E>

Implements: ValuedGraphBase.NonEmpty<N,V,Tp>

Type parameters​

NameConstraintsDefaultDescription
Nundocumented
Vundocumented
TpValuedGraphTypesContextImplundocumented
TpGWithGraphValues<Tp, N, V>WithGraphValues<Tp, N, V>undocumented

Properties​

_NonEmptyType​

undocumented

Definition​

_NonEmptyType: TpG['nonEmpty'];

Overrides​

NonEmptyBase._NonEmptyType

connectionSize​

undocumented

Definition​

readonly connectionSize: number;

Overrides​

VariantGraphBase.connectionSize

context​

undocumented

Definition​

readonly context: TpG['context'];

Overrides​

ValuedGraphBase.context

isDirected​

undocumented

Definition​

readonly isDirected: boolean;

Overrides​

VariantGraphBase.isDirected

isEmpty​

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

Definition​

get isEmpty(): false;

Overrides​

NonEmptyBase.isEmptyNonEmpty.isEmpty

linkMap​

undocumented

Definition​

readonly linkMap: TpG['linkMapNonEmpty'];

Overrides​

NonEmpty.linkMap

nodeSize​

undocumented

Definition​

get nodeSize(): number;

Overrides​

VariantGraphBase.nodeSize

Methods​

[Symbol.iterator]​

Returns a fast iterator over the elements of the collection.

addNode​

undocumented

Definition​

addNode(node: N): TpG['nonEmpty'];

Parameters​

NameTypeDescription
nodeN

Overrides​

GraphConnect.addNode

addNodes​

undocumented

Definition​

addNodes(nodes: StreamSource<N>): TpG['nonEmpty'];

Parameters​

NameTypeDescription
nodesStreamSource<N>

Overrides​

GraphConnectNonEmpty.addNodes

asNormal​

undocumented

Definition​

asNormal(): any;

Overrides​

NonEmptyBase.asNormal, NonEmpty.asNormal

assumeNonEmpty​

undocumented

Definition​

assumeNonEmpty(): any;

Overrides​

NonEmptyBase.assumeNonEmpty, VariantGraphBase.assumeNonEmpty

connect​

undocumented

Definition​

connect(node1: N, node2: N, value: V): TpG['nonEmpty'];

Parameters​

NameTypeDescription
node1N
node2N
valueV

Overrides​

ValuedGraphBase.connect

connectAll​

undocumented

Definition​

connectAll(links: StreamSource<WithGraphValues<Tp, N, V>['link']>): TpG['nonEmpty'];

Parameters​

NameTypeDescription
linksStreamSource<WithGraphValues<Tp, N, V>['link']>

Overrides​

GraphConnectNonEmpty.connectAll

copy​

undocumented

Definition​

copy(linkMap: TpG['linkMapNonEmpty'], connectionSize: number): TpG['nonEmpty'];

Parameters​

NameTypeDescription
linkMapTpG['linkMapNonEmpty']
connectionSizenumber

copyE​

undocumented

Definition​

copyE(linkMap: TpG['linkMap'], connectionSize: number): TpG['normal'];

Parameters​

NameTypeDescription
linkMapTpG['linkMap']
connectionSizenumber

disconnect​

undocumented

Definition​

disconnect<UN = N>(node1: RelatedTo<N, UN>, node2: RelatedTo<N, UN>): TpG['nonEmpty'];

Type parameters​

NameDefaultDescription
UNN

Parameters​

NameTypeDescription
node1RelatedTo<N, UN>
node2RelatedTo<N, UN>

Overrides​

VariantGraphBase.disconnect

disconnectAll​

undocumented

Definition​

disconnectAll<UN = N>(links: StreamSource<Link<RelatedTo<N, UN>>>): TpG['nonEmpty'];

Type parameters​

NameDefaultDescription
UNN

Parameters​

NameTypeDescription
linksStreamSource<Link<RelatedTo<N, UN>>>

Overrides​

VariantGraphBase.disconnectAll

forEach​

undocumented

Definition​

forEach(f: (entry: ValuedGraphElement<N, V>, index: number, halt: () => void) => void, options?: {
    state?: TraverseState;
  }): void;

Parameters​

NameTypeDescription
f(entry: ValuedGraphElement<N, V>, index: number, halt: () => void) => void
options{
    state?: TraverseState;
  }

Overrides​

VariantGraphBase.forEach

getConnectionsFrom​

undocumented

Definition​

getConnectionsFrom<UN = N>(node1: RelatedTo<N, UN>): TpG['linkConnections'];

Type parameters​

NameDefaultDescription
UNN

Parameters​

NameTypeDescription
node1RelatedTo<N, UN>

Overrides​

ValuedGraphBase.getConnectionsFrom

getConnectionStreamFrom​

undocumented

Definition​

getConnectionStreamFrom<UN = N>(node1: RelatedTo<N, UN>): Stream<ValuedLink<N, V>>;

Type parameters​

NameDefaultDescription
UNN

Parameters​

NameTypeDescription
node1RelatedTo<N, UN>

Overrides​

VariantGraphBase.getConnectionStreamFrom

getConnectionStreamTo​

undocumented

Definition​

getConnectionStreamTo<UN = N>(node: RelatedTo<N, UN>): Stream<ValuedLink<N, V>>;

Type parameters​

NameDefaultDescription
UNN

Parameters​

NameTypeDescription
nodeRelatedTo<N, UN>

Overrides​

VariantGraphBase.getConnectionStreamTo

getValue​

undocumented

Definition​

getValue<UN, O>(node1: RelatedTo<N, UN>, node2: RelatedTo<N, UN>, otherwise?: OptLazy<O>): V | O;

Type parameters​

NameDescription
UN
O

Parameters​

NameTypeDescription
node1RelatedTo<N, UN>
node2RelatedTo<N, UN>
otherwiseOptLazy<O>

Overrides​

VariantValuedGraphBase.getValue

hasConnection​

undocumented

Definition​

hasConnection<UN = N>(node1: RelatedTo<N, UN>, node2: RelatedTo<N, UN>): boolean;

Type parameters​

NameDefaultDescription
UNN

Parameters​

NameTypeDescription
node1RelatedTo<N, UN>
node2RelatedTo<N, UN>

Overrides​

VariantGraphBase.hasConnection

hasNode​

undocumented

Definition​

hasNode<UN = N>(node: RelatedTo<N, UN>): boolean;

Type parameters​

NameDefaultDescription
UNN

Parameters​

NameTypeDescription
nodeRelatedTo<N, UN>

Overrides​

VariantGraphBase.hasNode

isSink​

undocumented

Definition​

isSink<UN = N>(node: RelatedTo<N, UN>): boolean;

Type parameters​

NameDefaultDescription
UNN

Parameters​

NameTypeDescription
nodeRelatedTo<N, UN>

isSource​

undocumented

Definition​

isSource<UN = N>(node: RelatedTo<N, UN>): boolean;

Type parameters​

NameDefaultDescription
UNN

Parameters​

NameTypeDescription
nodeRelatedTo<N, UN>

mapValues​

undocumented

Definition​

mapValues<V2>(mapFun: (value: V, node1: N, node2: N) => V2): WithGraphValues<Tp, N, V2>['nonEmpty'];

Type parameters​

NameDescription
V2

Parameters​

NameTypeDescription
mapFun(value: V, node1: N, node2: N) => V2

Overrides​

NonEmpty.mapValues

modifyAt​

undocumented

Definition​

modifyAt(node1: N, node2: N, options: {
    ifNew?: OptLazyOr<V, Token>;
    ifExists?: ((value: V, remove: Token) => V |Token)| V;
  }): TpG['nonEmpty'];

Parameters​

NameTypeDescription
node1N
node2N
options{
    ifNew?: OptLazyOr<V, Token>;
    ifExists?: ((value: V, remove: Token) => V |Token)| V;
  }

Overrides​

ValuedGraphBase.modifyAt

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

removeNode​

undocumented

Definition​

removeNode<UN = N>(node: RelatedTo<N, UN>): TpG['normal'];

Type parameters​

NameDefaultDescription
UNN

Parameters​

NameTypeDescription
nodeRelatedTo<N, UN>

Overrides​

VariantGraphBase.removeNode

removeNodes​

undocumented

Definition​

removeNodes<UN>(nodes: StreamSource<RelatedTo<N, UN>>): TpG['normal'];

Type parameters​

NameDescription
UN

Parameters​

NameTypeDescription
nodesStreamSource<RelatedTo<N, UN>>

Overrides​

VariantGraphBase.removeNodes

removeUnconnectedNodes​

undocumented

Definition​

removeUnconnectedNodes(): TpG['normal'];

Overrides​

VariantGraphBase.removeUnconnectedNodes

stream​

undocumented

Definition​

stream(): Stream.NonEmpty<ValuedGraphElement<N, V>>;

Overrides​

NonEmptyBase.stream, NonEmpty.stream

streamConnections​

undocumented

Definition​

streamConnections(): Stream<ValuedLink<N, V>>;

Overrides​

VariantGraphBase.streamConnections

streamNodes​

undocumented

Definition​

streamNodes(): Stream.NonEmpty<N>;

Overrides​

NonEmpty.streamNodes

toBuilder​

undocumented

Definition​

toBuilder(): TpG['builder'];

Overrides​

ValuedGraphBase.toBuilder

toJSON​

undocumented

Definition​

toJSON(): ToJSON<[N, (readonly [N, V])[]][]>;

Overrides​

VariantGraphBase.toJSON

toString​

undocumented

Definition​

toString(): string;

Overrides​

VariantGraphBase.toString