PhaseVector

java.lang.Object
- xal.tools.math.BaseVector<PhaseVector>
- - xal.tools.beam.PhaseVector

All Implemented Interfaces:

java.io.Serializable, IArchive
```
public class PhaseVector
extends BaseVector<PhaseVector>
implements java.io.Serializable, IArchive
```
Class .

Since:

Oct 11, 2013

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PhaseVector.IND
Enumeration for the element position indices for homogeneous phase space objects.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PhaseVector.IND` Enumeration for the element position indices for homogeneous phase space objects.

Field Summary
- Fields inherited from class xal.tools.math.BaseVector
  ATTR_DATA

Constructor Summary

Constructors
Constructor and Description
`PhaseVector()` Creates a new instance of PhaseVector with zero initial value.
`PhaseVector(DataAdaptor daSource)` Create a new `PhaseVector` object and initialize it with the data behind the `DataAdaptor` data source.
`PhaseVector(double[] arrVal)` Create a new instance of PhaseVector with specified initial value.
`PhaseVector(double x, double xp, double y, double yp, double z, double zp)` Create a new instance of `PhaseVector` with specified initial value.
`PhaseVector(PhaseVector vecInit)` Copy Constructor Creates new `PhaseVector` object which is a deep copy of the given argument.
`PhaseVector(R3 vecPos, R3 vecMom)` Create a new instance of PhaseVector with specified initial value.
`PhaseVector(java.lang.String strTokens)` Create a new instance of PhaseVector with specified initial value specified by the formatted string argument.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assignZero()` We need to redefine this method in order to set the homogeneous coordinate back to unity.
`PhaseVector`	`clone()` Creates and returns a deep copy of this vector.
`static PhaseVector`	`copy(PhaseVector vecParent)` Creates a deep copy of the given `PhaseVector` object.
`static PhaseVector`	`embed(R4 vecCoords)` Embeds the given vector z ∈ R⁴ into homogeneous phase space.
`static PhaseVector`	`embed(R6 vecCoords)` Embeds the given vector z ∈ R⁶ into homogeneous phase space.
`R3`	`getMomentum()` Get momentum coordinate in R3.
`R3`	`getPosition()` Get position coordinates in R3.
`double`	`getx()` Return the x position coordinate
`double`	`getxp()` Return the x momentum coordinate
`double`	`gety()` Return the y position coordinate
`double`	`getyp()` Return the y momentum coordinate
`double`	`getz()` Return the z momentum coordinate
`double`	`getzp()` Return the z momentum coordinate
`double`	`innerProd(PhaseVector v)` Must override to account for the homogeneous coordinate.
`static void`	`main(java.lang.String[] arrArgs)` Test driver
`PhaseVector`	`minus(PhaseVector vecSub)` Must override to protect the homogeneous coordinate.
`void`	`minusEquals(PhaseVector vecSub)` Must override to protect the homogeneous coordinate.
`PhaseVector`	`negate()` Must override to protect the homogeneous coordinate.
`void`	`negateEquals()` Must override to protect the homogeneous coordinate.
`protected PhaseVector`	`newInstance()` Handles object creation required by the base class.
`static PhaseVector`	`newZero()` Create a new instance of a zero phase vector.
`double`	`norm1()` Return the l₁ norm of the vector.
`double`	`norm2()` Return the l₂ norm of the vector.
`double`	`normInf()` Return the l_{∞ norm of the vector.}
`PhaseMatrix`	`outerProd(PhaseVector vec)` Vector outer product operation.
`static PhaseVector`	`parse(java.lang.String strTokens)` Create a new instance of PhaseVector with initial value determined by the formatted string argument.
`PhaseVector`	`plus(PhaseVector vecAdd)` Must override to protect the homogeneous coordinate.
`void`	`plusEquals(PhaseVector vecAdd)` Must override to protect the homogeneous coordinate.
`void`	`print(java.io.PrintWriter os)` Print the vector contents to an output stream, does not add new line.
`void`	`println(java.io.PrintWriter os)` Print the vector contents to an output stream, add new line character.
`java.lang.String`	`printString()` Print the vector contents to a String.
`void`	`setElem(PhaseIndex i, double dblVal)` Set the element at index.
`void`	`setVector(double[] arrVector)` Must override this method to ignore any missing homogeneous coordinate since it is understood that this value is always there and unchanging.
`void`	`setVector(java.lang.String strValues)` Must override this method to ignore any missing homogeneous coordinate since it is understood that this value is always there and unchanging.
`void`	`setx(double dblVal)` Set the x position coordinate
`void`	`setxp(double dblVal)` Set the x momentum coordinate
`void`	`sety(double dblVal)` Set the y position coordinate
`void`	`setyp(double dblVal)` Set the y momentum coordinate
`void`	`setz(double dblVal)` Set the z position coordinate
`void`	`setzp(double dblVal)` Set the z momentum coordinate
`PhaseVector`	`times(double s)` Must override to protect the homogeneous coordinate.
`void`	`timesEquals(double s)` Must override to protect the homogeneous coordinate.

