be.yami.ngram

Class Bigram<T extends SequenceEntry>

java.lang.Object

be.yami.ngram.Bigram<T>

Type Parameters:

T - The object type passed to the ObjectKeyGenerator provided at construction time of Bigram object.

All Implemented Interfaces:

NGram<T>

public class Bigram<T extends SequenceEntry>
extends Object
implements NGram<T>

This class implements methods to generate a UsageModel from a set of sequences. The model is generated using the bigram method, meaning that the probability for each next state only depends on the previous state. Usage of the class should be:

• Creation of the object by providing a key generator used to generate the key of each trace's element
• Adding traces to infer the model using addTrace(List<T>) method.
• Getting he UsageModel using getModel() method.

Author:

Xavier Devroey - xavier.devroey@unamur.be

Field Summary

Fields

Modifier and Type	Field and Description
static String	END_STATE_ID
static String	START_STATE_ID

Constructor Summary

Constructors

Constructor and Description
Bigram(String name, ObjectKeyGenerator<T> keyGen) Create a new Bigram object.

Method Summary

Modifier and Type	Method and Description
void	addTrace(Sequence<T> seq) Add a sequence to the ngram.
be.vibes.ts.UsageModel	getModel() Return the model inferred from the given sequences.
String	getName() Returns the name of the ngram.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

START_STATE_ID

public static final String START_STATE_ID

See Also:

Constant Field Values

END_STATE_ID

public static final String END_STATE_ID

See Also:

Constant Field Values

Constructor Detail

Bigram

public Bigram(String name,
              ObjectKeyGenerator<T> keyGen)

Create a new Bigram object.

Parameters:

name - The name of the ngram.

keyGen - The key generator used to generate the key corresponding to each trace entry.

Method Detail

addTrace

public void addTrace(Sequence<T> seq)

Description copied from interface: NGram

Add a sequence to the ngram. This sequence is used to enrich the model.

Specified by:

addTrace in interface NGram<T extends SequenceEntry>

Parameters:

seq - The sequence to add.

getModel

public be.vibes.ts.UsageModel getModel()

Description copied from interface: NGram

Return the model inferred from the given sequences. This method should be called once all the traces have been added to the ngram instance.

Specified by:

getModel in interface NGram<T extends SequenceEntry>

Returns:

The inferred model.

getName

public String getName()

Description copied from interface: NGram

Returns the name of the ngram.

Specified by:

getName in interface NGram<T extends SequenceEntry>

Returns:

The name of the ngram.