Changeset 101 for trunk/EventBenchCore/src/de/ugoe/cs/eventbench/models/HighOrderMarkovModel.java

Timestamp:

07/04/11 15:21:50 (13 years ago)

Author:

sherbold

Message:

• code documentation

File:

• trunk/EventBenchCore/src/de/ugoe/cs/eventbench/models/HighOrderMarkovModel.java (modified) (1 diff)

trunk/EventBenchCore/src/de/ugoe/cs/eventbench/models/HighOrderMarkovModel.java

@@ -7 +7 @@
 import de.ugoe.cs.eventbench.data.Event;
 
+/**
+ * <p>Implements high-order Markov models.</p>
+ * 
+ * @author Steffen Herbold
+ * @version 1.0
+ */
 public class HighOrderMarkovModel extends TrieBasedModel {
         
         /**
+         * <p>
          * Id for object serialization.
+         * </p>
          */
         private static final long serialVersionUID = 1L;
 
+        /**
+         * <p>Constructor. Creates a new HighOrderMarkovModel with a defined Markov order.</p>
+         * @param maxOrder Markov order of the model
+         * @param r random number generator used by probabilistic methods of the class
+         */
         public HighOrderMarkovModel(int maxOrder, Random r) {
                 super(maxOrder, r);
         }
         
+        /**
+         * <p>
+         * Calculates the probability of the next Event being symbol based on the order of the Markov model. The order is defined in the constructor {@link #HighOrderMarkovModel(int, Random)}. 
+         * </p>
+         * @see de.ugoe.cs.eventbench.models.IStochasticProcess#getProbability(java.util.List, de.ugoe.cs.eventbench.data.Event)
+         */
         @Override
         public double getProbability(List<? extends Event<?>> context, Event<?> symbol) {