Package xal.tools.math.r4

Class R4

java.lang.Object

xal.tools.math.BaseVector<R4>

xal.tools.math.r4.R4

All Implemented Interfaces:

Serializable, IArchive

public class R4
extends BaseVector<R4>

Implements the set of real 4-vectors in R⁴

Since:

Oct 15, 2013

Author:

Christopher K. Allen

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	R4.IND	Class R4x4.IND is an enumeration of the matrix indices for the R4x4 class.

Field Summary

Fields

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

Fields inherited from class xal.tools.math.BaseVector

ATTR_DATA

Constructor Summary

Constructors

Constructor	Description
R4()	Constructor for R6.
R4(double[] arrVals)	Initializing constructor for bases class Vector.
R4(R4 matParent)	Copy constructor for R4.

Method Summary

Modifier and Type	Method	Description
R4	clone()	Creates and returns a deep copy of this vector.
protected R4	newInstance(double[] arrVecInt)	Creates a new instance of this vector type with the given Java array as the internal representation.
protected R4	newInstance(int size)	Handles object creation required by the base class.
static R4	newZero()	Create a new instance of a zero vector.

Methods inherited from class xal.tools.math.BaseVector

assignUnity, assignZero, copyVector, embedIn, equals, getArrayCopy, getElem, getElem, getSize, getVector, hashCode, innerProd, isEquivalentTo, leftMultiply, load, minus, minusEquals, negate, negateEquals, newInstance, norm1, norm2, normInf, plus, plusEquals, print, print, println, projectOnto, rightMultiply, save, setElem, setElem, setVector, setVector, setVector, times, timesEquals, toString

Methods inherited from class java.lang.Object

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

Field Details

INT_SIZE

public static final int INT_SIZE

number of dimensions (DIM=3)

See Also:

• Constant Field Values

Constructor Details

R4

public R4()
   throws UnsupportedOperationException

Constructor for R6.

Throws:

UnsupportedOperationException

Since:

Oct 15, 2013

R4

public R4(double[] arrVals)
   throws IllegalArgumentException

Initializing constructor for bases class Vector. Sets the entire matrix to the values given in the Java primitive type double array. The argument itself remains unchanged.

The dimensions of the given Java double array must be consistent with the size of the matrix. Thus, if the arguments are inconsistent, an exception is thrown.

Parameters:

arrVals - Java primitive array containing new vector values

Throws:

IllegalArgumentException - the argument must have the same dimensions as this matrix

Since:

Oct 16, 2013

R4

public R4(R4 matParent)

Copy constructor for R4. Creates a cloned copy of the given parent object.

Parameters:

matParent - template object for which the deep copy is performed

Since:

Jul 3, 2014

Method Details

newZero

public static R4 newZero()

Create a new instance of a zero vector.

Returns:

zero vector

clone

public R4 clone()

Creates and returns a deep copy of this vector.

Specified by:

clone in class BaseVector<R4>

Since:

Jul 3, 2014

See Also:

• BaseVector.clone()

newInstance

protected R4 newInstance(int size)

Handles object creation required by the base class.

Specified by:

newInstance in class BaseVector<R4>

Returns:

uninitialized vector object of type V

Since:

Jun 17, 2014

See Also:

• xal.tools.math.BaseVector#newInstance()

newInstance

protected R4 newInstance(double[] arrVecInt)

Description copied from class: BaseVector

Creates a new instance of this vector type with the given Java array as the internal representation.

Specified by:

newInstance in class BaseVector<R4>

Parameters:

arrVecInt - new vector's guts

Returns:

new instance of this vector type with the internal representation

Since:

Jul 24, 2015 by Christopher K. Allen

See Also:

• BaseVector.newInstance(double[])