Package ai.timefold.solver.core.impl.domain.variable.declarative

Class DefaultTopologicalOrderGraph

java.lang.Object

ai.timefold.solver.core.impl.domain.variable.declarative.DefaultTopologicalOrderGraph

All Implemented Interfaces:

BaseTopologicalOrderGraph, TopologicalOrderGraph

public class DefaultTopologicalOrderGraph
extends Object
implements TopologicalOrderGraph

Nested Class Summary

Nested classes/interfaces inherited from interface ai.timefold.solver.core.impl.domain.variable.declarative.BaseTopologicalOrderGraph

BaseTopologicalOrderGraph.NodeTopologicalOrder

Nested classes/interfaces inherited from interface ai.timefold.solver.core.impl.domain.variable.declarative.TopologicalOrderGraph

TopologicalOrderGraph.EdgeConsumer

Constructor Summary

Constructors

Constructor	Description
DefaultTopologicalOrderGraph(int size)

Method Summary

Modifier and Type	Method	Description
void	addEdge(int fromNode, int toNode)	Called when a graph edge is added.
void	commitChanges(BitSet changed)	Called when all edge modifications are queued.
void	forEachEdge(TopologicalOrderGraph.EdgeConsumer edgeConsumer)
BaseTopologicalOrderGraph.NodeTopologicalOrder	getTopologicalOrder(int node)	Returns a tuple containing node ID and a number corresponding to its topological order.
boolean	isLooped(LoopedTracker loopedTracker, int node)	Returns true if a given node is in a strongly connected component with a size greater than 1 (i.e. is in a loop) or is a transitive successor of a node with the above property.
PrimitiveIterator.OfInt	nodeForwardEdges(int fromNode)	Return an iterator of the nodes that have the `from` node as a predecessor.
void	removeEdge(int fromNode, int toNode)	Called when a graph edge is removed.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ai.timefold.solver.core.impl.domain.variable.declarative.TopologicalOrderGraph

withNodeData

Constructor Details

DefaultTopologicalOrderGraph

public DefaultTopologicalOrderGraph(int size)

Method Details

addEdge

public void addEdge(int fromNode,
 int toNode)

Description copied from interface: TopologicalOrderGraph

Called when a graph edge is added. The operation is added to a batch and only executed when TopologicalOrderGraph.commitChanges(BitSet) is called.

BaseTopologicalOrderGraph.getTopologicalOrder(int) is allowed to be invalid when this method returns.

Specified by:

addEdge in interface TopologicalOrderGraph

removeEdge

public void removeEdge(int fromNode,
 int toNode)

Description copied from interface: TopologicalOrderGraph

Called when a graph edge is removed. The operation is added to a batch and only executed when TopologicalOrderGraph.commitChanges(BitSet) is called.

BaseTopologicalOrderGraph.getTopologicalOrder(int) is allowed to be invalid when this method returns.

Specified by:

removeEdge in interface TopologicalOrderGraph

forEachEdge

public void forEachEdge(TopologicalOrderGraph.EdgeConsumer edgeConsumer)

Specified by:

forEachEdge in interface TopologicalOrderGraph

nodeForwardEdges

public PrimitiveIterator.OfInt nodeForwardEdges(int fromNode)

Description copied from interface: BaseTopologicalOrderGraph

Return an iterator of the nodes that have the `from` node as a predecessor.

Specified by:

nodeForwardEdges in interface BaseTopologicalOrderGraph

Parameters:

fromNode - The predecessor node.

Returns:

an iterator of nodes with from as a predecessor.

isLooped

public boolean isLooped(LoopedTracker loopedTracker,
 int node)

Description copied from interface: BaseTopologicalOrderGraph

Returns true if a given node is in a strongly connected component with a size greater than 1 (i.e. is in a loop) or is a transitive successor of a node with the above property.

Specified by:

isLooped in interface BaseTopologicalOrderGraph

Parameters:

loopedTracker - a tracker that can be used to record looped state to avoid recomputation.

node - The node being queried

Returns:

true if `node` is in a loop, false otherwise.

getTopologicalOrder

public BaseTopologicalOrderGraph.NodeTopologicalOrder getTopologicalOrder(int node)

Description copied from interface: BaseTopologicalOrderGraph

Returns a tuple containing node ID and a number corresponding to its topological order. In particular, after TopologicalOrderGraph.commitChanges(java.util.BitSet) is called, the following must be true for any pair of nodes A, B where:

• A is a predecessor of B
• `isLooped(A) == isLooped(B) == false`

getTopologicalOrder(A) < getTopologicalOrder(B)

Said number may not be unique.

Specified by:

getTopologicalOrder in interface BaseTopologicalOrderGraph

commitChanges

public void commitChanges(BitSet changed)

Description copied from interface: TopologicalOrderGraph

Called when all edge modifications are queued. After this method returns, BaseTopologicalOrderGraph.getTopologicalOrder(int) must be accurate for every node in the graph.

Specified by:

commitChanges in interface TopologicalOrderGraph

toString

public String toString()

Overrides:

toString in class Object