edu.ucla.sspace.matrix

Enum Statistics.Dimension

java.lang.Object

java.lang.Enum<Statistics.Dimension>

edu.ucla.sspace.matrix.Statistics.Dimension

All Implemented Interfaces:

Serializable, Comparable<Statistics.Dimension>

Enclosing class:

Statistics

public static enum Statistics.Dimension
extends Enum<Statistics.Dimension>

The dimension over which the statistic should be evaluated. For ALL, only one average value, or one standard deviation value will be computed for an entire matrix.

For ROW, an average value, or a standard deviation, will be computed for each row in the matrix.

For COLUMN, an average value, or a standard deviation, will be computed for each column in the matrix.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL
COLUMN
ROW

Method Summary

Methods

Modifier and Type	Method and Description
static Statistics.Dimension	valueOf(String name) Returns the enum constant of this type with the specified name.
static Statistics.Dimension[]	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

ALL

public static final Statistics.Dimension ALL

ROW

public static final Statistics.Dimension ROW

COLUMN

public static final Statistics.Dimension COLUMN

Method Detail

values

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

Returns:

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

valueOf

public static Statistics.Dimension 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