ConfusionMatrix (Core API)

java.lang.Object
- de.tud.ke.mrapp.rulelearning.core.heuristics.ConfusionMatrix

All Implemented Interfaces:

Measurable, java.io.Serializable
```
public class ConfusionMatrix
extends java.lang.Object
implements Measurable, java.io.Serializable
```
A 2-dimensional confusion matrix that stores how many true positives (TP), false positives (FP), true negatives (TN), and false negatives (FN) have been predicted by a classifier.

Since:

0.1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConfusionMatrix.Element
Contains all types of elements of a ConfusionMatrix.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConfusionMatrix.Element` Contains all types of elements of a `ConfusionMatrix`.

Constructor Summary

Constructors
Constructor and Description
`ConfusionMatrix()` Creates an empty confusion matrix, where all elements are set to zero.
`ConfusionMatrix(@NotNull ConfusionMatrix confusionMatrix)` Creates a new confusion matrix by copying an existing one.
`ConfusionMatrix(double truePositives, double falsePositives, double trueNegatives, double falseNegatives)` Creates a new confusion matrix, where the individual elements are set to certain values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(@NotNull ConfusionMatrix confusionMatrix)` Adds the elements of another confusion matrix to this confusion matrix.
`void`	`add(double truePositives, double falsePositives, double trueNegatives, double falseNegatives)` Adds specific values to the elements of the confusion matrix.
`double`	`addElement(@NotNull ConfusionMatrix.Element element)` Adds a new `ConfusionMatrix.Element` with weight 1 to the confusion matrix.
`double`	`addElement(@NotNull ConfusionMatrix.Element element, double weight)` Adds a new `ConfusionMatrix.Element` with a certain weight to the confusion matrix.
`double`	`addFalseNegative()` Adds a false negative with weight 1.
`double`	`addFalseNegative(double weight)` Adds a false negative with a certain weight.
`double`	`addFalsePositive()` Adds a false positive with weight 1.
`double`	`addFalsePositive(double weight)` Adds a false positive with a certain weight.
`double`	`addTrueNegative()` Adds a true negative with weight 1.
`double`	`addTrueNegative(double weight)` Adds a true negative with a certain weight.
`double`	`addTruePositive()` Adds a true positive with weight 1.
`double`	`addTruePositive(double weight)` Adds a true positive with a certain weight.
`static @NotNull ConfusionMatrix`	`aggregate(@NotNull ConfusionMatrix confusionMatrix1, @NotNull ConfusionMatrix confusionMatrix2)` Creates and returns a confusion matrix that results from element-wise aggregating two existing confusion matrices.
`void`	`clear()` Clears the confusion matrix by setting all elements to zero.
`boolean`	`equals(java.lang.Object obj)`
`@NotNull ConfusionMatrix`	`getConfusionMatrix()` Returns the confusion matrix that can be used to calculate the heuristic value of the `Measurable`.
`double`	`getCorrectPredictions()` Returns the number of correct predictions.
`double`	`getElement(@NotNull ConfusionMatrix.Element element)` Returns the number of a specific `ConfusionMatrix.Element`.
`double`	`getFalseNegatives()` Returns the number of false negatives.
`double`	`getFalsePositives()` Returns the number of false positives.
`double`	`getNegativeExamples()` Returns the number of negative examples.
`double`	`getNegativePredictions()` Returns the number of negative predictions.
`double`	`getPositiveExamples()` Returns the number of positive examples.
`double`	`getPositivePredictions()` Returns the number of positive predictions.
`double`	`getTotalPredictions()` Returns the total number of predictions.
`double`	`getTrueNegatives()` Returns the number of true negatives.
`double`	`getTruePositives()` Returns the number of true positives.
`double`	`getWrongPredictions()` Returns the number of wrong predictions.
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns, whether the confusion matrix is empty, i.e.
`double`	`removeElement(@NotNull ConfusionMatrix.Element element)` Removes a specific `ConfusionMatrix.Element` with weight 1 from the confusion matrix.
`double`	`removeElement(@NotNull ConfusionMatrix.Element element, double weight)` Removes a specific `ConfusionMatrix.Element` with a certain weight from the confusion matrix.
`double`	`removeFalseNegative()` Removes a false negative with weight 1.
`double`	`removeFalseNegative(double weight)` Removes a false negative with a certain weight.
`double`	`removeFalsePositive()` Removes a false positive with weight 1.
`double`	`removeFalsePositive(double weight)` Removes a false positive with a certain weight.
`double`	`removeTrueNegative()` Removes a true negative with weight 1.
`double`	`removeTrueNegative(double weight)` Removes a true negative with a certain weight.
`double`	`removeTruePositive()` Removes a true positive with weight 1.
`double`	`removeTruePositive(double weight)` Removes a true positive with a certain weight.
`void`	`set(@NotNull ConfusionMatrix confusionMatrix)` Sets the elements of the confusion matrix to those of another confusion matrix.
`void`	`set(double truePositives, double falsePositives, double trueNegatives, double falseNegatives)` Sets the elements of the confusion matrix to specific values.
`void`	`setFalseNegatives(double falseNegatives)` Sets the number of false negatives.
`void`	`setFalsePositives(double falsePositives)` Sets the number of false positives.
`void`	`setTrueNegatives(double trueNegatives)` Sets the number of true negatives.
`void`	`setTruePositives(double truePositives)` Sets the number of true positives.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConfusionMatrix
```
public ConfusionMatrix()
```
    Creates an empty confusion matrix, where all elements are set to zero.
  - ConfusionMatrix