Methods inherited from class xal.tools.math.BaseVector
assignUnity, copyVector, embedIn, getArrayCopy, getElem, getElem, getSize, hashCode, isEquivalentTo, leftMultiply, load, print, projectOnto, rightMultiply, save, setElem, setElem, setVector, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface xal.tools.data.IArchive
load, save

- Constructor Detail
  - PhaseVector
```
public PhaseVector()
```
    Creates a new instance of PhaseVector with zero initial value.
  - PhaseVector
```
public PhaseVector(double x,
                   double xp,
                   double y,
                   double yp,
                   double z,
                   double zp)
```
    Create a new instance of PhaseVector with specified initial value.
    
    Parameters:
    
    x - x-plane position
    
    xp - x-plane momentum
    
    y - y-plane position
    
    yp - y-plane momentum
    
    z - z-plane position
    
    zp - z-plane momentum
  - PhaseVector
```
public PhaseVector(PhaseVector vecInit)
```
    Copy Constructor Creates new PhaseVector object which is a deep copy of the given argument.
    
    Parameters:
    
    vecInit - initial value
  - PhaseVector
```
public PhaseVector(double[] arrVal)
```
    Create a new instance of PhaseVector with specified initial value.
    
    Parameters:
    
    arrVal - length 6 array of initial values
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - argument must be a length-six array
  - PhaseVector
```
public PhaseVector(R3 vecPos,
                   R3 vecMom)
```
    Create a new instance of PhaseVector with specified initial value.
    
    Parameters:
    
    vecPos - position vector (x,y,z) in R3
    
    vecMom - momentum vector (xp, yp, zp) in R3
  - PhaseVector
```
public PhaseVector(DataAdaptor daSource)
            throws DataFormatException
```
    Create a new PhaseVector object and initialize it with the data behind the DataAdaptor data source.
    
    Parameters:
    
    daSource - data source containing initialization data
    
    Throws:
    
    DataFormatException - malformed data
    
    See Also:
    
    IArchive.load(xal.tools.data.DataAdaptor)
  - PhaseVector
```
public PhaseVector(java.lang.String strTokens)
            throws java.lang.NumberFormatException,
                   java.lang.IllegalArgumentException
```
    Create a new instance of PhaseVector with specified initial value specified by the formatted string argument. The input string may or may not contain the final coordinate which always has value 1. The string should be formatted as "(x,x',y,y',z,zp')" where x, x', y, y', z, 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, un-parseable
    
    See Also:
    
    setVector(java.lang.String)
- Method Detail
  - newZero
```
public static PhaseVector newZero()
```
    Create a new instance of a zero phase vector.
    
    Returns:
    
    zero vector
  - copy
```
public static PhaseVector copy(PhaseVector vecParent)
```
    Creates a deep copy of the given PhaseVector object. Thus, the argument is unmodified and unreferenced.
    
    Parameters:
    
    vecParent - vector object to clone
    
    Returns:
    
    deep copy of the argument
  - parse
