de.tud.ke.mrapp.rulelearning.core.heuristics

Enum ConfusionMatrix.Element

java.lang.Object

java.lang.Enum<ConfusionMatrix.Element>

de.tud.ke.mrapp.rulelearning.core.heuristics.ConfusionMatrix.Element

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConfusionMatrix.Element>

Enclosing class:

ConfusionMatrix

public static enum ConfusionMatrix.Element
extends java.lang.Enum<ConfusionMatrix.Element>

Contains all types of elements of a ConfusionMatrix.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FN Represents a false negative.
FP Represents a false positive.
TN Represents a true negative.
TP Represents a true positive.

Method Summary

Modifier and Type	Method and Description
static @NotNull ConfusionMatrix.Element	forPrediction(double prediction, double groundTruth) Creates and returns an element of a ConfusionMatrix for a specific prediction and the corresponding ground truth.
boolean	isCorrectPrediction() Returns, whether the element represents a correct prediction, or not.
boolean	isNegativeExample() Returns, whether the element corresponds to a negative example, or not.
boolean	isNegativePrediction() Returns, whether the element represents a negative prediction, or not.
boolean	isPositiveExample() Returns, whether the element corresponds to a positive example, or not.
boolean	isPositivePrediction() Returns, whether the element represents a positive prediction, or not.
boolean	isWrongPrediction() Returns, whether the element represents a wrong prediction, or not.
static ConfusionMatrix.Element	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConfusionMatrix.Element[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TP

public static final ConfusionMatrix.Element TP

Represents a true positive.

FP

public static final ConfusionMatrix.Element FP

Represents a false positive.

TN

public static final ConfusionMatrix.Element TN

Represents a true negative.

FN

public static final ConfusionMatrix.Element FN

Represents a false negative.

Method Detail

values

public static ConfusionMatrix.Element[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConfusionMatrix.Element c : ConfusionMatrix.Element.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConfusionMatrix.Element valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

forPrediction

@NotNull
public static @NotNull ConfusionMatrix.Element forPrediction(double prediction,
                                                                      double groundTruth)

Creates and returns an element of a ConfusionMatrix for a specific prediction and the corresponding ground truth.

Parameters:

prediction - The prediction that have been made

groundTruth - The ground truth

Returns:

The element that has been created

isCorrectPrediction

public boolean isCorrectPrediction()

Returns, whether the element represents a correct prediction, or not.

Returns:

True, if the element represents a correct prediction, false otherwise

isWrongPrediction

public boolean isWrongPrediction()

Returns, whether the element represents a wrong prediction, or not.

Returns:

True, if the element represents a wrong prediction, false otherwise

isPositivePrediction

public boolean isPositivePrediction()

Returns, whether the element represents a positive prediction, or not.

Returns:

True, if the element represents a positive prediction, false otherwise

isNegativePrediction

public boolean isNegativePrediction()

Returns, whether the element represents a negative prediction, or not.

Returns:

True, if the element represents a negative prediction, false otherwise

isPositiveExample

public boolean isPositiveExample()

Returns, whether the element corresponds to a positive example, or not.

Returns:

True, if the element corresponds to a positive example, false otherwise

isNegativeExample

public boolean isNegativeExample()

Returns, whether the element corresponds to a negative example, or not.

Returns:

True, if the element corresponds to a negative example, false otherwise