Class ReactionGraph

toString

addAll

• addAll(pg): void

• Add all the nodes and edges from the given precedence graph to this one.

  Parameters

  • pg: this

    A precedence graph

  Returns void

addEdge

• addEdge(upstream, downstream): void

• Add an edge from an upstream node to a downstream one.

  Parameters

  • upstream: Reaction<Variable[]>

    The node at which the directed edge starts.
  • downstream: Reaction<Variable[]>

    The node at which the directed edge ends.

  Returns void

addNode

• addNode(node): void

• Add the given node to this graph.

  Parameters

  • node: Reaction<Variable[]>

  Returns void

getDownstreamNeighbors

• getDownstreamNeighbors(node): Set<Reaction<Variable[]>>

• Return the set of all downstream neighbors of the given node.

  Parameters

  • node: Reaction<Variable[]>

    The node to retrieve the outgoing nodes of.

  Returns Set<Reaction<Variable[]>>

getNodes

• getNodes(): IterableIterator<Reaction<Variable[]>>

• Return an iterator over the nodes in the graph.

  Returns IterableIterator<Reaction<Variable[]>>

getSinkNodes

• getSinkNodes(): Set<Reaction<Variable[]>>

• Return the nodes in the graph that have no downstream neighbors.

  Returns Set<Reaction<Variable[]>>

getSourceNodes

• getSourceNodes(): Set<Reaction<Variable[]>>

• Return the nodes in the graph that have no upstream neighbors.

  Returns Set<Reaction<Variable[]>>

getUpstreamNeighbors

• getUpstreamNeighbors(node): Set<Reaction<Variable[]>>

• Return the set of all upstream neighbors of the given node.

  Parameters

  • node: Reaction<Variable[]>

    The node to retrieve the incoming nodes of.

  Returns Set<Reaction<Variable[]>>

hasCycle

• hasCycle(): boolean

• Return true if the graph has a cycle in it.

  Returns boolean

removeEdge

• removeEdge(upstream, downstream): void

• Remove a directed edge from an upstream node to a downstream one.

  Parameters

  • upstream: Reaction<Variable[]>

    The node at which the directed edge starts.
  • downstream: Reaction<Variable[]>

    The node at which the directed edge ends.

  Returns void

removeNode

• removeNode(node): void

• Remove the given node from the graph.

  Parameters

  • node: Reaction<Variable[]>

    The node to remove.

  Returns void

size

• size(): [number, number]

• Return the size of the graph in terms of number of nodes and edges.

  Returns [number, number]

toDotString

• toDotString(): string

• Return a DOT representation of the graph.

  Returns string

toMermaidString

• toMermaidString(edgesWithIssue?): string

• Return a representation that conforms with the syntax of mermaid.js

  Parameters

  • OptionaledgesWithIssue: [Reaction<Variable[]>, Reaction<Variable[]>][]

    An array containing arrays with [origin, effect]. Denotes edges in the graph that causes issues to the execution, will be visualized as --x in mermaid.

  Returns string

updatePriorities

• updatePriorities(destructive?, spacing?): boolean

• Assign priorities to the nodes of the graph such that any two nodes of which one has precedence over the other, the priority of the one node is lower than the other.

  Parameters

  • destructive: boolean = false

    Destroy the graph structure if true, leave it in tact by working on a copy if false (the default).
  • spacing: number = 100

    The minimum spacing between the priorities of two nodes that are in a precedence relationship. The default is 100.

  Returns boolean

  True if priorities were assigned successfully, false if the graph has one or more cycles.