```
public static PhaseVector parse(java.lang.String strTokens)
                         throws java.lang.NumberFormatException,
                                java.lang.IllegalArgumentException
```
    Create a new instance of PhaseVector with initial value determined by the formatted string argument. The string should be formatted as "(x,x',y,y',z,zp')" where x, x', y, y', z, z' are floating point representations.
    
    Parameters:
    
    strTokens - six-token string representing values phase coordinates
    
    Throws:
    
    java.lang.IllegalArgumentException - wrong number of tokens in argument (must be 6)
    
    java.lang.NumberFormatException - bad numeric value, unparseable
  - embed
```
public static PhaseVector embed(R6 vecCoords)
```
    Embeds the given vector z ∈ R⁶ into homogeneous phase space. The given vector is treated like a vector of phase space coordinates corresponding to the first 6 elements of a PhaseVector object. The last element of the returned phase vector has value 1, as do all phase vectors.
    
    Parameters:
    
    vecCoords - vector z containing the first 6 element values of the returned phase vector
    
    Returns:
    
    the augmented vector (z,1)
    
    Since:
    
    Oct 16, 2013
  - embed
```
public static PhaseVector embed(R4 vecCoords)
```
    Embeds the given vector z ∈ R⁴ into homogeneous phase space. The given vector is treated like a vector of transverse phase space coordinates corresponding to the first 4 elements of a PhaseVector object. The vector elements corresonding to the longitudinal phase space coordinates z and z' are both set to zero. The last element of the returned phase vector has value 1, as do all phase vectors.
    
    Parameters:
    
    vecCoords - vector z containing the first 6 element values of the returned phase vector
    
    Returns:
    
    the augmented vector (z,1)
    
    Since:
    
    Oct 16, 2013
  - setVector
```
public void setVector(java.lang.String strValues)
```
    Must override this method to ignore any missing homogeneous coordinate since it is understood that this value is always there and unchanging.
    
    Overrides:
    
    setVector in class BaseVector<PhaseVector>
    
    Parameters:
    
    strValues - token vector of SIZE² numeric values
    
    Since:
    
    Sep 6, 2014
    
    See Also:
    
    BaseVector.setVector(java.lang.String)
  - setVector
```
public void setVector(double[] arrVector)
               throws java.lang.ArrayIndexOutOfBoundsException
```
    Must override this method to ignore any missing homogeneous coordinate since it is understood that this value is always there and unchanging.
    
    Overrides:
    
    setVector in class BaseVector<PhaseVector>
    
    Parameters:
    
    arrVector - Java primitive array containing new vector values
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - the argument must have the same dimensions as this matrix
    
    Since:
    
    Sep 6, 2014
    
    See Also:
    
    BaseVector.setVector(double[])
  - setElem
```
public void setElem(PhaseIndex i,
                    double dblVal)
```
    Set the element at index. Note that you cannot change the last element value, it must remain 1.
    
    Parameters:
    
    i - index of new element value
  - setx
```
public void setx(double dblVal)
```
    Set the x position coordinate
  - setxp
```
public void setxp(double dblVal)
```
    Set the x momentum coordinate
  - sety
```
public void sety(double dblVal)
```
    Set the y position coordinate
  - setyp
```
public void setyp(double dblVal)
```
    Set the y momentum coordinate
  - setz
```
public void setz(double dblVal)
```
    Set the z position coordinate
  - setzp
```
public void setzp(double dblVal)
```
    Set the z momentum coordinate
  - getx
```
public double getx()
```
    Return the x position coordinate
  - getxp
```
public double getxp()
```
    Return the x momentum coordinate
  - gety
```
public double gety()
```
    Return the y position coordinate
  - getyp
```
public double getyp()
```
    Return the y momentum coordinate
  - getz
```
public double getz()
```
    Return the z momentum coordinate
  - getzp
```
public double getzp()
```
    Return the z momentum coordinate
  - getPosition
```
public R3 getPosition()
```
    Get position coordinates in R3.
    
    Returns:
    
    (x,y,z)
  - getMomentum
