be.yami.ngram

Interface NGram<T extends SequenceEntry>

Type Parameters:

T - The kind of sequences supported by the N gram

All Known Implementing Classes:

Bigram

public interface NGram<T extends SequenceEntry>

This class implements methods to generate a UsageModel from a set of sequences using an ngram inference method. Usage of the class should be:

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

Author:

Xavier Devroey - xavier.devroey@gmail.com

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.

Method Detail

getName

String getName()

Returns the name of the ngram.

Returns:

The name of the ngram.

addTrace

void addTrace(Sequence<T> seq)
       throws ModelGenerationException

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

Parameters:

seq - The sequence to add.

Throws:

ModelGenerationException - If an error happens during the adding of a sequence to the model.

getModel

be.vibes.ts.UsageModel getModel()
                         throws ModelGenerationException

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

Returns:

The inferred model.

Throws:

ModelGenerationException - If an error happens during the adding of a sequence to the model.