xal.tools.math.r2

Class R2x2

java.lang.Object

xal.tools.math.BaseMatrix<M>

xal.tools.math.SquareMatrix<R2x2>

xal.tools.math.r2.R2x2

All Implemented Interfaces:

java.io.Serializable, IArchive

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

Represents an element of R2x2, the set of real 3x3 matrices. The class a set of the usual matrix operations and linear transforms on R3 represented by the matrix.

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	R2x2.IND Enumeration of the allowed index positions for objects of type R2x2.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INT_SIZE Matrix size

Fields inherited from class xal.tools.math.BaseMatrix

ATTR_DATA, matImpl

Constructor Summary

Constructors

Constructor and Description
R2x2() Creates a new instance of R2x2 initialized to zero.
R2x2(R2x2 matParent) Copy Constructor - create a deep copy of the given matrix.
R2x2(java.lang.String strTokens) Parsing Constructor - create a R2x2 instance and initialize it according to a token string of element values.

Method Summary

Modifier and Type	Method and Description
R2x2	clone() Creates and returns a deep copy of this matrix.
static R2x2	clone(R2x2 matTarget) Create a deep copy of the given R2x2 matrix object.
double	getElem(R2x2.IND iRow, R2x2.IND iCol) Return matrix element value.
static R2x2	newIdentity() Create and return a new identity matrix
protected R2x2	newInstance() Handles object creation required by the base class.
static R2x2	newRotation(double dblAng) Create and return the generator element of SO(2) which is a counter-clockwise rotation.
static R2x2	newSymplectic()
static R2x2	newZero() Create and return a new instance of a zero matrix.
static R2x2	parse(java.lang.String strTokens) Create a R2x2 instance and initialize it according to a token string of element values.
void	setElem(R2x2.IND iRow, R2x2.IND iCol, double dblVal) Set the element the given indices to the new value.
R2	times(R2 vec) Non-destructive 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

Matrix size

See Also:

Constant Field Values

Constructor Detail

R2x2

public R2x2()

Creates a new instance of R2x2 initialized to zero.

R2x2

public R2x2(R2x2 matParent)

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

Parameters:

matParent - initial value

R2x2

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

Parsing Constructor - create a R2x2 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 2x2=4 numeric values

Throws:

java.lang.IllegalArgumentException - wrong number of token strings

java.lang.NumberFormatException - bad number format, unparseable

Method Detail

newZero

public static R2x2 newZero()

Create and return a new instance of a zero matrix.

Returns:

a matrix with all zero elements

newIdentity

public static R2x2 newIdentity()

Create and return a new identity matrix

Returns:

identity matrix object

newSymplectic

public static R2x2 newSymplectic()

newRotation

public static R2x2 newRotation(double dblAng)

Create and return the generator element of SO(2) which is a counter-clockwise rotation.

Parameters:

rotation - angle in radians

Returns:

x-plane counter-clockwise rotation matrix

clone

public static R2x2 clone(R2x2 matTarget)

Create a deep copy of the given R2x2 matrix object. The returned object shares no references with the argument.

Parameters:

matTarget - matrix to be copied

Returns:

a deep copy of the argument object

parse

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

Create a R2x2 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 2x2=4 numeric values

Throws:

java.lang.IllegalArgumentException - wrong number of token strings

java.lang.NumberFormatException - bad number format, unparseable

clone

public R2x2 clone()

Creates and returns a deep copy of this matrix.

Specified by:

clone in class BaseMatrix<R2x2>

Since:

Jul 3, 2014

See Also:

BaseMatrix.clone()

setElem

public void setElem(R2x2.IND iRow,
                    R2x2.IND iCol,
                    double dblVal)

Set the element the given indices to the new value.

Parameters:

iRow - matrix row location

iCol - matrix column index

val - matrix element at given row and column will be set to this value

getElem

public double getElem(R2x2.IND iRow,
                      R2x2.IND iCol)

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

Parameters:

iRow - row index

iCol - column index

Returns:

the matrix element at the position specified by the indices.

times

public R2 times(R2 vec)

Non-destructive Matrix-Vector multiplication. Specifically, the vector y given by

y = Ax

where A is this matrix and x is the given vector.

Parameters:

vec - the vector factor x

Returns:

the matrix-vector product of this matrix with the given vector

newInstance

protected R2x2 newInstance()

Handles object creation required by the base class.

Specified by:

newInstance in class BaseMatrix<R2x2>

Returns:

uninitialized matrix object of type M

Since:

Jun 17, 2014

See Also:

BaseMatrix.newInstance()