PerformanceMetric

java.lang.Object
- java.lang.Enum<PerformanceMetric>
- - burlap.behavior.singleagent.auxiliary.performance.PerformanceMetric

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PerformanceMetric>
```
public enum PerformanceMetric
extends java.lang.Enum<PerformanceMetric>
```
Enumerator for the types of statistics that can be plotted by PerformancePlotter.

Author:

James MacGlashan

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AVERAGE_EPISODE_REWARD`
`CUMULATIVE_REWARD_PER_EPISODE`
`CUMULATIVE_REWARD_PER_STEP`
`CUMULATIVE_STEPS_PER_EPISODE`
`MEDIAN_EPISODE_REWARD`
`STEPS_PER_EPISODE`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static PerformanceMetric`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static PerformanceMetric[]`	`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
  - CUMULATIVE_REWARD_PER_STEP
```
public static final PerformanceMetric CUMULATIVE_REWARD_PER_STEP
```
  - CUMULATIVE_REWARD_PER_EPISODE
```
public static final PerformanceMetric CUMULATIVE_REWARD_PER_EPISODE
```
  - AVERAGE_EPISODE_REWARD
```
public static final PerformanceMetric AVERAGE_EPISODE_REWARD
```
  - MEDIAN_EPISODE_REWARD
```
public static final PerformanceMetric MEDIAN_EPISODE_REWARD
```
  - CUMULATIVE_STEPS_PER_EPISODE
```
public static final PerformanceMetric CUMULATIVE_STEPS_PER_EPISODE
```
  - STEPS_PER_EPISODE
```
public static final PerformanceMetric STEPS_PER_EPISODE
```
- Method Detail
  - values
```
public static PerformanceMetric[] 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 (PerformanceMetric c : PerformanceMetric.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PerformanceMetric 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

Enum PerformanceMetric

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CUMULATIVE_REWARD_PER_STEP

CUMULATIVE_REWARD_PER_EPISODE

AVERAGE_EPISODE_REWARD

MEDIAN_EPISODE_REWARD

CUMULATIVE_STEPS_PER_EPISODE

STEPS_PER_EPISODE

Method Detail

values

valueOf