Skip to main content

namespace EdgeGraph

An type-invariant immutable edge (undirected) graph. See the Graph documentation and the EdgeGraph API documentation

Companion interface: EdgeGraph<N>

Interfaces

NameDescription
EdgeGraph.Builder<N>A mutable EdgeGraph builder used to efficiently create new immutable instances. See the Graph documentation and the EdgeGraph.Builder API documentation
EdgeGraph.Context<UN>The EdgeGraph's Context instance that serves as a factory for all related immutable instances and builders.
EdgeGraph.NonEmpty<N>A non-empty type-invariant immutable edge (undirected) graph.
EdgeGraph.TypesUtility interface that provides higher-kinded types for this collection.

Static Methods

createContext

Returns a new EdgeGraph context instance based on the given options.

Definition

createContext<UN>(options: {
    linkMapContext: RMap.Context<UN>;
    linkConnectionsContext: RSet.Context<UN>;
  }): EdgeGraph.Context<UN>;

Type parameters

NameDescription
UNthe upper node type for which the context can create instances

Parameters

NameTypeDescription
options{
    linkMapContext: RMap.Context<UN>;
    linkConnectionsContext: RSet.Context<UN>;
  }
an object containing the following properties:
- linkMapContext: the map context to use to maintain link maps
- linkConnectionsContext: the set context to use to maintain link connection maps