marf.Stats.StatisticalEstimators
Interface IStatisticalEstimator

All Known Implementing Classes:

AddDelta, AddOne, GLI, GoodTuring, KatzBackoff, MLE, SLI, Smoothing, StatisticalEstimator, WittenBell

public interface IStatisticalEstimator

Represents Statistical Estimator interface. If concrete statistical estimators cannot inherit from the generic StatisticalEstimator class (which provides most generic implementation), they must implement this interface then.

$Id: IStatisticalEstimator.java,v 1.3 2007/12/18 21:57:15 mokhov Exp $

Since:

0.3.0.3

Version:

$Revision: 1.3 $

Author:

Serguei Mokhov

Field Summary

static java.lang.String

MARF_INTERFACE_CODE_REVISION Interface source code revision.

Method Summary

java.lang.String	getLanguage() Retrieves current language.
ProbabilityTable	getProbabilityTable() Retrieves current probabilities table.
NLPStreamTokenizer	getStreamTokenizer() Retrieves current stream tokenizer.
double	p() Classification via calculation of a probability p.
void	setLanguage(java.lang.String pstrLang) Allows alteration of the current language being processed.
void	setStreamTokenizer(NLPStreamTokenizer poStreamTokenizer) Sets desired stream tokenizer.
boolean	train() Every estimator needs to implement its specific training method.

Field Detail

MARF_INTERFACE_CODE_REVISION

static final java.lang.String MARF_INTERFACE_CODE_REVISION

Interface source code revision.

See Also:

Constant Field Values

Method Detail

p

double p()

Classification via calculation of a probability p.

Returns:

calculated probability value

train

boolean train()

Every estimator needs to implement its specific training method.

Returns:

true if training was successful

setStreamTokenizer

void setStreamTokenizer(NLPStreamTokenizer poStreamTokenizer)

Sets desired stream tokenizer.

Parameters:

poStreamTokenizer - NLPStreamTokenizer or a derivative to use for tokens

See Also:

NLPStreamTokenizer

getStreamTokenizer

NLPStreamTokenizer getStreamTokenizer()

Retrieves current stream tokenizer.

Returns:

the stream tokenizer being used

getProbabilityTable

ProbabilityTable getProbabilityTable()

Retrieves current probabilities table.

Returns:

probabilities table being used

See Also:

ProbabilityTable

setLanguage

void setLanguage(java.lang.String pstrLang)

Allows alteration of the current language being processed.

Parameters:

pstrLang - desired language

getLanguage

java.lang.String getLanguage()

Retrieves current language.

Returns:

language name of language being processed