```
public R3 getMomentum()
```
    Get momentum coordinate in R3.
    
    Returns:
    
    (xp,yp,zp)
  - outerProd
```
public PhaseMatrix outerProd(PhaseVector vec)
```
    Vector outer product operation. Returns the tensor outer product as a PhaseMatrix object
    
    Parameters:
    
    vec - second argument to tensor product
    
    Returns:
    
    outer product = [ this_i*vec_j ]
  - newInstance
```
protected PhaseVector newInstance()
```
    Handles object creation required by the base class.
    
    Specified by:
    
    newInstance in class BaseVector<PhaseVector>
    
    Returns:
    
    uninitialized vector object of type V
    
    Since:
    
    Jun 17, 2014
    
    See Also:
    
    BaseVector.newInstance()
  - assignZero
```
public void assignZero()
```
    We need to redefine this method in order to set the homogeneous coordinate back to unity.
    
    Overrides:
    
    assignZero in class BaseVector<PhaseVector>
    
    Since:
    
    Nov 6, 2014
    
    See Also:
    
    BaseVector.assignZero()
  - negate
```
public PhaseVector negate()
```
    Must override to protect the homogeneous coordinate.
    
    Overrides:
    
    negate in class BaseVector<PhaseVector>
    
    Returns:
    
    antipodal vector of the current object
    
    Since:
    
    Jan 7, 2015 by Christopher K. Allen
    
    See Also:
    
    BaseVector.negate()
  - negateEquals
```
public void negateEquals()
```
    Must override to protect the homogeneous coordinate.
    
    Overrides:
    
    negateEquals in class BaseVector<PhaseVector>
    
    Since:
    
    Jan 7, 2015 by Christopher K. Allen
    
    See Also:
    
    BaseVector.negateEquals()
  - plusEquals
```
public void plusEquals(PhaseVector vecAdd)
```
    Must override to protect the homogeneous coordinate.
    
    Overrides:
    
    plusEquals in class BaseVector<PhaseVector>
    
    Parameters:
    
    vecAdd - Vector to add to this vector (addend)
    
    Since:
    
    Jan 7, 2015 by Christopher K. Allen
    
    See Also:
    
    BaseVector.plusEquals(xal.tools.math.BaseVector)
  - plus
```
public PhaseVector plus(PhaseVector vecAdd)
```
    Must override to protect the homogeneous coordinate.
    
    Overrides:
    
    plus in class BaseVector<PhaseVector>
    
    Parameters:
    
    vecAdd - vector added to this one (addend)
    
    Returns:
    
    sum of this vector and given vector,
    
    Since:
    
    Jan 7, 2015 by Christopher K. Allen
    
    See Also:
    
    BaseVector.plus(xal.tools.math.BaseVector)
  - minusEquals
```
public void minusEquals(PhaseVector vecSub)
```
    Must override to protect the homogeneous coordinate.
    
    Overrides:
    
    minusEquals in class BaseVector<PhaseVector>
    
    Parameters:
    
    vecSub - Vector to subtract from this vector (subtrahend)
    
    Since:
    
    Jan 7, 2015 by Christopher K. Allen
    
    See Also:
    
    BaseVector.minusEquals(xal.tools.math.BaseVector)
  - minus
```
public PhaseVector minus(PhaseVector vecSub)
```
    Must override to protect the homogeneous coordinate.
    
    Overrides:
    
    minus in class BaseVector<PhaseVector>
    
    Parameters:
    
    vecSub - vector subtracted from this one (subtrahend)
    
    Returns:
    
    difference of this vector and the given vector,
    
    Since:
    
    Jan 7, 2015 by Christopher K. Allen
    
    See Also:
    
    BaseVector.minus(xal.tools.math.BaseVector)
  - times
```
public PhaseVector times(double s)
```
    Must override to protect the homogeneous coordinate.
    
    Overrides:
    
    times in class BaseVector<PhaseVector>
    
    Parameters:
    
    s - scalar value
    
    Returns:
    
    result of scalar multiplication
    
    Since:
    
    Jan 7, 2015 by Christopher K. Allen
    
    See Also:
    
    BaseVector.times(double)
  - timesEquals
