com.groiss.ml.classifier

Class ClassificationResult

java.lang.Object

com.groiss.ml.classifier.ClassificationResult

public class ClassificationResult
extends Object

Represents the label of a classification prediction along with the probability of that prediction. If no such probability is provided UNKNOWN_PROBABILITY will be returned as default.

Field Summary

Fields

Modifier and Type	Field and Description
static double	UNKNOWN_PROBABILITY Determines that no probability is available for this classification result

Constructor Summary

Constructors

Constructor and Description
ClassificationResult(String label, Class<?> clazz) Creates a new classification result with the passed label and an unknown probability
ClassificationResult(String label, double probability, Class<?> clazz) Creates a new classification result with the passed label and probability

Method Summary

Modifier and Type	Method and Description
String	getLabel() Returns the classified String
Object	getObject() Returns the object of the classification
double	probability() Returns the probability of the prediction

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_PROBABILITY

public static final double UNKNOWN_PROBABILITY

Determines that no probability is available for this classification result

See Also:

Constant Field Values

Constructor Detail

ClassificationResult

public ClassificationResult(String label,
                            Class<?> clazz)

Creates a new classification result with the passed label and an unknown probability

Parameters:

label - the label of this classification

ClassificationResult

public ClassificationResult(String label,
                            double probability,
                            Class<?> clazz)

Creates a new classification result with the passed label and probability

Parameters:

label - the label of this classification

probability - the probability of the prediction. Must be either UNKNOWN_PROBABILITY or a value ≥ 0 and ≤ 1.

Method Detail

getObject

public Object getObject()

Returns the object of the classification

Returns:

the object of the classification

probability

public double probability()

Returns the probability of the prediction

Returns:

the probability of the prediction

getLabel

public String getLabel()

Returns the classified String

Returns:

the classified String