xal.tools.math.r3

Class R3x3

java.lang.Object

xal.tools.math.BaseMatrix<M>

xal.tools.math.SquareMatrix<R3x3>

xal.tools.math.r3.R3x3

All Implemented Interfaces:

java.io.Serializable, IArchive

public class R3x3
extends SquareMatrix<R3x3>
implements java.io.Serializable

Represents an element of R^3×3, the set of real, 3×3 matrices. The class also contains the usual set of matrix operations and linear transforms on R³ induced by the matrix.

See Also:

gov.sns.tools.r3.R3, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	R3x3.IND Class R3x3.IND is an enumeration of the matrix indices for the R3x3 class.
static class	R3x3.POS Enumeration for the element positions of an R3x3 matrix element.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INT_SIZE number of dimensions (DIM=3)

Fields inherited from class xal.tools.math.BaseMatrix

ATTR_DATA, matImpl

Constructor Summary

Constructors

Constructor and Description
R3x3() Creates a new instance of R3x3 initialized to zero.
R3x3(double[][] arrValues) Initializing constructor for class R3x3.
R3x3(R3x3 matInit) Copy Constructor - create a deep copy of the target matrix.
R3x3(java.lang.String strTokens) Parsing Constructor - create a R3x3 instance and initialize it according to a token string of element values.

Method Summary

Modifier and Type	Method and Description
R3x3	clone() Creates and returns a deep copy of this matrix.
static R3x3	copy(R3x3 matTarget) Create a deep copy of the given R3x3 matrix object.
double	getElem(R3x3.POS pos) Return matrix element value.
static R3x3	newIdentity() Create a new instance of the identity matrix
protected R3x3	newInstance() Handles object creation required by the base class.
static R3x3	newRotationX(double dblAng) Create and return the generator element of SO(3) which is a counter-clockwise rotation about the x axis.
static R3x3	newRotationY(double dblAng) Create and return the generator element of SO(3) which is a counter-clockwise rotation about the y axis.
static R3x3	newRotationZ(double dblAng) Create and return the generator element of SO(3) which is a counter-clockwise rotation about the z axis.
static R3x3	newZero() Create a new instance of a zero matrix.
static R3x3	parse(java.lang.String strTokens) Create a R3x3 instance and initialize it according to a token string of element values.
void	setElem(R3x3.IND i, R3x3.IND j, double s) Element assignment - assigns matrix element to the specified value
void	setElem(R3x3.POS pos, double val) Set the element specified by the position in the argument to the new value in the second argument.
R3	times(R3 vec) Nondestructive Matrix-Vector multiplication.

Methods inherited from class xal.tools.math.SquareMatrix

assignIdentity, conjugateInv, conjugateTrans, det, getSize, inverse, isEquivalentTo, isSymmetric, setElem, solve, solveInPlace, times, times, times, timesEquals, timesEquals, transpose

Methods inherited from class xal.tools.math.BaseMatrix

assignMatrix, assignZero, conditionNumber, copy, equals, getArrayCopy, getColCnt, getElem, getElem, getMatrix, getRowCnt, hashCode, load, max, minus, minusEquals, newInstance, norm1, norm2, normF, normInf, plus, plusEquals, print, save, setElem, setMatrix, setMatrix, setSubMatrix, toString, toStringMatrix, toStringMatrix, toStringMatrix

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INT_SIZE

public static final int INT_SIZE

number of dimensions (DIM=3)

See Also:

Constant Field Values

Constructor Detail

R3x3

public R3x3()

Creates a new instance of R3x3 initialized to zero.

R3x3

public R3x3(R3x3 matInit)

Copy Constructor - create a deep copy of the target matrix.

Parameters:

matInit - initial value

R3x3

public R3x3(double[][] arrValues)
     throws java.lang.ArrayIndexOutOfBoundsException

Initializing constructor for class R3x3. The values of the new matrix are set to the given Java primitive type array (the array itself is unchanged). The dimensions of the argument must be 3×3.

Parameters:

arrValues - initial values for the new matrix object

Throws:

java.lang.ArrayIndexOutOfBoundsException - the argument must have the dimensions 3×3

Since:

Oct 4, 2013

R3x3

public R3x3(java.lang.String strTokens)
     throws java.lang.IllegalArgumentException,
            java.lang.NumberFormatException

Parsing Constructor - create a R3x3 instance and initialize it according to a token string of element values. The token string argument is assumed to be one-dimensional and packed by column (ala FORTRAN).

Parameters:

strTokens - token vector of 3x3=9 numeric values

Throws:

java.lang.IllegalArgumentException - wrong number of token strings

java.lang.NumberFormatException - bad number format, unparseable

Method Detail

newZero

public static R3x3 newZero()

Create a new instance of a zero matrix.

Returns:

matrix whose elements are all zero

newIdentity

public static R3x3 newIdentity()

Create a new instance of the identity matrix

Returns:

identity matrix object

newRotationX

public static R3x3 newRotationX(double dblAng)

Create and return the generator element of SO(3) which is a counter-clockwise rotation about the x axis.

Parameters:

rotation - angle in radians

Returns:

x-plane counter-clockwise rotation matrix

newRotationY

public static R3x3 newRotationY(double dblAng)

Create and return the generator element of SO(3) which is a counter-clockwise rotation about the y axis.

Parameters:

rotation - angle in radians

Returns:

y-plane counter-clockwise rotation matrix

newRotationZ

public static R3x3 newRotationZ(double dblAng)

Create and return the generator element of SO(3) which is a counter-clockwise rotation about the z axis.

Parameters:

rotation - angle in radians

Returns:

z-plane counter-clockwise rotation matrix

copy

public static R3x3 copy(R3x3 matTarget)

Create a deep copy of the given R3x3 matrix object. The returned object is completely decoupled from the original.

Parameters:

matTarget - matrix to be copied

Returns:

a deep copy of the argument object

parse

public static R3x3 parse(java.lang.String strTokens)
                  throws java.lang.IllegalArgumentException,
                         java.lang.NumberFormatException

Create a R3x3 instance and initialize it according to a token string of element values. The token string argument is assumed to be one-dimensional and packed by column (ala FORTRAN).

Parameters:

strTokens - token vector of 3x3=9 numeric values

Throws:

java.lang.IllegalArgumentException - wrong number of token strings

java.lang.NumberFormatException - bad number format, unparseable

clone

public R3x3 clone()

Creates and returns a deep copy of this matrix.

Specified by:

clone in class BaseMatrix<R3x3>

Since:

Jul 3, 2014

See Also:

BaseMatrix.clone()

setElem

public void setElem(R3x3.IND i,
                    R3x3.IND j,
                    double s)
             throws java.lang.ArrayIndexOutOfBoundsException

Element assignment - assigns matrix element to the specified value

Parameters:

i - row index

j - column index

Throws:

java.lang.ArrayIndexOutOfBoundsException - index must be in {0,1,2}

setElem

public void setElem(R3x3.POS pos,
                    double val)

Set the element specified by the position in the argument to the new value in the second argument.

Parameters:

pos - matrix position

val - new element value

getElem

public double getElem(R3x3.POS pos)

Return matrix element value. Get matrix element value at specified position.

Parameters:

i - row index

j - column index

times

public R3 times(R3 vec)

Nondestructive Matrix-Vector multiplication.

Returns:

this*vec

newInstance

protected R3x3 newInstance()

Handles object creation required by the base class.

Specified by:

newInstance in class BaseMatrix<R3x3>

Returns:

uninitialized matrix object of type M

Since:

Jun 17, 2014

See Also:

BaseMatrix.newInstance()