Skip to main content

namespace ArrowGraph

An type-invariant immutable arrow (directed) graph. See the Graph documentation and the ArrowGraph API documentation

Companion interface: ArrowGraph<N>

Interfaces

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

Static Methods

createContext

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

Definition

createContext<UN>(options: {
    linkMapContext: RMap.Context<UN>;
    linkConnectionsContext: RSet.Context<UN>;
  }): ArrowGraph.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