improved Javadoc

Change-Id: Ifaa959bee1d1df4b83626e328eb895e9129bc7d1
This commit is contained in:
Axel Uhl committed 2017-09-26 07:22:23 +02:00
1 parent b5ba5ff3a7
commit 8772f63b2f
3 files changed
+19 -2

No files matched your search

@@ -19,7 +19,8 @@ public interface DirectedGraph<T> {
* When cycles overlap, they are combined into {@link CycleCluster}s, each being
* {@link CycleCluster#getRepresentative() represented} by a dedicated node from that cluster.
* The cycle analysis on this graph can tell the individual {@link #getCycles() cycles}, whereas
* this method tells the combination of cycles into clusters based on their overlap.
* this method tells the combination of cycles into clusters based on their overlap. The result
* is also called "strongly-connected components."
*/
CycleClusters<T> getCycleClusters();
@@ -194,7 +194,10 @@ public class DirectedGraphImpl<T> implements DirectedGraph<T> {
/**
* A strongly connected component is a set of nodes such that all nodes in the set can be reached from any other
* node in the set by traversing existing graph edges, and where no other node exists outside that set that, when
* added, would still make a strongly connected component.
* added, would still make a strongly connected component.<p>
*
* See also http://algo2.iti.kit.edu/documents/AlgorithmenII_WS11/folien.pdf (pages 119 and following) for a
* description of the algorithm implemented here.
*
* @return cycle clusters; each {@link CycleCluster} is one strongly-connected component
*/