xal.tools.math.r3

Class R3

java.lang.Object

xal.tools.math.BaseVector<R3>

xal.tools.math.r3.R3

All Implemented Interfaces:

java.io.Serializable, IArchive

public class R3
extends BaseVector<R3>
implements java.io.Serializable

Represents an element of R^3, the three-dimensional cartesian real space.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	R3.IND Class R3x3.IND is an enumeration of the matrix indices for the R3x3 class.

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.BaseVector

ATTR_DATA

Constructor Summary

Constructors

Constructor and Description
R3() Creates a new instance of R3, the zero element.
R3(DataAdaptor daSource) Initializing constructor for R3.
R3(double[] arrVals) Creates a new instance of R3 initialized to argument.
R3(double x1, double x2, double x3) Creates a new instance of R3 initialized to arguments.
R3(R3 vecPt) Creates a new instance of R3 initialized to argument.
R3(java.lang.String strTokens) Create a new instance of R3 with specified initial value specified by the formatted string argument.

Method Summary

Modifier and Type	Method and Description
R3	cartesian2Cylindrical() Apply coordinate transform from cartesian to cylindrical coordinates.
R3	cartesian2Spherical() Apply coordinate transform from cartesian to spherical coordinates.
R3	clone() Creates and returns a deep copy of this vector.
R3	copy() Performs a deep copy operation.
R3	cylindrical2Cartesian() Apply coordinate transform from cylindrical to cartesian coordinates
double	get1() Return first coordinate value.
double	get2() Return second coordinate value.
double	get3() Return third coordinate value.
double	getx() Return first coordinate value.
double	gety() Return second coordinate value.
double	getz() Return third coordinate value.
protected R3	newInstance() Handles object creation required by the base class.
static R3	parse(java.lang.String strTokens) Create a new instance of R3 with initial value determined by the formatted string argument.
void	set(int i, double val) Set index to value.
void	set1(double x1) Set first coordinate value.
void	set2(double x2) Set second coordinate value.
void	set3(double x3) Set third coordinate value.
void	setAll(double s) Set all coordinates to value
void	setx(double x) Set first coordinate value.
void	sety(double y) Set second coordinate value.
void	setz(double z) Set third coordinate value.
R3	spherical2Cartesian() Apply coordinate tranform from spherical to cartesian coordinates
R3	squared() Returns the vector of squared elements.
R3	times(R3 r) Vector multiplication using three-dimensional cross product.
double[]	toArray() Get all the vector values as a 3-array.
java.lang.String	toString() Convert the vector contents to a string.
static R3	zero() Create a new instance of the zero vector.

Methods inherited from class xal.tools.math.BaseVector

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

Methods inherited from class java.lang.Object

equals, 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

R3

public R3()

Creates a new instance of R3, the zero element.

R3

public R3(double x1,
          double x2,
          double x3)

Creates a new instance of R3 initialized to arguments.

Parameters:

x1 - first coordinate value

x2 - first coordinate value

x3 - first coordinate value

Throws:

java.lang.ArrayIndexOutOfBoundsException - the argument must have the same length as this vector

R3

public R3(double[] arrVals)
   throws java.lang.ArrayIndexOutOfBoundsException

Creates a new instance of R3 initialized to argument. If the initializing array has length greater than 3 the first three values are taken, if it has length less than three then the remain coordinates of the new R3 object are zero.

Parameters:

arrVals - double array of initializing values

Throws:

java.lang.ArrayIndexOutOfBoundsException - the argument must have the same length as this vector

R3

public R3(R3 vecPt)

Creates a new instance of R3 initialized to argument.

Parameters:

vecPt - deep copies this value

R3

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

Create a new instance of R3 with specified initial value specified by the formatted string argument.

The string should be formatted as

"(x,y,z)"

where x, y, z are floating point representations.

Parameters:

strTokens - token string representing values phase coordinates

Throws:

java.lang.IllegalArgumentException - wrong number of tokens in argument (must be 6 or 7)

java.lang.NumberFormatException - bad numeric value, unparseable

R3

public R3(DataAdaptor daSource)

Initializing constructor for R3. Initial values are taken from the data source provided. The values are parsed from a numeric string and identified by the tag BaseVector#ATTR_Data.

