Package opennlp.tools.util
Class Sequence
java.lang.Object
opennlp.tools.util.Sequence
- All Implemented Interfaces:
Comparable<Sequence>
Represents a weighted sequence of outcomes.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds an outcome and probability to this sequence.intbooleangetOutcome(int index) doublegetProb(int index) double[]getProbs()voidgetProbs(double[] ps) Populates an array with the probabilities associated with theSequenceoutcomes.doublegetScore()intgetSize()inthashCode()toString()
-
Constructor Details
-
Sequence
public Sequence()Initializes a newSequenceof outcomes. -
Sequence
- Parameters:
s- An existingSequenceused as input.
-
Sequence
- Parameters:
s- An existingSequenceused as input.outcome- An extra outcome to add tos.p- A extra probability of theoutcome.
-
Sequence
Initializes a newSequenceof outcomes from a list ofoutcomes. The probabilities for each outcome will be equally initialized toONE.- Parameters:
outcomes- Several existing outcomes used as input.
-
-
Method Details
-
compareTo
- Specified by:
compareToin interfaceComparable<Sequence>
-
hashCode
public int hashCode() -
equals
-
add
Adds an outcome and probability to this sequence.- Parameters:
outcome- the outcome to be added.p- the probability associated with this outcome.
-
getOutcomes
- Returns:
- Retrieves a list of outcomes for this
Sequence.
-
getSize
public int getSize()- Returns:
- Retrieves the size of the outcomes for this
Sequence.
-
getOutcome
- Parameters:
index- must be greater than or equal to zero and must be less thangetSize().- Returns:
- the outcome at the specified index.
- Throws:
IndexOutOfBoundsException- thrown if the given index is out of range.
-
getProb
public double getProb(int index) - Parameters:
index- must be greater than or equal to zero and must be less thangetSize().- Returns:
- the probability at the specified index.
- Throws:
IndexOutOfBoundsException- thrown if the given index is out of range.
-
getProbs
public double[] getProbs()- Returns:
- Retrieves an array of probabilities associated with the
Sequenceoutcomes.
-
getScore
public double getScore()- Returns:
- Retrieves the score of this
Sequence.
-
getProbs
public void getProbs(double[] ps) Populates an array with the probabilities associated with theSequenceoutcomes.- Parameters:
ps- A pre-allocated array to hold the values of the probabilities of the outcomes for thisSequence.
-
toString
-