org.apache.samoa.moa.classifiers.functions

Class MajorityClass

java.lang.Object

org.apache.samoa.moa.AbstractMOAObject

org.apache.samoa.moa.options.AbstractOptionHandler

org.apache.samoa.moa.classifiers.AbstractClassifier

org.apache.samoa.moa.classifiers.functions.MajorityClass

All Implemented Interfaces:

com.github.javacliparser.Configurable, Serializable, Classifier, Learner<Example<Instance>>, MOAObject, OptionHandler

public class MajorityClass
extends AbstractClassifier

Majority class learner. This is the simplest classifier.

Version:

$Revision: 7 $

Author:

Richard Kirkby (rkirkby@cs.waikato.ac.nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.samoa.moa.classifiers.AbstractClassifier

classifierRandom

Constructor Summary

Constructors

Constructor and Description
MajorityClass()

Method Summary

Modifier and Type	Method and Description
void	getModelDescription(StringBuilder out, int indent) Returns a string representation of the model.
String	getPurposeString() Dictionary with option texts and objects
double[]	getVotesForInstance(Instance i) Predicts the class memberships for a given instance.
boolean	isRandomizable() Gets whether this learner needs a random seed.
void	resetLearningImpl() Resets this classifier.
void	trainOnInstanceImpl(Instance inst) Trains this classifier incrementally using the given instance. The reason for ...Impl methods: ease programmer burden by not requiring them to remember calls to super in overridden methods.

Methods inherited from class org.apache.samoa.moa.classifiers.AbstractClassifier

contextIsCompatible, copy, correctlyClassifies, getAttributeNameString, getClassLabelString, getClassNameString, getDescription, getModel, getModelContext, getModelMeasurements, getNominalValueString, getSubClassifiers, getSublearners, getVotesForInstance, prepareForUseImpl, resetLearning, setModelContext, setRandomSeed, trainingHasStarted, trainingWeightSeenByModel, trainOnInstance, trainOnInstance

Methods inherited from class org.apache.samoa.moa.options.AbstractOptionHandler

getCLICreationString, getOptions, prepareForUse, prepareForUse

Methods inherited from class org.apache.samoa.moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.samoa.moa.options.OptionHandler

getCLICreationString, getOptions, prepareForUse, prepareForUse

Methods inherited from interface org.apache.samoa.moa.MOAObject

measureByteSize

Constructor Detail

MajorityClass

public MajorityClass()

Method Detail

getPurposeString

public String getPurposeString()

Description copied from class: AbstractOptionHandler

Dictionary with option texts and objects

Specified by:

getPurposeString in interface OptionHandler

Overrides:

getPurposeString in class AbstractClassifier

Returns:

the string with the purpose of this object

resetLearningImpl

public void resetLearningImpl()

Description copied from class: AbstractClassifier

Resets this classifier. It must be similar to starting a new classifier from scratch.

The reason for ...Impl methods: ease programmer burden by not requiring them to remember calls to super in overridden methods. Note that this will produce compiler errors if not overridden.

Specified by:

resetLearningImpl in class AbstractClassifier

trainOnInstanceImpl

public void trainOnInstanceImpl(Instance inst)

Description copied from class: AbstractClassifier

Trains this classifier incrementally using the given instance.

The reason for ...Impl methods: ease programmer burden by not requiring them to remember calls to super in overridden methods. Note that this will produce compiler errors if not overridden.

Specified by:

trainOnInstanceImpl in class AbstractClassifier

Parameters:

inst - the instance to be used for training

getVotesForInstance

public double[] getVotesForInstance(Instance i)

Description copied from interface: Classifier

Predicts the class memberships for a given instance. If an instance is unclassified, the returned array elements must be all zero.

Specified by:

getVotesForInstance in interface Classifier

Specified by:

getVotesForInstance in class AbstractClassifier

Parameters:

i - the instance to be classified

Returns:

an array containing the estimated membership probabilities of the test instance in each class

getModelDescription

public void getModelDescription(StringBuilder out,
                                int indent)

Description copied from class: AbstractClassifier

Returns a string representation of the model.

Specified by:

getModelDescription in class AbstractClassifier

Parameters:

out - the stringbuilder to add the description

indent - the number of characters to indent

isRandomizable

public boolean isRandomizable()

Description copied from interface: Learner

Gets whether this learner needs a random seed. Examples of methods that needs a random seed are bagging and boosting.

Returns:

true if the learner needs a random seed.