Package opennlp.tools.ml.model
Interface MaxentModel
 All Known Implementing Classes:
AbstractModel
,GISModel
,NaiveBayesModel
,PerceptronModel
,QNModel
public interface MaxentModel
Interface for maximum entropy models.

Method Summary
Modifier and TypeMethodDescriptiondouble[]
Evaluates acontext
.double[]
Evaluates acontext
.double[]
Evaluates acontext
with the specified contextvalues
.getAllOutcomes
(double[] outcomes) Retrieves a string matching all the outcome names with all the probabilities produced by theeval(String[])
method.getBestOutcome
(double[] outcomes) Retrieves the outcome associated with the index containing the highest probability in the double[].int
Retrieves the index associated with the String name of the given outcome.int
getOutcome
(int i) Retrieves the String name of the outcome associated with the indexi
.

Method Details

eval
Evaluates acontext
. Parameters:
context
 An array of String names of the contextual predicates which are to be evaluated together. Returns:
 An array of the probabilities for each of the different
outcomes, all of which sum to
1
.

eval
Evaluates acontext
. Parameters:
context
 An array of String names of the contextual predicates which are to be evaluated together.probs
 An array which is populated with the probabilities for each of the different outcomes, all of which sum to 1. Returns:
 An array of the probabilities for each of the different
outcomes, all of which sum to
1
.

eval
Evaluates acontext
with the specified contextvalues
. Parameters:
context
 An array of String names of the contextual predicates which are to be evaluated together.values
 The values associated with each context. Returns:
 An array of the probabilities for each of the different
outcomes, all of which sum to
1
.

getBestOutcome
Retrieves the outcome associated with the index containing the highest probability in the double[]. Parameters:
outcomes
 Adouble[]
as returned by theeval(String[])
method. Returns:
 The String name of the best outcome.

getAllOutcomes
Retrieves a string matching all the outcome names with all the probabilities produced by theeval(String[])
method. Parameters:
outcomes
 Adouble[]
as returned by theeval(String[])
method. Returns:
 String containing outcome names paired with the normalized
probability (contained in the
double[] ocs
) for each one.

getOutcome
Retrieves the String name of the outcome associated with the indexi
. Parameters:
i
 The index for which the name of the associated outcome is desired. Returns:
 The String name of the outcome

getIndex
Retrieves the index associated with the String name of the given outcome. Parameters:
outcome
 The String name of the outcome for which the index is desired, Returns:
 The index if the given outcome label exists for this
model,
1
if it does not.

getNumOutcomes
int getNumOutcomes() Returns:
 Retrieves the number of outcomes for this model.
