it.uniroma2.sag.kelp.predictionfunction.classifier

Class BinaryMarginClassifierOutput

java.lang.Object

it.uniroma2.sag.kelp.predictionfunction.classifier.BinaryMarginClassifierOutput

All Implemented Interfaces:

ClassificationOutput, Prediction

public class BinaryMarginClassifierOutput
extends Object
implements ClassificationOutput

It is the output provided by binary margin classifiers like the ones trained with SVM or perceptron based learning algorithms. The output is basically a real number whose sign identifies the membership to the positive class and whose absolute value expresses the distance from the classification hyperplane

Author:

Simone Filice

Constructor Summary

Constructors

Constructor and Description
BinaryMarginClassifierOutput(Label positiveClass, float prediction)

Method Summary

Methods

Modifier and Type	Method and Description
List<Label>	getAllClasses() Returns all the classes involved in the classification process (both predicted and not)
List<Label>	getPredictedClasses() Returns all the classes that the classifier has predicted
Float	getScore(Label label) Return the prediction score associated to a given label
boolean	isClassPredicted(Label label) Returns a boolean identifying the predicted membership to a specified class

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryMarginClassifierOutput

public BinaryMarginClassifierOutput(Label positiveClass,
                            float prediction)

Method Detail

getScore

public Float getScore(Label label)

Description copied from interface: Prediction

Return the prediction score associated to a given label

Specified by:

getScore in interface Prediction

Parameters:

label - the label whose associated score is required

Returns:

the score associated to a given label

isClassPredicted

public boolean isClassPredicted(Label label)

Description copied from interface: ClassificationOutput

Returns a boolean identifying the predicted membership to a specified class

Specified by:

isClassPredicted in interface ClassificationOutput

Parameters:

label - the class whose membership is required

Returns:

a boolean identifying the predicted membership to a specified class

getPredictedClasses

public List<Label> getPredictedClasses()

Description copied from interface: ClassificationOutput

Returns all the classes that the classifier has predicted

Specified by:

getPredictedClasses in interface ClassificationOutput

Returns:

the predicted classes

getAllClasses

public List<Label> getAllClasses()

Description copied from interface: ClassificationOutput

Returns all the classes involved in the classification process (both predicted and not)

Specified by:

getAllClasses in interface ClassificationOutput

Returns:

all the classes involved in the classification process (both predicted and not)