IDAStar iterator Javadoc improved. Close #97 [skip ci]

citiususc · Nov 8, 2014 · cd346c2 · cd346c2
1 parent 7f3676e
commit cd346c2
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/hipster-core/src/main/java/es/usc/citius/hipster/algorithm/IDAStar.java b/hipster-core/src/main/java/es/usc/citius/hipster/algorithm/IDAStar.java
@@ -74,6 +74,12 @@ private class StackFrameNode {
         }
     }
 
+    /**
+     * IDA iterator. It expands the next state to be explored. Backtracking
+     * is automatically performed so if the state reaches a dead-end the next
+     * call to {@code iterator.next()} returns the next state after performing
+     * backtracking.
+     */
     public class Iterator implements java.util.Iterator<N> {
         private Stack<StackFrameNode> stack = new Stack<StackFrameNode>();
         private C fLimit;