org.maltparser.parser.history.kbest

Class KBestList

java.lang.Object

org.maltparser.parser.history.kbest.KBestList

Direct Known Subclasses:

ScoredKBestList

public class KBestList
extends java.lang.Object

Author:

Johan Hall

Field Summary

Fields

Modifier and Type	Field and Description
protected int	addCandidateIndex
protected SingleDecision	decision
protected int	k
protected java.util.ArrayList<Candidate>	kBestList
protected int	topCandidateIndex

Constructor Summary

Constructors

Constructor and Description
KBestList(java.lang.Integer k, SingleDecision decision) Creates a k-best list
KBestList(SingleDecision decision) Creates a unrestricted k-best list

Method Summary

Modifier and Type	Method and Description
void	add(int actionCode) Adds a candidate to the k-best list
void	add(java.lang.String symbol) Adds a candidate to the k-best list
void	addList(int[] predictionList)
protected int	getAddCandidateIndex()
ScoredCandidate	getCandidate(int i)
int	getCurrentSize() Returns the current size of the k-best list
SingleDecision	getDecision() Returns a single decision object
int	getK() Returns the maximum number of candidates in the k-best list.
int	getKBestListSize()
protected int	getTopCandidateIndex()
protected void	initKBestList()
int	peekNextKBest()
void	reset() Resets the k-best list
protected void	setK(int k) Sets the maximum number of candidates in the k-best list
java.lang.String	toString()
boolean	updateActionWithNextKBest() Updates the corresponding single decision with the next value in the k-best list.

Methods inherited from class java.lang.Object

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

Field Detail

kBestList

protected final java.util.ArrayList<Candidate> kBestList

k

protected int k

topCandidateIndex

protected int topCandidateIndex

addCandidateIndex

protected int addCandidateIndex

decision

protected final SingleDecision decision

Constructor Detail

KBestList

public KBestList(SingleDecision decision)

Creates a unrestricted k-best list

Parameters:

decision - a reference to the single decision that uses the k-best list

KBestList

public KBestList(java.lang.Integer k,
                 SingleDecision decision)

Creates a k-best list

Parameters:

k - the k-best list size

decision - a reference to the single decision that uses the k-best list.

Method Detail

initKBestList

protected void initKBestList()

reset

public void reset()

Resets the k-best list

add

public void add(int actionCode)
         throws MaltChainedException

Adds a candidate to the k-best list

Parameters:

actionCode - the integer representation of candidate action

Throws:

MaltChainedException

addList

public void addList(int[] predictionList)
             throws MaltChainedException

Throws:

MaltChainedException

add

public void add(java.lang.String symbol)
         throws MaltChainedException

Adds a candidate to the k-best list

Parameters:

symbol - the string representation of candidate action

Throws:

MaltChainedException

updateActionWithNextKBest

public boolean updateActionWithNextKBest()
                                  throws MaltChainedException

Updates the corresponding single decision with the next value in the k-best list.

Returns:

true if decision has been updated, otherwise false

Throws:

MaltChainedException

peekNextKBest

public int peekNextKBest()

getCurrentSize

public int getCurrentSize()

Returns the current size of the k-best list

Returns:

the current size of the k-best list

getK

public int getK()

Returns the maximum number of candidates in the k-best list.

Returns:

the maximum number of candidates in the k-best list

setK

protected void setK(int k)

Sets the maximum number of candidates in the k-best list

Parameters:

k - the maximum number of candidates

getTopCandidateIndex

protected int getTopCandidateIndex()

getAddCandidateIndex

protected int getAddCandidateIndex()

getDecision

public SingleDecision getDecision()

Returns a single decision object

Returns:

a single decision object

getKBestListSize

public int getKBestListSize()

getCandidate

public ScoredCandidate getCandidate(int i)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object