graph-builder/dist/graph/MutableGraph.d.ts

A graph builder library for modeling abstract graph structures.

import { Graph } from "./Graph";
import { EndpointPair } from "./EndpointPair";
/**
 * A subinterface of {@link Graph} which adds mutation methods. When mutation is not required, users
 * should prefer the {@link Graph} interface.
 *
 * @public
 */
export interface MutableGraph<N> extends Graph<N> {
    /**
     * Adds `node` if it is not already present.
     *
     * <b>Nodes must be unique</b>, just as `Map` keys must be.
     *
     * @returns `true` if the graph was modified as a result of this call
     */
    addNode(node: N): boolean;
    /**
     * Adds an edge connecting `nodeU` to `nodeV` if one is not already present.
     *
     * If the graph is directed, the resultant edge will be directed; otherwise, it will be
     * undirected.
     *
     * If `nodeU` and `nodeV` are not already present in this graph, this method will
     * silently {@link MutableGraph.addNode} `nodeU` and `nodeV` to the graph.
     *
     * Throws if the introduction of the edge would violate {@link BaseGraph.allowsSelfLoops}.
     *
     * @returns `true` if the graph was modified as a result of this call
     */
    putEdge(nodeU: N, nodeV: N): boolean;
    /**
     * Adds an edge connecting `endpoints` (in the order, if any, specified by
     * `endpoints` if one is not already present.
     *
     * If this graph is directed, `endpoints` must be ordered and the added edge will be
     * directed; if it is undirected, the added edge will be undirected.
     *
     * If this graph is directed, `endpoints` must be ordered.
     *
     * If either or both endpoints are not already present in this graph, this method will silently
     * {@link MutableGraph.addNode} each missing endpoint to the graph.
     *
     * Throws if the introduction of the edge would violate {@link BaseGraph.allowsSelfLoops}.
     *
     * Throws if the endpoints are unordered and the graph is directed.
     *
     * @returns `true` if the graph was modified as a result of this call
     */
    putEdgeConnectingEndpoints(endpoints: EndpointPair<N>): boolean;
    /**
     * Removes `node` if it is present; all edges incident to `node` will also be removed.
     *
     * @returns `true` if the graph was modified as a result of this call
     */
    removeNode(node: N): boolean;
    /**
     * Removes the edge connecting `nodeU` to `nodeV`, if it is present.
     *
     * @returns `true` if the graph was modified as a result of this call
     */
    removeEdge(nodeU: N, nodeV: N): boolean;
    /**
     * Removes the edge connecting `endpoints`, if it is present.
     *
     * If this graph is directed, `endpoints` must be ordered.
     *
     * Throws if the endpoints are unordered and the graph is directed.
     *
     * @returns `true` if the graph was modified as a result of this call
     */
    removeEdgeConnectingEndpoints(endpoints: EndpointPair<N>): boolean;
}