Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

## com.epochx.stats
Enum RunStatField

    java.lang.Object
      java.lang.Enum<RunStatField>
          com.epochx.stats.RunStatField

All Implemented Interfaces:
  java.io.Serializable, java.lang.Comparable<RunStatField>

    public enum RunStatField

extends java.lang.Enum<RunStatField>

This enum gives all the available run statistics that can be requested. Run statistics are those statistics that are generated at the end of each run. Each RunStatField has a datatype related to it which is the type which the data will be returned in.

See Also:
  `RunStatListener`, `CrossoverStatField`, `MutationStatField`, `GenerationStatField`

Enum Constant Summary
`BEST_FITNESS` Requests a Double which is the fitness of the BEST_PROGRAM.
`BEST_PROGRAM` Requests a CandidateProgram which has the 'best' fitness over a whole run.
`RUN_TIME` Requests a Long which is the length of time in nanoseconds that the run took to complete.

Method Summary
`static RunStatField` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static RunStatField[]` | `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

### BEST_PROGRAM

    public static final RunStatField BEST_PROGRAM

  Requests a CandidateProgram which has the 'best' fitness over a whole run. This usually means the program with the lowest fitness score. If elitism is not being used, the BEST_PROGRAM may not be in the final generation.

### BEST_FITNESS

    public static final RunStatField BEST_FITNESS

  Requests a Double which is the fitness of the BEST_PROGRAM.

### RUN_TIME

    public static final RunStatField RUN_TIME

  Requests a Long which is the length of time in nanoseconds that the run took to complete.

Method Detail

### values

    public static RunStatField[] 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 (RunStatField c : RunStatField.values())
          System.out.println(c);

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

### valueOf

    public static RunStatField 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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD