javadoc

Author: Thomas Tschager

jgrapht-core/src/main/java/org/jgrapht/alg/CliqueMinimalSeparatorDecomposition.java

@@ -106,7 +106,7 @@ public class CliqueMinimalSeparatorDecomposition<V, E>
     /**
      * Setup a clique minimal separator decomposition on graph <code>g</code>.
      * 
-     * @param g
+     * @param g The graph to decompose.
      */
     public CliqueMinimalSeparatorDecomposition(SimpleGraph<V, E> g)
     {
@@ -205,7 +205,7 @@ public void computeMinimalTriangulation()
      * Get the vertex with the maximal label.
      * 
      * @param vertexLabels Map that gives a label for each vertex.
-     * @return
+     * @return Vertex with the maximal label.
      */
     private V getMaxLabelVertex(Map<V, Integer> vertexLabels)
     {
@@ -348,7 +348,7 @@ public boolean isChordal()
     /**
      * Get the fill edges generated by the triangulation.
      * 
-     * @return
+     * @return Set of fill edges.
      */
     public Set<E> getFillEdges()
     {
@@ -359,9 +359,9 @@ public Set<E> getFillEdges()
     }
 
     /**
-     * Get the minimal triangulation.
+     * Get the minimal triangulation of the graph.
      * 
-     * @return
+     * @return Triangulated graph.
      */
     public Graph<V, E> getMinimalTriangulation()
     {
@@ -375,7 +375,7 @@ public Graph<V, E> getMinimalTriangulation()
      * Get the generators of the separators of the triangulated graph, i.e. 
      * all vertices that generate a minimal separator of triangulated graph.
      * 
-     * @return
+     * @return List of generators.
      */
     public List<V> getGenerators()
     {
@@ -388,7 +388,7 @@ public List<V> getGenerators()
     /**
      * Get the minimal elimination ordering produced by the triangulation.
      * 
-     * @return
+     * @return The minimal elimination ordering.
      */
     public LinkedList<V> getMeo()
     {
@@ -414,7 +414,8 @@ public Map<Set<V>, Integer> getFullComponentCount()
     /**
      * Get the atoms generated by the decomposition.
      * 
-     * @return
+     * @return Set of atoms, where each atom is described as the set of its
+     *         vertices.
      */
     public Set<Set<V>> getAtoms()
     {
@@ -427,7 +428,8 @@ public Set<Set<V>> getAtoms()
     /**
      * Get the clique minimal separators.
      * 
-     * @return
+     * @return Set of separators, where each separator is described as the set
+     *         of its vertices.
      */
     public Set<Set<V>> getSeparators()
     {
@@ -440,7 +442,7 @@ public Set<Set<V>> getSeparators()
     /**
      * Get the original graph.
      * 
-     * @return
+     * @return Original graph.
      */
     public SimpleGraph<V, E> getGraph()
     {