xal.tools.math.r3

Enum R3.IND

java.lang.Object

java.lang.Enum<R3.IND>

xal.tools.math.r3.R3.IND

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<R3.IND>, IIndex

Enclosing class:

R3

public static enum R3.IND
extends java.lang.Enum<R3.IND>
implements IIndex

Class R3x3.IND is an enumeration of the matrix indices for the R3x3 class.

Since:

Oct 4, 2013

Enum Constant Summary

Enum Constants

Enum Constant and Description
X the x axis index of R3
Y the y axis index of R3
Z the z axis index of R3

Method Summary

Modifier and Type	Method and Description
int	val() Returns the value of the R3x3 matrix index that this enumeration constant represents.
static R3.IND	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static R3.IND[]	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

X

public static final R3.IND X

the x axis index of R³

Y

public static final R3.IND Y

the y axis index of R³

Z

public static final R3.IND Z

the z axis index of R³

Method Detail

values

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

Returns:

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

valueOf

public static R3.IND 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

val

public int val()

Returns the value of the R3x3 matrix index that this enumeration constant represents.

Specified by:

val in interface IIndex

Returns:

matrix index

Since:

Oct 4, 2013

See Also:

xal.tools.math.SquareMatrix.IIndex#val()