```
public ConfusionMatrix(@NotNull
                       @NotNull ConfusionMatrix confusionMatrix)
```
    Creates a new confusion matrix by copying an existing one.
    
    Parameters:
    
    confusionMatrix - The confusion matrix to be copied
  - ConfusionMatrix
```
public ConfusionMatrix(double truePositives,
                       double falsePositives,
                       double trueNegatives,
                       double falseNegatives)
```
    Creates a new confusion matrix, where the individual elements are set to certain values.
    
    Parameters:
    
    truePositives - The number of true positives
    
    falsePositives - The number of false positives
    
    trueNegatives - The number of true negatives
    
    falseNegatives - The number of false negatives
- Method Detail
  - aggregate
```
@NotNull
public static @NotNull ConfusionMatrix aggregate(@NotNull
                                                          @NotNull ConfusionMatrix confusionMatrix1,
                                                          @NotNull
                                                          @NotNull ConfusionMatrix confusionMatrix2)
```
    Creates and returns a confusion matrix that results from element-wise aggregating two existing confusion matrices.
    
    Parameters:
    
    confusionMatrix1 - The first confusion matrix to be aggregated
    
    confusionMatrix2 - The second confusion matrix to be aggregated
    
    Returns:
    
    The confusion matrix that has been created
  - getElement
```
public double getElement(@NotNull
                         @NotNull ConfusionMatrix.Element element)
```
    Returns the number of a specific ConfusionMatrix.Element.
    
    Parameters:
    
    element - The element to be checked
    
    Returns:
    
    The number of the given element
  - addElement
```
public double addElement(@NotNull
                         @NotNull ConfusionMatrix.Element element)
```
    Adds a new ConfusionMatrix.Element with weight 1 to the confusion matrix.
    
    Parameters:
    
    element - The element to be added
    
    Returns:
    
    The updated number of the given element
  - addElement
```
public double addElement(@NotNull
                         @NotNull ConfusionMatrix.Element element,
                         double weight)
```
    Adds a new ConfusionMatrix.Element with a certain weight to the confusion matrix.
    
    Parameters:
    
    element - The element to be added
    
    weight - The weight of the element
    
    Returns:
    
    The updated number of the given element
  - removeElement
```
public double removeElement(@NotNull
                            @NotNull ConfusionMatrix.Element element)
```
    Removes a specific ConfusionMatrix.Element with weight 1 from the confusion matrix.
    
    Parameters:
    
    element - The element to be removed
    
    Returns:
    
    The updated number of the given element
  - removeElement
```
public double removeElement(@NotNull
                            @NotNull ConfusionMatrix.Element element,
                            double weight)
```
    Removes a specific ConfusionMatrix.Element with a certain weight from the confusion matrix.
    
    Parameters:
    
    element - The element to be removed
    
    weight - The weight of the element
    
    Returns:
    
    The updated number of the given element
  - clear
