+ * This interface defines the structure of decorators used when writing replay + * files. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ public interface IReplayDecorator extends Serializable { - + + /** + *+ * Header of the file. Called at the beginning of the writing. + *
+ * + * @return file header + */ String getHeader(); - + + /** + *+ * Footer of the file. Called at the end of the writing. + *
+ * + * @return file footer + */ String getFooter(); - + + /** + *+ * Session Header. Called before each session. + *
+ * + * @param sessionId + * id of the session + * @return session header + */ String getSessionHeader(int sessionId); - + + /** + *+ * Session Footer. Called after each session. + *
+ * + * @param sessionId + * id of the session + * @return session footer + */ String getSessionFooter(int sessionId); } Index: trunk/EventBenchCore/src/de/ugoe/cs/eventbench/coverage/CoverageCalculator.java =================================================================== --- trunk/EventBenchCore/src/de/ugoe/cs/eventbench/coverage/CoverageCalculator.java (revision 102) +++ trunk/EventBenchCore/src/de/ugoe/cs/eventbench/coverage/CoverageCalculator.java (revision 106) @@ -12,63 +12,165 @@ import de.ugoe.cs.eventbench.models.IStochasticProcess; +/** + *+ * This class calculates various types of sequence coverage. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ public class CoverageCalculator { - + + /** + *+ * Stochastic process that is the foundation for probabilistic coverages and + * coverages with reference to all possible sequences. + *
+ */ private final IStochasticProcess process; + + /** + *+ * Sequences for which the coverage is calculated. + *
+ */ private final Collection+ * Length of the subsequences in relation to which the covarage is + * calculated. + *
+ */ private final int length; - + + /** + *+ * All subsequences of {@link #length} of {@link #sequences}. + *
+ */ private Collection+ * All subsequences of {@link #length} that can be generated by + * {@link #process}. + *
+ */ private Collection+ * The probabilities of al subsequences of {@link #length} according to + * {@link #process}. + *
+ */ private Map+ * Constructor. Creates a new CoverageCalculator for a given stochastic + * process and generated sequences. + *
+ * + * @param process + * stochastic process used for coverage calculations; if it is + * zero, not all calculations are possible + * @param sequences + * sequences for which the coverage is calculated; must not be + * null. + * @param length + * length of the subsequences for which the coverage is analyzed; + * must be >0 + */ + public CoverageCalculator(IStochasticProcess process, + Collection+ * Calculates the percentage of subsequences of length k that exist occur, + * including those that cannot be generated by {@link #process}. + *
+ * + * @return coverage percentage + */ public double getCoverageAllNoWeight() { - if( containedSubSeqs==null ) { + if (containedSubSeqs == null) { containedSubSeqs = containedSubSequences(sequences, length); } - return((double) containedSubSeqs.size())/numSequences(process, length); - } - + return ((double) containedSubSeqs.size()) + / numSequences(process, length); + } + + /** + *+ * Calculates the percentage of subsequences of length k that occur and can + * generated by {@link #process}. + *
+ * + * @return coverage percentage + */ public double getCoveragePossibleNoWeight() { - if( containedSubSeqs==null ) { + if (containedSubSeqs == null) { containedSubSeqs = containedSubSequences(sequences, length); } - if( allPossibleSubSeqs==null ) { + if (allPossibleSubSeqs == null) { allPossibleSubSeqs = process.generateSequences(length); } - return((double) containedSubSeqs.size())/allPossibleSubSeqs.size(); - } - + return ((double) containedSubSeqs.size()) / allPossibleSubSeqs.size(); + } + + /** + *+ * Calculates the weight of the subsequences that occur with relation to + * {@link #process}, i.e., the mass of the subsequence probability covered + * by the subsequences. + *
+ * + * @return coverage weight + */ public double getCoveragePossibleWeight() { - if( containedSubSeqs==null ) { + if (containedSubSeqs == null) { containedSubSeqs = containedSubSequences(sequences, length); } - if( allPossibleSubSeqs==null ) { + if (allPossibleSubSeqs == null) { allPossibleSubSeqs = process.generateSequences(length); } - if( subSeqWeights==null ) { + if (subSeqWeights == null) { subSeqWeights = generateWeights(process, allPossibleSubSeqs); } double weight = 0.0; - for( List> subSeq : containedSubSeqs ) { + for (List> subSeq : containedSubSeqs) { weight += subSeqWeights.get(subSeq); } return weight; } - - private Map+ * Calculates the weights for all sequences passed to this function as + * defined by the stochastic process and stores them in a {@link Map}. + *
+ * + * @param process + * process used for weight calculation + * @param sequences + * sequences for which the weights are calculated + * @return {@link Map} of weights + */ + private static Map+ * Calculates the number of all existing sequences of a given length, + * regardless whether they are possible or not. + *
+ * + * @param process + * stochastic process whose symbols are the basis for this + * calculation + * @param length + * lenght of the sequences + * @return numStates^length + */ + private static long numSequences(IStochasticProcess process, int length) { return (long) Math.pow(process.getNumStates(), length); } - - // O(numSeq*lenSeq) - private Set+ * Creates a {@link Set} of all subsequences of a given length that are + * contained in a sequence collection. + *
+ * + * @param sequences + * sequences from which the subsequences are extracted + * @param length + * length of the subsequences + * @return {@link Set} of all subsequences + */ + private static Set+ * Implements a round-trip buffered memory of a specified length that can be + * used to remember the recent history. Every event that happend longer ago than + * the length of the memory is forgotten, hence the memory is incomplete. + *
+ * + * @author Steffen Herbold + * @version 1.0 + * + * @param+ * Maximum length of the memory. + *
+ */ private int length; - + + /** + *+ * Internal storage of the history. + *
+ */ private List+ * Constructor. Creates a new IncompleteMemory. + *
+ * + * @param length + * number of recent events that are remembered + */ public IncompleteMemory(int length) { this.length = length; history = new LinkedList+ * Returns the current length of the memory. This can be less than + * {@link #length}, if the overall history is less than {@link #length}. + *
+ * + * @return length of the current memory + */ public int getLength() { return history.size(); Index: trunk/EventBenchCore/src/de/ugoe/cs/eventbench/models/Trie.java =================================================================== --- trunk/EventBenchCore/src/de/ugoe/cs/eventbench/models/Trie.java (revision 102) +++ trunk/EventBenchCore/src/de/ugoe/cs/eventbench/models/Trie.java (revision 106) @@ -6,55 +6,111 @@ import java.util.LinkedList; import java.util.List; -import java.util.Set; import de.ugoe.cs.util.StringTools; import edu.uci.ics.jung.graph.DelegateTree; +import edu.uci.ics.jung.graph.Graph; import edu.uci.ics.jung.graph.Tree; +/** + *
+ * This class implements a
* Id for object serialization. + *
*/ private static final long serialVersionUID = 1L; - private Set+ * Collection of all symbols occuring in the trie. + *
+ */ + private Collection+ * Reference to the root of the trie. + *
+ */ private final TrieNode+ * Contructor. Creates a new Trie. + *
+ */ public Trie() { rootNode = new TrieNode+ * Returns a collection of all symbols occuring in the trie. + *
+ * + * @return symbols occuring in the trie + */ + public Collection+ * Trains the current trie using the given sequence and adds all subsequence + * of length {@code maxOrder}. + *
+ * + * @param sequence + * sequence whose subsequences are added to the trie + * @param maxOrder + * maximum length of the subsequences added to the trie + */ public void train(List+ * Adds a given subsequence to the trie and increases the counters + * accordingly. + *
+ * + * @param subsequence + * subsequence whose counters are increased + * @see TrieNode#add(List) + */ + protected void add(List+ * Returns the child of the root node associated with the given symbol or + * creates it if it does not exist yet. + *
+ * + * @param symbol + * symbol whose node is required + * @return node associated with the symbol + * @see TrieNode#getChildCreate(Object) + */ + protected TrieNode+ * Returns the child of the root node associated with the given symbol or + * null if it does not exist. + *
+ * + * @param symbol + * symbol whose node is required + * @return node associated with the symbol; null if no such node exists + * @see TrieNode#getChild(Object) + */ protected TrieNode+ * Returns the number of occurences of the given sequence. + *
+ * + * @param sequence + * sequence whose number of occurences is required + * @return number of occurences of the sequence + */ public int getCount(List
+ * Returns the number of occurences of the given prefix and a symbol that
+ * follows it.
+ * Convenience function to simplify usage of {@link #getCount(List)}.
+ *
+ * Searches the trie for a given sequence and returns the node associated + * with the sequence or null if no such node is found. + *
+ * + * @param sequence + * sequence that is searched for + * @return node associated with the sequence + * @see TrieNode#find(List) + */ public TrieNode+ * Returns a collection of all symbols that follow a given sequence in the + * trie. In case the sequence is not found or no symbols follow the sequence + * the result will be empty. + *
+ * + * @param sequence + * sequence whose followers are returned + * @return symbols following the given sequence + * @see TrieNode#getFollowingSymbols() + */ public Collection+ * Returns the longest suffix of the given context that is contained in the + * tree and whose children are leaves. + *
+ * + * @param context + * context whose suffix is searched for + * @return longest suffix of the context + */ public List+ * Helper class for graph visualization of a trie. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ + static public class Edge { + } + + /** + *+ * Helper class for graph visualization of a trie. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ static public class TrieVertex { + + /** + *+ * Id of the vertex. + *
+ */ private String id; + + /** + *+ * Contructor. Creates a new TrieVertex. + *
+ * + * @param id + * id of the vertex + */ protected TrieVertex(String id) { this.id = id; } + + /** + *+ * Returns the id of the vertex. + *
+ * + * @see java.lang.Object#toString() + */ + @Override public String toString() { return id; } } - + + /** + *+ * Returns a {@link Graph} representation of the trie. + *
+ * + * @return {@link Graph} representation of the trie + */ protected Tree+ * Returns the string representation of the root node. + *
+ * + * @see TrieNode#toString() + * @see java.lang.Object#toString() + */ @Override public String toString() { return rootNode.toString(); } - + + /** + *+ * Returns the number of symbols contained in the trie. + *
+ * + * @return + */ public int getNumSymbols() { return knownSymbols.size(); Index: trunk/EventBenchCore/src/de/ugoe/cs/eventbench/models/TrieNode.java =================================================================== --- trunk/EventBenchCore/src/de/ugoe/cs/eventbench/models/TrieNode.java (revision 102) +++ trunk/EventBenchCore/src/de/ugoe/cs/eventbench/models/TrieNode.java (revision 106) @@ -11,18 +11,56 @@ import de.ugoe.cs.util.StringTools; import edu.uci.ics.jung.graph.DelegateTree; - - +import edu.uci.ics.jung.graph.Tree; + +/** + *+ * This class implements a node of a trie. Each node is associated with a symbol + * and has a counter. The counter marks the number of occurences of the sequence + * defined by the path from the root of the trie to this node. + *
+ * + * @author Steffen Herbold + * + * @param* Id for object serialization. + *
*/ private static final long serialVersionUID = 1L; - + + /** + *+ * Counter for the number of occurences of the sequence. + *
+ */ private int count; + + /** + *+ * Symbol associated with the node. + *
+ */ private final T symbol; - + + /** + *+ * Child nodes of this node. If the node is a leaf this collection is empty. + *
+ */ private Collection
+ * Constructor. Creates a new TrieNode without a symbol associated.
+ * This constructor should only be used to create the root node of the
+ * trie!
+ *
+ * Constructor. Creates a new TrieNode. The symbol must not be null. + *
+ * + * @param symbol + * symbol associated with the trie node + */ public TrieNode(T symbol) { - if( symbol==null ) { - throw new InvalidParameterException("symbol must not be null. null is reserved for root node!"); + if (symbol == null) { + throw new InvalidParameterException( + "symbol must not be null. null is reserved for root node!"); } this.symbol = symbol; @@ -40,12 +87,24 @@ } + /** + *+ * Adds a given subsequence to the trie and increases the counters + * accordingly. + *
+ * + * @param subsequence + * subsequence whose counters are increased + * @see Trie#add(List) + */ public void add(List+ * Returns the symbol associated with the node. + *
+ * + * @return symbol associated with the node + */ public T getSymbol() { return symbol; } - + + /** + *+ * Returns the number of occurences of the sequence represented by the node. + *
+ * + * @return number of occurences of the sequence represented by the node + */ public int getCount() { return count; } - - protected TrieNode+ * Returns the child of the node associated with the given symbol or creates + * it if it does not exist yet. + *
+ * + * @param symbol + * symbol whose node is required + * @return node associated with the symbol + * @see Trie#getChildCreate(Object) + */ + protected TrieNode+ * Returns the child of the node associated with the given symbol or null if + * it does not exist. + *
+ * + * @param symbol + * symbol whose node is required + * @return node associated with the symbol; null if no such node exists + * @see Trie#getChild(Object) + */ protected TrieNode+ * Searches the sub-trie of this trie node for a given sequence and returns + * the node associated with the sequence or null if no such node is found. + *
+ * + * @param sequence + * sequence that is searched for + * @return node associated with the sequence + * @see Trie#find(List) + */ public TrieNode+ * Returns a collection of all symbols that follow a this node, i.e., the + * symbols associated with the children of this node. + *
+ * + * @return symbols follow this node + * @see TrieNode#getFollowingSymbols() + */ public Collection+ * The string representation of a node is {@code symbol.toString()#count} + *
+ * + * @see java.lang.Object#toString() + */ @Override public String toString() { - String str = symbol.toString()+" #"+count; - if( !children.isEmpty() ) { + String str = symbol.toString() + " #" + count; + if (!children.isEmpty()) { str += StringTools.ENDLINE + children.toString(); } - return str; - } - - public void getGraph(TrieVertex parent, DelegateTree+ * Generates a {@link Tree} represenation of the trie. + *
+ * + * @param parent + * parent vertex in the generated tree + * @param graph + * complete tree + */ + void getGraph(TrieVertex parent, DelegateTree+ * Appends the current node to the dot representation of the trie. + *
+ * + * @param stringBuilder + * {@link StringBuilder} to which the dot representation is + * appended + */ void appendDotRepresentation(StringBuilder stringBuilder) { String thisSaneId; - if( symbol==null ) { + if (symbol == null) { thisSaneId = "root"; } else { - thisSaneId = symbol.toString().replace("\"", "\\\"").replaceAll("[\r\n]","")+"#"+count; - } - stringBuilder.append(" " + hashCode() + " [label=\""+thisSaneId+"\"];" + StringTools.ENDLINE); - for( TrieNode