xal.tools.math.r4

Enum R4.IND

java.lang.Object

java.lang.Enum<R4.IND>

xal.tools.math.r4.R4.IND

All Implemented Interfaces:

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

Enclosing class:

R4

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

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

Since:

Oct 4, 2013

Enum Constant Summary

Enum Constants

Enum Constant and Description
X1 the 1st axis index of R6
X2 the 2nd axis index of R6
X3 the rd axis index of R6
X4 the rd axis index of R6

Method Summary

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

X1

public static final R4.IND X1

the 1st axis index of R⁶

X2

public static final R4.IND X2

the 2nd axis index of R⁶

X3

public static final R4.IND X3

the rd axis index of R⁶

X4

public static final R4.IND X4

the rd axis index of R⁶

Method Detail

values

public static R4.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 (R4.IND c : R4.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 R4.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()