interface ArrowGraph.Context<UN>

The ArrowGraph's Context instance that serves as a factory for all related immutable instances and builders.

Extends: ArrowGraphBase.Context<UN,Tp>

Type parameters

Name	Description
UN	the upper type limit for node types for which this context can create instances

Properties

_fixedType

undocumented

Definition

readonly _fixedType: UN;

Overrides

Context._fixedType

isDirected

undocumented

Definition

readonly isDirected: true;

Overrides

Context.isDirected

linkConnectionsContext

The context instance used to create internal connection collections

Definition

readonly linkConnectionsContext: WithGraphValues<Tp, UN, unknown>['linkConnectionsContext'];

Overrides

Context.linkConnectionsContext

linkMapContext

The context instance used to create internal link maps

Definition

readonly linkMapContext: WithGraphValues<Tp, UN, unknown>['linkMapContext'];

Overrides

Context.linkMapContext

typeTag

A string tag defining the specific collection type

Definition

readonly typeTag: string;

example

ArrowGraphHashed.defaultContext().typeTag   // => 'ArrowGraphHashed'

Overrides

Context.typeTag

Methods

builder

Returns an empty builder instance.

Definition

builder<N extends UN>(): WithGraphValues<Tp, N, unknown>['builder'];

Type parameters

Name	Constraints	Description
N	UN

example

ArrowValuedGraphHashed.builder<number, string>()    // => ArrowValuedGraphHashed.Builder<number, string>

Overrides

Factory.builder

empty

Returns the (singleton) empty instance of this type and context with given key and value types.

Definition

empty<N extends UN>(): WithGraphValues<Tp, N, unknown>['normal'];

Type parameters

Name	Constraints	Description
N	UN

example

ArrowGraphHashed.empty<number>()    // => ArrowGraphHashed<number>
ArrowGraphHashed.empty<string>()    // => ArrowGraphHashed<string>

Overrides

Factory.empty

from

Returns an immutable valued Graph, containing the graph elements from each of the given sources.

Definitions

from<N extends UN>(...sources: ArrayNonEmpty<StreamSource.NonEmpty<GraphElement<N>>>): WithGraphValues<Tp, N, unknown>['nonEmpty'];

from<N extends UN>(...sources: ArrayNonEmpty<StreamSource<GraphElement<N>>>): WithGraphValues<Tp, N, unknown>['normal'];

Type parameters

Name	Constraints	Description
N	UN

Parameters

Name	Type	Description
sources	ArrayNonEmpty<StreamSource.NonEmpty<GraphElement<N>>>	an array of StreamSource instances containing graph elements to add

example

ArrowGraphHashed.from([[1], [2]], [[3, 4]])  // => ArrowGraphHashed.NonEmpty<number>

Overrides

Factory.from

of

Returns an immutable valued Graph instance containing the graph elements from the given graphElements.

Definition

of<N extends UN>(...graphElements: ArrayNonEmpty<GraphElement<N>>): WithGraphValues<Tp, N, unknown>['nonEmpty'];

Type parameters

Name	Constraints	Description
N	UN

Parameters

Name	Type	Description
graphElements	ArrayNonEmpty<GraphElement<N>>	a non-empty array of graph elements that are either a single tuple containing a node, or a triplet containing two connection nodes and the connection value.

example

ArrowGraphHashed.of([1], [2], [3, 4]) // => ArrowGraphHashed.NonEmpty<number>

Overrides

Factory.of

reducer

Returns a Reducer that adds received graph elements to a Graph and returns the Graph as a result. When a source is given, the reducer will first create a graph from the source, and then add graph elements to it.

Definition

reducer<N extends UN>(source?: StreamSource.NonEmpty<GraphElement<N>>): Reducer<GraphElement<N>, WithGraphValues<Tp, N, unknown>['normal']>;

Type parameters

Name	Constraints	Description
N	UN

Parameters

Name	Type	Description
source	StreamSource.NonEmpty<GraphElement<N>>	(optional) an initial source of graph elements to add to

example

const someSource: GraphElement<number>[] = [[1, 2], [3], [5]];
const result = Stream.of([1, 3], [4, 3]).reduce(ArrowGraphSorted.reducer(someSource))
result.toArray()   // => [[1, 2], [1, 3], [4, 3], [5]]

note

uses a builder under the hood. If the given source is a Graph in the same context, it will directly call .toBuilder().

Overrides

Factory.reducer