```
public void clear()
```
    Clears the confusion matrix by setting all elements to zero.
  - isEmpty
```
public boolean isEmpty()
```
    Returns, whether the confusion matrix is empty, i.e. if all elements are set to zero.
    
    Returns:
    
    True, if the confusion matrix is empty, false otherwise
  - set
```
public void set(@NotNull
                @NotNull ConfusionMatrix confusionMatrix)
```
    Sets the elements of the confusion matrix to those of another confusion matrix.
    
    Parameters:
    
    confusionMatrix - The confusion matrix whose elements should be copied
  - set
```
public void set(double truePositives,
                double falsePositives,
                double trueNegatives,
                double falseNegatives)
```
    Sets the elements of the confusion matrix to specific values.
    
    Parameters:
    
    truePositives - The number of true positives to be set
    
    falsePositives - The number of false positives to be set
    
    trueNegatives - The number of true negatives to be set
    
    falseNegatives - The number of false negatives to be set
  - add
```
public void add(@NotNull
                @NotNull ConfusionMatrix confusionMatrix)
```
    Adds the elements of another confusion matrix to this confusion matrix.
    
    Parameters:
    
    confusionMatrix - The confusion matrix whose elements should be added
  - add
```
public void add(double truePositives,
                double falsePositives,
                double trueNegatives,
                double falseNegatives)
```
    Adds specific values to the elements of the confusion matrix.
    
    Parameters:
    
    truePositives - The number of true positives to be added
    
    falsePositives - The number of false positives to be added
    
    trueNegatives - The number of true negatives to be added
    
    falseNegatives - The number of false negatives to be added
  - getTruePositives
```
public double getTruePositives()
```
    Returns the number of true positives.
    
    Returns:
    
    The number of true positives
  - setTruePositives
```
public void setTruePositives(double truePositives)
```
    Sets the number of true positives.
    
    Parameters:
    
    truePositives - The number of true positives to be set
  - addTruePositive
```
public double addTruePositive()
```
    Adds a true positive with weight 1.
    
    Returns:
    
    The updated number of true positives
  - addTruePositive
```
public double addTruePositive(double weight)
```
    Adds a true positive with a certain weight.
    
    Parameters:
    
    weight - The weight of the true positive
    
    Returns:
    
    The updated number of true positives
  - removeTruePositive
```
public double removeTruePositive()
```
    Removes a true positive with weight 1.
    
    Returns:
    
    The updated number of true positives
  - removeTruePositive
```
public double removeTruePositive(double weight)
```
    Removes a true positive with a certain weight.
    
    Parameters:
    
    weight - The weight of the true positive
    
    Returns:
    
    The updated number of true positives
  - getFalsePositives
```
public double getFalsePositives()
```
    Returns the number of false positives.
    
    Returns:
    
    The number of false positives
  - setFalsePositives
```
public void setFalsePositives(double falsePositives)
```
    Sets the number of false positives.
    
    Parameters:
    
    falsePositives - The number of false positives to be set
  - addFalsePositive
```
public double addFalsePositive()
```
    Adds a false positive with weight 1.
    
    Returns:
    
    The updated number of false positives
  - addFalsePositive
```
public double addFalsePositive(double weight)
```
    Adds a false positive with a certain weight.
    
    Parameters:
    
    weight - The weight of the false positive
    
    Returns:
    
    The updated number of false positives
  - removeFalsePositive
```
public double removeFalsePositive()
```
    Removes a false positive with weight 1.
    
    Returns:
    
    The updated number of false positives
  - removeFalsePositive
```
public double removeFalsePositive(double weight)
```
    Removes a false positive with a certain weight.
    
    Parameters:
    
    weight - The weight of the false positive
    
    Returns:
    
    The updated number of false positives
  - getTrueNegatives
```
public double getTrueNegatives()
```
    Returns the number of true negatives.
    
    Returns:
    
    The number of true negatives
  - setTrueNegatives
```
public void setTrueNegatives(double trueNegatives)
```
    Sets the number of true negatives.
    
    Parameters:
    
    trueNegatives - The number of true negatives to be set
  - addTrueNegative
