Class GraphAnalysis

The GraphAnalysis class provides methods and properties to analyze a Graph.

Index

Constructors

Properties

Methods

findShortestPath getConnectedNodes isCyclic isNodeConnectedToRoot

Constructors

constructor

new GraphAnalysis(graph: Graph): GraphAnalysis
Parameters
- graph: Graph
Returns GraphAnalysis

Properties

`Readonly`graph

graph: Graph

Methods

`Static`findShortestPath

findShortestPath(
start: ImmutableGraphNode,
end: ImmutableGraphNode,
): ImmutableGraphNode[]
Finds the shortest path between two nodes using BFS.
Parameters
- start: ImmutableGraphNode
  The starting GraphNode instance.
- end: ImmutableGraphNode
  The ending GraphNode instance.
Returns ImmutableGraphNode[]
An array representing the shortest path.

`Static`getConnectedNodes

getConnectedNodes(node: ImmutableGraphNode): Set<ImmutableGraphNode>
Creates an exhaustive set of all GraphNode instances that are connected to the input node. Both input pins are outputs are visited.
Parameters
- node: ImmutableGraphNode
  The input GraphNode instance.
Returns Set<ImmutableGraphNode>
A set of connected GraphNode instances.

`Static`isCyclic

isCyclic(node: ImmutableGraphNode): boolean
Detects if the specified node is part of a cycle in the graph.
Parameters
- node: ImmutableGraphNode
  The input GraphNode.
Returns boolean
True if the node is part of a cycle, otherwise false.

`Static`isNodeConnectedToRoot

isNodeConnectedToRoot(
node: ImmutableGraphNode,
root: ImmutableGraphNode,
): boolean
Determines if the specified node is connected to the root node by traversing the pin input connections.
Parameters
- node: ImmutableGraphNode
  The node to check for connection to the root.
- root: ImmutableGraphNode
  The root GraphNode to start the traversal from.
Returns boolean
true if the node is connected to the root, otherwise false.