cc.mallet.cluster.neighbor_evaluator

Class ClassifyingNeighborEvaluator

java.lang.Object

cc.mallet.cluster.neighbor_evaluator.ClassifyingNeighborEvaluator

All Implemented Interfaces:

NeighborEvaluator, java.io.Serializable

Direct Known Subclasses:

MedoidEvaluator, PairwiseEvaluator, RankingNeighborEvaluator

public class ClassifyingNeighborEvaluator
extends java.lang.Object
implements NeighborEvaluator, java.io.Serializable

A NeighborEvaluator that is backed by a Classifier. The score for a Neighbor is the Classifier's predicted value for the label corresponding to scoringLabel.

Since:

1.0

See Also:

NeighborEvaluator, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClassifyingNeighborEvaluator(Classifier classifier, java.lang.String scoringLabel)

Method Summary

Modifier and Type	Method and Description
double	evaluate(Neighbor neighbor)
double[]	evaluate(Neighbor[] neighbors)
Classifier	getClassifier()
void	reset() Reset the state of the evaluator.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassifyingNeighborEvaluator

public ClassifyingNeighborEvaluator(Classifier classifier,
                                    java.lang.String scoringLabel)

Parameters:

classifier - The Classifier used to assign a score to each Neighbor.

scoringLabel - The label corresponding to a positive instance (e.g. "YES").

Method Detail

getClassifier

public Classifier getClassifier()

Returns:

The classifier.

evaluate

public double evaluate(Neighbor neighbor)

Specified by:

evaluate in interface NeighborEvaluator

Returns:

A higher score indicates that the modified Clustering is preferred.

evaluate

public double[] evaluate(Neighbor[] neighbors)

Specified by:

evaluate in interface NeighborEvaluator

Returns:

One score per neighbor. A higher score indicates that the modified Clustering is preferred.

reset

public void reset()

Description copied from interface: NeighborEvaluator

Reset the state of the evaluator.

Specified by:

reset in interface NeighborEvaluator

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object