moa.classifiers.lazy

Class kNN

java.lang.Object

moa.AbstractMOAObject

moa.options.AbstractOptionHandler

moa.classifiers.AbstractClassifier

moa.classifiers.lazy.kNN

All Implemented Interfaces:

Serializable, Classifier, AWTRenderable, MOAObject, OptionHandler

Direct Known Subclasses:

kNNwithPAW, kNNwithPAWandADWIN

public class kNN
extends AbstractClassifier

k Nearest Neighbor.

Valid options are:

-k number of neighbours
-m max instances

Version:

03.2012

Author:

Jesse Read (jesse@tsc.uc3m.es)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
IntOption	kOption
IntOption	limitOption
MultiChoiceOption	nearestNeighbourSearchOption
protected weka.core.Instances	window

Fields inherited from class moa.classifiers.AbstractClassifier

classifierRandom, modelContext, randomSeed, randomSeedOption, trainingWeightSeenByModel

Fields inherited from class moa.options.AbstractOptionHandler

classOptionNamesToPreparedObjects, options

Constructor Summary

Constructors

Constructor and Description
kNN()

Method Summary

Methods

Modifier and Type	Method and Description
void	getModelDescription(StringBuilder out, int indent) Returns a string representation of the model.
protected Measurement[]	getModelMeasurementsImpl() Gets the current measurements of this classifier. The reason for ...Impl methods: ease programmer burden by not requiring them to remember calls to super in overridden methods.
String	getPurposeString() Gets the purpose of this object
double[]	getVotesForInstance(weka.core.Instance inst) Predicts the class memberships for a given instance.
boolean	isRandomizable() Gets whether this classifier needs a random seed.
void	resetLearningImpl() Resets this classifier.
void	setModelContext(InstancesHeader context) Sets the reference to the header of the data stream.
void	trainOnInstanceImpl(weka.core.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 moa.classifiers.AbstractClassifier

contextIsCompatible, copy, correctlyClassifies, getAttributeNameString, getAWTRenderer, getClassLabelString, getClassNameString, getDescription, getModelContext, getModelMeasurements, getNominalValueString, getSubClassifiers, modelAttIndexToInstanceAttIndex, modelAttIndexToInstanceAttIndex, prepareForUseImpl, resetLearning, setRandomSeed, trainingHasStarted, trainingWeightSeenByModel, trainOnInstance

Methods inherited from class moa.options.AbstractOptionHandler

discoverOptionsViaReflection, getCLICreationString, getOptions, getPreparedClassOption, getPreparedClassOption, prepareClassOptions, prepareForUse, prepareForUse

Methods inherited from class moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface moa.options.OptionHandler

getCLICreationString, getOptions, prepareForUse, prepareForUse

Methods inherited from interface moa.MOAObject

measureByteSize

Field Detail

kOption

public IntOption kOption

limitOption

public IntOption limitOption

nearestNeighbourSearchOption

public MultiChoiceOption nearestNeighbourSearchOption

window

protected weka.core.Instances window

Constructor Detail

kNN

public kNN()

Method Detail

getPurposeString

public String getPurposeString()

Description copied from interface: OptionHandler

Gets the purpose of this object

Specified by:

getPurposeString in interface OptionHandler

Overrides:

getPurposeString in class AbstractClassifier

Returns:

the string with the purpose of this object

setModelContext

public void setModelContext(InstancesHeader context)

Description copied from interface: Classifier

Sets the reference to the header of the data stream. The header of the data stream is extended from WEKA Instances. This header is needed to know the number of classes and attributes

Specified by:

setModelContext in interface Classifier

Overrides:

setModelContext in class AbstractClassifier

Parameters:

context - the reference to the data stream header

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(weka.core.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(weka.core.Instance inst)

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.

Parameters:

inst - the instance to be classified

Returns:

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

getModelMeasurementsImpl

protected Measurement[] getModelMeasurementsImpl()

Description copied from class: AbstractClassifier

Gets the current measurements of this classifier.

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:

getModelMeasurementsImpl in class AbstractClassifier

Returns:

an array of measurements to be used in evaluation tasks

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: Classifier

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

Returns:

true if the classifier needs a random seed.