TableOfConfusion (streams-core 1.0.10 API)

java.lang.Object
- stream.learner.evaluation.TableOfConfusion

```
public final class TableOfConfusion
extends Object
```
A data structure for computation of statistical values based on a 2x2 confusion matrix.

Look at the 2x2-case at http://en.wikipedia.org/wiki/Confusion_matrix for detailed descriptions.

Author:

Benedikt Kulmann, Lukas Kalabis

See Also:

ConfusionMatrix

Field Summary

Fields
Modifier and Type Field and Description

private long falseNegative

private long falsePositive

private long trueNegative

private long truePositive

Fields
Modifier and Type	Field and Description
`private long`	`falseNegative`
`private long`	`falsePositive`
`private long`	`trueNegative`
`private long`	`truePositive`

Constructor Summary

Constructors
Constructor and Description

TableOfConfusion()

Constructors
Constructor and Description
`TableOfConfusion()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFalseNegative()` Short form of `addFalseNegative(1)`.
`void`	`addFalseNegative(long delta)` Adds the amount specified by the argument `delta` to the internal data structure for the counting of false negative instances.
`void`	`addFalsePositive()` Short form of `addFalsePositive(1)`.
`void`	`addFalsePositive(long delta)` Adds the amount specified by the argument `delta` to the internal data structure for the counting of false positive instances.
`void`	`addTrueNegative()` Short form of `addTrueNegative(1)`.
`void`	`addTrueNegative(long delta)` Adds the amount specified by the argument `delta` to the internal data structure for the counting of true negative instances.
`void`	`addTruePositive()` Short form of `addTruePositive(1)`.
`void`	`addTruePositive(long delta)` Adds the amount specified by the argument `delta` to the internal data structure for the counting of true positive instances.
`double`	`calculateAccuracy()` Calculates and returns the accuracy value.
`double`	`calculateFScore()` Calculates and returns the f-score value.
`double`	`calculatePrecision()` Calculates and returns the precision value.
`double`	`calculateRecall()` Calculates and returns the recall value.
`double`	`calculateSpecificity()` Calculates and returns the specificity value.
`String`	`toString()` Returns a String representation of this table of confusion.
`String`	`toStringOld()`

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

- Field Detail
  - truePositive
```
private long truePositive
```
  - trueNegative
```
private long trueNegative
```
  - falsePositive
```
private long falsePositive
```
  - falseNegative
```
private long falseNegative
```
- Constructor Detail
  - TableOfConfusion
```
public TableOfConfusion()
```
- Method Detail
  - addTruePositive
```
public void addTruePositive()
```
    Short form of addTruePositive(1).
  - addTruePositive
```
public void addTruePositive(long delta)
```
    Adds the amount specified by the argument delta to the internal data structure for the counting of true positive instances.
    
    Parameters:
    
    delta - The amount to add to the true positive counter
  - addTrueNegative
```
public void addTrueNegative()
```
    Short form of addTrueNegative(1).
  - addTrueNegative
```
public void addTrueNegative(long delta)
```
    Adds the amount specified by the argument delta to the internal data structure for the counting of true negative instances.
    
    Parameters:
    
    delta - The amount to add to the true negative counter
  - addFalsePositive
```
public void addFalsePositive()
```
    Short form of addFalsePositive(1).
  - addFalsePositive
```
public void addFalsePositive(long delta)
```
    Adds the amount specified by the argument delta to the internal data structure for the counting of false positive instances.
    
    Parameters:
    
    delta - The amount to add to the false positive counter
  - addFalseNegative
```
public void addFalseNegative()
```
    Short form of addFalseNegative(1).
  - addFalseNegative
```
public void addFalseNegative(long delta)
```
    Adds the amount specified by the argument delta to the internal data structure for the counting of false negative instances.
    
    Parameters:
    
    delta - The amount to add to the false negative counter
  - calculatePrecision
```
public double calculatePrecision()
```
    Calculates and returns the precision value.
    
    Returns:
    
    The precision value.
  - calculateRecall
```
public double calculateRecall()
```
    Calculates and returns the recall value.
    
    Returns:
    
    The recall value.
  - calculateSpecificity
```
public double calculateSpecificity()
```
    Calculates and returns the specificity value.
    
    Returns:
    
    The specificity value.
  - calculateAccuracy
```
public double calculateAccuracy()
```
    Calculates and returns the accuracy value.
    
    Returns:
    
    The accuracy value.
  - calculateFScore
```
public double calculateFScore()
```
    Calculates and returns the f-score value.
    
    Returns:
    
    The f-score value.
  - toString
```
public String toString()
```
    Returns a String representation of this table of confusion. Specifically the returned String contains a representation of
    - Precision
    - Recall
    - Specifity
    - Accuracy
    - FScore
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A String representation of this object.
  - toStringOld
```
public String toStringOld()
```

Class TableOfConfusion

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

truePositive

trueNegative

falsePositive

falseNegative

Constructor Detail

TableOfConfusion

Method Detail

addTruePositive

addTruePositive

addTrueNegative

addTrueNegative

addFalsePositive

addFalsePositive

addFalseNegative

addFalseNegative

calculatePrecision

calculateRecall

calculateSpecificity

calculateAccuracy

calculateFScore

toString

toStringOld