```
public double addTrueNegative()
```
    Adds a true negative with weight 1.
    
    Returns:
    
    The updated number of true negatives
  - addTrueNegative
```
public double addTrueNegative(double weight)
```
    Adds a true negative with a certain weight.
    
    Parameters:
    
    weight - The weight of the true negative
    
    Returns:
    
    The updated number of true negatives
  - removeTrueNegative
```
public double removeTrueNegative()
```
    Removes a true negative with weight 1.
    
    Returns:
    
    The updated number of true negatives
  - removeTrueNegative
```
public double removeTrueNegative(double weight)
```
    Removes a true negative with a certain weight.
    
    Parameters:
    
    weight - The weight of the true negative
    
    Returns:
    
    The updated number of true negatives
  - getFalseNegatives
```
public double getFalseNegatives()
```
    Returns the number of false negatives.
    
    Returns:
    
    The number of false negatives
  - setFalseNegatives
```
public void setFalseNegatives(double falseNegatives)
```
    Sets the number of false negatives.
    
    Parameters:
    
    falseNegatives - The number of false negatives to be set
  - addFalseNegative
```
public double addFalseNegative()
```
    Adds a false negative with weight 1.
    
    Returns:
    
    The updated number of false negatives
  - addFalseNegative
```
public double addFalseNegative(double weight)
```
    Adds a false negative with a certain weight.
    
    Parameters:
    
    weight - The weight of the false negative
    
    Returns:
    
    The updated number of false negatives
  - removeFalseNegative
```
public double removeFalseNegative()
```
    Removes a false negative with weight 1.
    
    Returns:
    
    The updated number of false negatives
  - removeFalseNegative
```
public double removeFalseNegative(double weight)
```
    Removes a false negative with a certain weight.
    
    Parameters:
    
    weight - The weight of the false negative
    
    Returns:
    
    The updated number of false negatives
  - getTotalPredictions
```
public double getTotalPredictions()
```
    Returns the total number of predictions.
    
    Returns:
    
    The total number of predictions
  - getCorrectPredictions
```
public double getCorrectPredictions()
```
    Returns the number of correct predictions.
    
    Returns:
    
    The number of correct predictions
  - getWrongPredictions
```
public double getWrongPredictions()
```
    Returns the number of wrong predictions.
    
    Returns:
    
    The number of wrong predictions
  - getPositivePredictions
```
public double getPositivePredictions()
```
    Returns the number of positive predictions.
    
    Returns:
    
    The number of positive predictions
  - getNegativePredictions
```
public double getNegativePredictions()
```
    Returns the number of negative predictions.
    
    Returns:
    
    The number of negative predictions
  - getPositiveExamples
```
public double getPositiveExamples()
```
    Returns the number of positive examples.
    
    Returns:
    
    The number of positive examples
  - getNegativeExamples
```
public double getNegativeExamples()
```
    Returns the number of negative examples.
    
    Returns:
    
    The number of negative examples
  - getConfusionMatrix
```
@NotNull
public @NotNull ConfusionMatrix getConfusionMatrix()
```
    Description copied from interface: Measurable
    
    Returns the confusion matrix that can be used to calculate the heuristic value of the Measurable.
    
    Specified by:
    
    getConfusionMatrix in interface Measurable
    
    Returns:
    
    The confusion matrix that can be used to calculate the heuristic value
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class ConfusionMatrix

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfusionMatrix

ConfusionMatrix

ConfusionMatrix

Method Detail

aggregate

getElement

addElement

addElement

removeElement

removeElement

clear

isEmpty

set

set

add

add

getTruePositives

setTruePositives

addTruePositive

addTruePositive

removeTruePositive

removeTruePositive

getFalsePositives

setFalsePositives

addFalsePositive

addFalsePositive

removeFalsePositive

removeFalsePositive

getTrueNegatives

setTrueNegatives

addTrueNegative

addTrueNegative

removeTrueNegative

removeTrueNegative

getFalseNegatives

setFalseNegatives

addFalseNegative

addFalseNegative

removeFalseNegative

removeFalseNegative

getTotalPredictions

getCorrectPredictions

getWrongPredictions

getPositivePredictions

getNegativePredictions

getPositiveExamples

getNegativeExamples

getConfusionMatrix

toString

hashCode

equals