uk.ac.manchester.cs.jfact.helpers

Enum StatIndex

java.lang.Object

java.lang.Enum<StatIndex>

uk.ac.manchester.cs.jfact.helpers.StatIndex

All Implemented Interfaces:

Serializable, Comparable<StatIndex>

public enum StatIndex
extends Enum<StatIndex>

stat index enum

Enum Constant Summary

Enum Constants

Enum Constant and Description
BRANCH Branch
DEPTH Depth
FREQ Freq
GENER Gener
SIZE Size

Method Summary

Modifier and Type	Method and Description
static int	choose(char c)
static int	getDepth(boolean pos, int[] stat) general access to a stat value by index
int	getIndex(boolean pos)
static void	incFreqValue(boolean pos, int[] stat) increment frequency value
static void	updateStatValues(DLVertex v, boolean posV, boolean pos, int[] stat, boolean debug) add-up all values at once by a given vertex
static void	updateStatValues(int d, int s, int b, int g, boolean pos, int[] stat, boolean debug) add-up all stat values at once by explicit values
static StatIndex	valueOf(String name) Returns the enum constant of this type with the specified name.
static StatIndex[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEPTH

public static final StatIndex DEPTH

Depth

SIZE

public static final StatIndex SIZE

Size

BRANCH

public static final StatIndex BRANCH

Branch

GENER

public static final StatIndex GENER

Gener

FREQ

public static final StatIndex FREQ

Freq

Method Detail

values

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

Returns:

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

valueOf

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

getIndex

public int getIndex(boolean pos)

Parameters:

pos - positive or negative

Returns:

index for stat

choose

public static int choose(char c)

Parameters:

c - stat

Returns:

index for chosen stat

updateStatValues

public static void updateStatValues(int d,
                                    int s,
                                    int b,
                                    int g,
                                    boolean pos,
                                    int[] stat,
                                    boolean debug)

add-up all stat values at once by explicit values

Parameters:

d - d

s - s

b - b

g - g

pos - pos

stat - stat

debug - true if debug values

updateStatValues

public static void updateStatValues(DLVertex v,
                                    boolean posV,
                                    boolean pos,
                                    int[] stat,
                                    boolean debug)

add-up all values at once by a given vertex

Parameters:

v - v

posV - posV

pos - pos

stat - stat

debug - true if debug values

incFreqValue

public static void incFreqValue(boolean pos,
                                int[] stat)

increment frequency value

Parameters:

pos - pos

stat - stat

getDepth

public static int getDepth(boolean pos,
                           int[] stat)

general access to a stat value by index

Parameters:

pos - pos

stat - stat

Returns:

depth