Changeset 1401 for trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskInstanceTrie.java

Timestamp:

02/26/14 17:12:53 (10 years ago)

Author:

pharms

Message:

• added some JavaDoc? comments

File:

• trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskInstanceTrie.java (modified) (11 diffs)

trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskInstanceTrie.java

@@ -29 +29 @@
 /**
  * <p>
- * TODO comment
+ * This trie implementation is a performance optimization for generating task trees. It does not
+ * create a full trie but adds only those subsequences having a chance of occurring most often.
+ * For this, it initially counts the number of occurrences of each task instance. Then, during
+ * training, it regularly determines the number of the currently most often occurring sequence. If
+ * this number is higher than the count of a task instance to be trained, the task instance is
+ * skipped the not added to the trie.
  * </p>
  * 
@@ -41 +46 @@
     /**
      * <p>
-     * the task comparator to be used for comparing tasks
+     * the task handling strategy to be used for comparing tasks
      * </p>
      */
@@ -48 +53 @@
     /**
      * <p>
-     * TODO: comment
+     * instantiated the trie with the task handling strategy to be used
      * </p>
      *
-     * @param taskComparator2
+     * @param taskStrategy the task handling strategy to be used for comparing tasks
      */
     public TaskInstanceTrie(TaskHandlingStrategy taskStrategy) {
@@ -59 +64 @@
 
     /**
-     *
+     * <p>
+     * trains this trie with the provided user sessions up to the provided maximum depth using
+     * the optimization described in the description of this class.
+     * </p>
+     * 
+     * @param userSessions the sessions for which this trie is to be trained
+     * @param maxOrder     the depth of the trie
      */
     public void trainSessions(List<IUserSession> userSessions, int maxOrder) {
@@ -125 +136 @@
 
     /**
-     * 
+     * <p>
+     * internally used convenience method for implementing the training optimization
+     * </p>
      */
     private void train(IUserSession        userSession,
@@ -133 +146 @@
                        int                 counterRecheckAt)
     {
-        List<ITaskInstance> executedTasks = userSession.getExecutedTasks();
-        
         List<ITaskInstance> subsequence = new LinkedList<ITaskInstance>();
         
         int sequenceMaxCount = 0;
         
-        for (ITaskInstance currentTaskInstance : executedTasks) {
+        for (ITaskInstance currentTaskInstance : userSession) {
             
             int occurrenceCount = taskInstanceCountMap.get(currentTaskInstance.getTask()).count;
@@ -181 +192 @@
     /**
      * <p>
-     * TODO: comment
+     * determines the current maximum count of sequences of a minimal length of two. Task instances
+     * occuring more seldom do not have to be considered anymore
      * </p>
      *
-     * @return
+     * @return the current maximum count of sequences of a minimal length of two
      */
     private int getCurrentSequenceMaxCount() {
@@ -193 +205 @@
 
     /**
+     * <p>
+     * trie processor identifying the current maximum count of sequences of a minimal length of two
+     * </p>
+     * 
      * @author Patrick Harms
      */
@@ -198 +214 @@
         
         /**
-         * 
+         * <p>
+         * the current maximum count
+         * </p>
          */
         private int currentCount = 0;
@@ -219 +237 @@
 
         /**
-         * 
+         * <p>
+         * returns the current maximum count
+         * </p>
          */
         private int getMaxCount() {
@@ -228 +248 @@
     
     /**
+     * <p>
+     * counter object to be able to call something by the counters reference
+     * </p>
+     * 
      * @author Patrick Harms
      */