graphmatekt/graphMateKT.graphClasses/Graph

Graph

class Graph(debugTimeUse: Boolean = false) : BaseGraph<Any>

A general graph class that represents nodes of any datatype.

Any new node is given an ID upon creation, which is used to build an adjacency list. The class maintains internal maps between ID's and nodes and vice versa.

Example usage:

val graph = Graph()
graph.addEdge("A", "B", 5.0)
graph.addEdge("A", "C", 2.0)
graph.addEdge("C", "B", 1.0)
graph.shortestPathsFrom("A", "B")
// NOTE: visualizeGraph() requires the smartgraph.css and smartgraph.properties files to be added to the root of your project.
graph.visualizeGraph() // Find the needed files here: https://github.com/Norskeaksel/GraphMateKT

Parameters

debugTimeUse

If true, the time taken by each graph algorithm is printed to the standard error stream. Defaults to false.

Constructors

Graph

constructor(debugTimeUse: Boolean = false)

Functions

addEdge

fun addEdge(node1: Any, node2: Any, weight: Int)

Overloaded function that calls addEdge with weight converted to a double.

open override fun addEdge(node1: Any, node2: Any, weight: Double = 1.0)

Adds a directed edge from node1 to node2. Nodes that don't exist in the graph yet are created.

addNode

open override fun addNode(node: Any)

Adds the given node to the graph

allPairsShortestPaths

fun allPairsShortestPaths()

Executes the Floyd-Warshall algorithm on the graph to compute the shortest paths between all pairs of nodes.

bfs

fun bfs(startNode: Any, target: Any? = null, reset: Boolean = true, maxDistance: Double = Double.POSITIVE_INFINITY)

Overload of fun bfs(startNodes: List, target: T?, reset: Boolean, maxDistance: Double) that accepts a single starting node instead of a list of starting nodes

fun bfs(startNodes: List<Any>, target: Any? = null, reset: Boolean = true, maxDistance: Double = Double.POSITIVE_INFINITY)

Performs a Breadth-First Search, which finds the shortest path from the starting node to all other nodes, assuming the graph is unweighted (all edges have a weight of 1.0) It stores results that can be retrieved with the following functions:

clearEdges

fun clearEdges()

Removes all edges from the graph, including a rule defined by connectWithRule. Nodes and search results are kept.

connect

fun connect(node1: Any, node2: Any)

Connects two nodes in the graph, by calling addEdge(node1,node2) and addEdge(node2, node1)

fun connect(node1: Any, node2: Any, weight: Double)

Connects two nodes in the graph, by calling addEdge(node1,node2, weight) and addEdge(node2, node1, weight)

fun connect(node1: Any, node2: Any, weight: Int)

Overloaded function that calls connect with weight converted to a double.

connectWithRule

open override fun connectWithRule(getNeighbours: (node: Any) -> List<Any>)

Defines a rule for how each node is connected to its neighbors.

currentVisitedNodes

fun currentVisitedNodes(): List<Any>

depth

fun depth(): Int

Retrieves the depth of the graph from the most recent search operation

dfs

fun dfs(startNode: Any, reset: Boolean = true)

Performs a Depth-First Search, which finds all nodes that's reachable from the starting node. It stores results that can be retrieved with the following functions:

distanceFromUtoV

fun distanceFromUtoV(u: Any, v: Any): Double

Retrieves the shortest distance between two nodes in the graph.

distanceTo

fun distanceTo(node: Any): Double

Retrieves the distance to the specified node from the starting node of the most recent search operation (BFS, DFS, shortestPathsFrom).

edges

fun edges(): List<Triple<Any, Any, Double>>

fun edges(node: Any): List<Pair<Double, Any>>

Retrieves a list of edges connected to the specified node.

finalPath

fun finalPath(): List<Any>?

Retrieves the shortest path from the start to target node (if a target was specified) during the most recent search operation (BFS, shortestPathsFrom). After topologicalSort(), it holds the topological ordering.

forEachNeighbour

fun forEachNeighbour(node: Any, action: (Any) -> Unit)

Executes a given function on all the neighbours of a given node.

foundTarget

fun foundTarget(): Boolean

Checks if the target node was found during the most recent search operation (BFS, shortestPathsFrom).

furthestNode

fun furthestNode(): Any

Retrieves the node that is the farthest from the starting node in the most recent search operation (BFS, shortestPathsFrom).

getPath

fun getPath(target: Any): List<Any>?

Retrieves the path from the starting node to the specified target node based on the most recent search results.

maxDistance

fun maxDistance(): Double

Retrieves the maximum distance from the starting node to any other node after the most recent search operation (BFS, shortestPathsFrom).

minimumSpanningTree

fun minimumSpanningTree(): Pair<Double, Graph>

Computes the Minimum Spanning Tree (MST) of the graph using Prim's algorithm.

neighbours

fun neighbours(node: Any): List<Any>

Retrieves a list of the neighboring nodes of the specified node.

nodes

open override fun nodes(): List<Any>

nrOfEdges

fun nrOfEdges(): Int

nrOfPaths

fun nrOfPaths(startNode: Any, targetNode: Any, mod: Long = Long.MAX_VALUE): Long

Calculates the number of distinct paths from the starting node to the target node in the graph.

open fun print()

Prints the graph's adjacency list to the standard error stream.

printConnections

fun printConnections()

Prints which nodes each node is connected to, to the standard error stream.

resetSearchResults

fun resetSearchResults()

Clears the search results stored in the graph.

shortestPathsFrom

fun shortestPathsFrom(startNode: Any, target: Any? = null)

Performs Dijkstra's algorithm to find the shortest path from the starting node to all other nodes. It stores results that can be retrieved with the following functions:

size

fun size(): Int

stronglyConnectedComponents

open fun stronglyConnectedComponents(): List<List<Any>>

Identifies groups where each node is reachable from every other node in the group.

topologicalSort

open fun topologicalSort(): List<Any>

Builds an order of nodes so that the first nodes has no outgoing edges, then nodes with edges pointing to these and so on, assuming the graph is a Directed Acyclic Graph (DAG). This is done by running a DFS from each node and ordering the nodes by descending depth (post-order).

visitedNodes

fun visitedNodes(): List<Any>

visualizeGraph

fun <T : Any> BaseGraph<T>.visualizeGraph(isBidirectional: Boolean = false, finalPath: List<T> = finalPath() ?: emptyList(), screenTitle: String = "Graph visualizer (Click space to pause and resume)", animationTicTimeOverride: Double? = null, closeOnEnd: Boolean = false, startPaused: Boolean = false)

Visualizes the graph with Bruno Silva's JavaFXSmartGraph library.