commonMain.com.toxicbakery.kfinstatemachine.graph.IDirectedGraph.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graph-js Show documentation

Kotlin library for creating finite state machines.

The newest version!

package com.toxicbakery.kfinstatemachine.graph

/**
 * Directed graph that defines nodes and edges.
 */
interface IDirectedGraph {

    /**
     * All of the nodes defined in the graph.
     */
    val nodes: Set

    /**
     * Edges defined by a node.
     */
    fun edges(
        node: N,
        defaultValue: () -> Map = { throw Exception("Node not in graph.") }
    ): Map

    /**
     * Transitions available to a specific node.
     */
    fun transitions(node: N): Set

}