AnomalyMetrics (Tribuo 4.1.1 API)

java.lang.Object
- java.lang.Enum<AnomalyMetrics>
- - org.tribuo.anomaly.evaluation.AnomalyMetrics

All Implemented Interfaces:

Serializable, Comparable<AnomalyMetrics>
```
public enum AnomalyMetrics
extends Enum<AnomalyMetrics>
```
Default metrics for evaluating anomaly detection.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`F1` The F_1 score, i.e., the harmonic mean of the precision and the recall.
`FN` The number of false negatives.
`FP` The number of false positives.
`PRECISION` The precision, i.e., the true positives divided by the predicted positives.
`RECALL` The recall, i.e., the true positives divided by the ground truth positives.
`TN` The number of true negatives.
`TP` The number of true positives.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AnomalyMetrics`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AnomalyMetrics[]`	`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 AnomalyMetrics TP
```
    The number of true positives.
  - FP
```
public static final AnomalyMetrics FP
```
    The number of false positives.
  - TN
```
public static final AnomalyMetrics TN
```
    The number of true negatives.
  - FN
```
public static final AnomalyMetrics FN
```
    The number of false negatives.
  - PRECISION
```
public static final AnomalyMetrics PRECISION
```
    The precision, i.e., the true positives divided by the predicted positives.
  - RECALL
```
public static final AnomalyMetrics RECALL
```
    The recall, i.e., the true positives divided by the ground truth positives.
  - F1
```
public static final AnomalyMetrics F1
```
    The F_1 score, i.e., the harmonic mean of the precision and the recall.
- Method Detail
  - values
```
public static AnomalyMetrics[] 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 (AnomalyMetrics c : AnomalyMetrics.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AnomalyMetrics valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum AnomalyMetrics

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

TP

FP

TN

FN

PRECISION

RECALL

F1

Method Detail

values

valueOf