Parameters:

daSource - interface to data source containing initialization data

Since:

Nov 5, 2013

Method Detail

zero

public static R3 zero()

Create a new instance of the zero vector.

Returns:

zero vector

parse

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

Create a new instance of R3 with initial value determined by the formatted string argument. The string should be formatted as "(x,y,z)" where x, y, z are floating point representations.

Parameters:

strTokens - six-token string representing values phase coordinates

Returns:

3-vector built from the given string representation

Throws:

java.lang.IllegalArgumentException - wrong number of tokens in argument (must be 6)

java.lang.NumberFormatException - bad numeric value, unparseable

copy

public R3 copy()

Performs a deep copy operation.

Returns:

cloned R3 object

set

public void set(int i,
                double val)
         throws java.lang.ArrayIndexOutOfBoundsException

Set index to value.

Parameters:

i - element index 0<=i<=2

val - new element value

Throws:

java.lang.ArrayIndexOutOfBoundsException - the index i was greater than 2

set1

public void set1(double x1)

Set first coordinate value.

Parameters:

x1 - first coordinate of 3-vector

set2

public void set2(double x2)

Set second coordinate value.

Parameters:

x2 - second coordinate of 3-vector

set3

public void set3(double x3)

Set third coordinate value.

Parameters:

x3 - third coordinate of 3-vector

setx

public void setx(double x)

Set first coordinate value.

Parameters:

x - first coordinate of 3-vector

sety

public void sety(double y)

Set second coordinate value.

Parameters:

y - second coordinate of 3-vector

setz

public void setz(double z)

Set third coordinate value.

Parameters:

z - first coordinate of 3-vector

setAll

public void setAll(double s)

Set all coordinates to value

Parameters:

s - new value of all vector coordinates

toArray

public double[] toArray()

Get all the vector values as a 3-array.

Returns:

the array {x₁, x₂, x₃}.

get1

public double get1()

Return first coordinate value.

Returns:

the first vector coordinate

get2

public double get2()

Return second coordinate value.

Returns:

the second coordinate vector

get3

public double get3()

Return third coordinate value.

Returns:

the third coordinate vector

getx

public double getx()

Return first coordinate value.

Returns:

the first coordinate vector

gety

public double gety()

Return second coordinate value.

Returns:

the second coordinate vector

getz

public double getz()

Return third coordinate value.

Returns:

the third coordinate vector

clone

public R3 clone()

Creates and returns a deep copy of this vector.

Specified by:

clone in class BaseVector<R3>

Since:

Jul 3, 2014

See Also:

BaseVector.clone()

toString

public java.lang.String toString()

Convert the vector contents to a string.

Overrides:

toString in class BaseVector<R3>

Returns:

vector value as a string (x, y, z)

cartesian2Cylindrical

public R3 cartesian2Cylindrical()

Apply coordinate transform from cartesian to cylindrical coordinates.

Returns:

polar coordinates (r,phi,z) of this cartesian point

cartesian2Spherical

public R3 cartesian2Spherical()

Apply coordinate transform from cartesian to spherical coordinates.

Returns:

polar coordinates (R, theta, phi) of this cartesian point

cylindrical2Cartesian

public R3 cylindrical2Cartesian()

Apply coordinate transform from cylindrical to cartesian coordinates

Returns:

cartesian coordinates (x,y,z) of this cylindrical point

spherical2Cartesian

public R3 spherical2Cartesian()

Apply coordinate tranform from spherical to cartesian coordinates

Returns:

cartesian coordinates (x,y,z) of this sphereical point

times

public R3 times(R3 r)

Vector multiplication using three-dimensional cross product.

Parameters:

r - second (right) operand in cross-product (this is first operand)

Returns:

result of vector cross product in three space

squared

public R3 squared()

Returns the vector of squared elements.

Returns:

the vector (x₁², x₂², x₃²)

Since:

Aug 25, 2011

newInstance

protected R3 newInstance()

Handles object creation required by the base class.

Specified by:

newInstance in class BaseVector<R3>

Returns:

uninitialized vector object of type V

Since:

Jun 17, 2014

See Also:

BaseVector.newInstance()