```
public void timesEquals(double s)
```
    Must override to protect the homogeneous coordinate.
    
    Overrides:
    
    timesEquals in class BaseVector<PhaseVector>
    
    Parameters:
    
    s - scalar
    
    Since:
    
    Jan 7, 2015 by Christopher K. Allen
    
    See Also:
    
    BaseVector.timesEquals(double)
  - innerProd
```
public double innerProd(PhaseVector v)
                 throws java.lang.IllegalArgumentException
```
    Must override to account for the homogeneous coordinate.
    
    Overrides:
    
    innerProd in class BaseVector<PhaseVector>
    
    Parameters:
    
    v - second vector
    
    Returns:
    
    inner product of this vector and argument
    
    Throws:
    
    java.lang.IllegalArgumentException - dimensions must agree
    
    Since:
    
    Jan 7, 2015 by Christopher K. Allen
    
    See Also:
    
    BaseVector.innerProd(xal.tools.math.BaseVector)
  - norm1
```
public double norm1()
```
    Return the l₁ norm of the vector. Must override to account for the projective coordinate.
    
    Overrides:
    
    norm1 in class BaseVector<PhaseVector>
    
    Returns:
    
    ||z||₁ = Σ_i≠6 |z_i|
    
    Since:
    
    Oct 11, 2013
    
    See Also:
    
    BaseVector.norm1()
  - norm2
```
public double norm2()
```
    Return the l₂ norm of the vector. Must override to account for the projective coordinate.
    
    Overrides:
    
    norm2 in class BaseVector<PhaseVector>
    
    Returns:
    
    ||z||₂ = [ Σ_i≠6 z_i² ]^1/2
    
    Since:
    
    Oct 11, 2013
    
    See Also:
    
    BaseVector.norm2()
  - normInf
```
public double normInf()
```
    Return the l_{∞ norm of the vector.
    Must override to account for the projective coordinate.}
    
    Overrides:
    
    normInf in class BaseVector<PhaseVector>
    
    Returns:
    
    ||z||_∞ = sup_i≠6 |z_i|
    
    Since:
    
    Oct 11, 2013
    
    See Also:
    
    BaseVector.normInf()
  - clone
```
public PhaseVector clone()
```
    Creates and returns a deep copy of this vector.
    
    Specified by:
    
    clone in class BaseVector<PhaseVector>
    
    Since:
    
    Jul 3, 2014
    
    See Also:
    
    BaseVector.clone()
  - print
```
public void print(java.io.PrintWriter os)
```
    Print the vector contents to an output stream, does not add new line.
    
    Overrides:
    
    print in class BaseVector<PhaseVector>
    
    Parameters:
    
    os - output stream object
  - println
```
public void println(java.io.PrintWriter os)
```
    Print the vector contents to an output stream, add new line character.
    
    Overrides:
    
    println in class BaseVector<PhaseVector>
    
    Parameters:
    
    os - output stream object
  - printString
```
public java.lang.String printString()
```
    Print the vector contents to a String.
  - main
```
public static void main(java.lang.String[] arrArgs)
```
    Test driver

Class PhaseVector

Nested Class Summary

Field Summary

Fields inherited from class xal.tools.math.BaseVector

Constructor Summary

Method Summary

Methods inherited from class xal.tools.math.BaseVector

Methods inherited from class java.lang.Object

Methods inherited from interface xal.tools.data.IArchive

Constructor Detail

PhaseVector

PhaseVector

PhaseVector

PhaseVector

PhaseVector

PhaseVector

PhaseVector

Method Detail

newZero

copy

parse

embed

embed

setVector

setVector

setElem

setx

setxp

sety

setyp

setz

setzp

getx

getxp

gety

getyp

getz

getzp

getPosition

getMomentum

outerProd

newInstance

assignZero

negate

negateEquals

plusEquals

plus

minusEquals

minus

times

timesEquals

innerProd

norm1

norm2

normInf

clone

print

println

printString

main