org.maltparser.parser.guide.instance

Class AtomicModel

java.lang.Object

org.maltparser.parser.guide.instance.AtomicModel

All Implemented Interfaces:

InstanceModel, Model

public class AtomicModel
extends java.lang.Object
implements InstanceModel

Author:

Johan Hall

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Class<?>[]	argTypes

Constructor Summary

Constructors

Constructor and Description
AtomicModel(int index, Model parent) Constructs an atomic model.

Method Summary

Modifier and Type	Method and Description
void	addInstance(FeatureVector featureVector, SingleDecision decision)
void	decreaseFrequency()
FeatureVector	extract(FeatureVector featureVector)
void	finalizeSentence(DependencyStructure dependencyGraph)
int	getFrequency() Returns the frequency (number of instances)
ClassifierGuide	getGuide() Returns the feature vector used by this atomic model
int	getIndex() Returns the index of the atomic model
LearningMethod	getMethod() Returns a learner object
java.lang.String	getModelName()
Model	getParent() Returns the parent guide model
void	increaseFrequency() Increase the frequency by 1
void	moveAllInstances(AtomicModel model, FeatureFunction divideFeature, java.util.ArrayList<java.lang.Integer> divideFeatureIndexVector) Moves all instance from this atomic model into the destination atomic model and add the divide feature.
void	noMoreInstances(FeatureModel featureModel)
boolean	predict(FeatureVector featureVector, SingleDecision decision)
FeatureVector	predictExtract(FeatureVector featureVector, SingleDecision decision)
protected void	setFrequency(int frequency) Sets the frequency (number of instances)
void	terminate()
java.lang.String	toString()
void	train() Invokes the train() of the learning method

Methods inherited from class java.lang.Object

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

Field Detail

argTypes

public static final java.lang.Class<?>[] argTypes

Constructor Detail

AtomicModel

public AtomicModel(int index,
                   Model parent)
            throws MaltChainedException

Constructs an atomic model.

Parameters:

index - the index of the atomic model (-1..n), where -1 is special value (used by a single model or the master divide model) and n is number of divide models.

parent - the parent guide model.

Throws:

MaltChainedException

Method Detail

addInstance

public void addInstance(FeatureVector featureVector,
                        SingleDecision decision)
                 throws MaltChainedException

Specified by:

addInstance in interface InstanceModel

Throws:

MaltChainedException

noMoreInstances

public void noMoreInstances(FeatureModel featureModel)
                     throws MaltChainedException

Specified by:

noMoreInstances in interface Model

Throws:

MaltChainedException

finalizeSentence

public void finalizeSentence(DependencyStructure dependencyGraph)
                      throws MaltChainedException

Specified by:

finalizeSentence in interface Model

Throws:

MaltChainedException

predict

public boolean predict(FeatureVector featureVector,
                       SingleDecision decision)
                throws MaltChainedException

Specified by:

predict in interface InstanceModel

Throws:

MaltChainedException

predictExtract

public FeatureVector predictExtract(FeatureVector featureVector,
                                    SingleDecision decision)
                             throws MaltChainedException

Specified by:

predictExtract in interface InstanceModel

Throws:

MaltChainedException

extract

public FeatureVector extract(FeatureVector featureVector)
                      throws MaltChainedException

Specified by:

extract in interface InstanceModel

Throws:

MaltChainedException

terminate

public void terminate()
               throws MaltChainedException

Specified by:

terminate in interface Model

Throws:

MaltChainedException

moveAllInstances

public void moveAllInstances(AtomicModel model,
                             FeatureFunction divideFeature,
                             java.util.ArrayList<java.lang.Integer> divideFeatureIndexVector)
                      throws MaltChainedException

Moves all instance from this atomic model into the destination atomic model and add the divide feature. This method is used by the feature divide model to sum up all model below a certain threshold.

Parameters:

model - the destination atomic model

divideFeature - the divide feature

divideFeatureIndexVector - the divide feature index vector

Throws:

MaltChainedException

train

public void train()
           throws MaltChainedException

Invokes the train() of the learning method

Specified by:

train in interface InstanceModel

Throws:

MaltChainedException

getParent

public Model getParent()
                throws MaltChainedException

Returns the parent guide model

Returns:

the parent guide model

Throws:

MaltChainedException

getModelName

public java.lang.String getModelName()

Specified by:

getModelName in interface Model

getGuide

public ClassifierGuide getGuide()

Returns the feature vector used by this atomic model

Specified by:

getGuide in interface Model

Returns:

a feature vector object

getIndex

public int getIndex()

Returns the index of the atomic model

Returns:

the index of the atomic model

getFrequency

public int getFrequency()

Returns the frequency (number of instances)

Returns:

the frequency (number of instances)

increaseFrequency

public void increaseFrequency()

Increase the frequency by 1

Specified by:

increaseFrequency in interface InstanceModel

decreaseFrequency

public void decreaseFrequency()

Specified by:

decreaseFrequency in interface InstanceModel

setFrequency

protected void setFrequency(int frequency)

Sets the frequency (number of instances)

Parameters:

frequency - (number of instances)

getMethod

public LearningMethod getMethod()

Returns a learner object

Returns:

a learner object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object