Vector3D

java.lang.Object
- etomica.space3d.Vector3D

All Implemented Interfaces:

Vector, java.io.Serializable
```
public final class Vector3D
extends java.lang.Object
implements Vector, java.io.Serializable
```
Implementation of the Vector class for a 3-dimensional space.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected static double[] lookUp

protected static int nLookUp

protected double x

protected double y

protected double z

Fields
Modifier and Type	Field	Description
`protected static double[]`	`lookUp`
`protected static int`	`nLookUp`
`protected double`	`x`
`protected double`	`y`
`protected double`	`z`

Constructor Summary

Constructors
Constructor Description

Vector3D()

Vector3D(double[] a)

Vector3D(double a1, double a2, double a3)

Vector3D(Vector3D u)

Constructors
Constructor	Description
`Vector3D()`
`Vector3D(double[] a)`
`Vector3D(double a1, double a2, double a3)`
`Vector3D(Vector3D u)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`assignTo(double[] array)`	Assigns the components of this vector to the elements of the given array.
`protected static double`	`cubeRoot(double R)`
`void`	`DE(Vector u)`	Divide-equals (/=) operation.
`double`	`dot(Vector u)`	Returns the dot product of this vector with the given one.
`void`	`E(double a)`	Sets all components of this vector equal to the given value.
`void`	`E(double[] u)`	Sets the components of this vector equal to the corresponding elements of the given array.
`void`	`E(double a, double b, double c)`
`void`	`E(Vector u)`	Sets the components of this vector equal to those of the given vector.
`void`	`Ea1Tv1(double a1, Vector u)`	Operation (= a1 * v1); sets the components of this to those of the given vector multiplied by the given constant.
`boolean`	`equals(Vector v)`	Returns true if all corresponding elements of this and the given vector are equal; returns false otherwise.
`void`	`Ev1Mv2(Vector u1, Vector u2)`	Sets the components of this vector equal to (v1 - v2)
`void`	`Ev1Pv2(Vector u1, Vector u2)`	Sets the components of this vector equal to (v1 + v2)
`int`	`getD()`	Dimension of the space occupied by the vector.
`double`	`getX(int i)`	Vector components corresponding to the given index.
`boolean`	`isNaN()`	Returns true if any element of the vector is not-a-number.
`boolean`	`isZero()`	Returns true if all components of this vector are zero; false otherwise.
`void`	`map(IFunction function)`	Applies the given function to each element of the vector.
`void`	`ME(Vector u)`	Minus-equals (-=) operation.
`void`	`mod(Vector u)`	Replaces each component of this vector with its value modulo the corresponding component in u
`void`	`mod(Vector3D u)`
`double`	`Mv1Squared(Vector u)`	Returns square of vector resulting from subtracting given vector from this one.
`void`	`nearestImage(Vector dimensions)`
`void`	`normalize()`	Normalizes this vector, so this.squared() == 1.
`void`	`PE(double a)`	Plus-equals (+=) operation, causing a constant value to be added to all components of this vector.
`void`	`PE(Vector u)`	Plus-equals (+=) operation.
`void`	`PEa1Tv1(double a1, Vector u)`	Increments (+=) components by (a1 * v1)
`void`	`setPerpendicularTo(Vector v)`
`void`	`setRandomCube(IRandom random)`	Assigns each component to (its own) random value between -0.5 and + 0.5.
`void`	`setRandomInSphere(IRandom random)`	Assigns this vector to equal a point chosen randomly in the volume of a unit sphere.
`void`	`setRandomSphere(IRandom random)`	Creating a random unit vector on unit sphere Uses only two random number generator at a time Based on M.P.
`void`	`setX(int a, double d)`	Sets the i-th component of the vector to the given value d.
`double`	`squared()`	Returns the square magnitude of this vector, e.g., x^2 + y^2 for D = 2.
`void`	`TE(double a)`	Multiplies all components by a constant.
`void`	`TE(Vector u)`	Times-equals (*=) operation.
`java.lang.String`	`toString()`
`void`	`XE(Vector u)`	Sets this vector equal to the cross product of this vector with the given vector (only works for 3D vectors).

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

Methods inherited from interface etomica.space.Vector
d, of, of, toArray

- Field Detail
  - x
```
protected double x
```
  - y
```
protected double y
```
  - z
```
protected double z
```
  - nLookUp
```
protected static final int nLookUp
```
    See Also:
    
    Constant Field Values
  - lookUp
```
protected static final double[] lookUp
```
- Constructor Detail
  - Vector3D
```
public Vector3D()
```
  - Vector3D
```
public Vector3D(double a1,
                double a2,
                double a3)
```
  - Vector3D
```
public Vector3D(double[] a)
```
  - Vector3D
```
public Vector3D(Vector3D u)
```
- Method Detail
  - getD
```
public int getD()
```
    Description copied from interface: Vector
    
    Dimension of the space occupied by the vector. Number of elements in the vector.
    
    Specified by:
    
    getD in interface Vector
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getX
```
public double getX(int i)
```
    Description copied from interface: Vector
    
    Vector components corresponding to the given index. For example, x-component is given for i = 0. If index exceeds dimension of vector, no error is given and the last element of the vector is returned.
    
    Specified by:
    
    getX in interface Vector
  - assignTo
```
public void assignTo(double[] array)
```
    Description copied from interface: Vector
    
    Assigns the components of this vector to the elements of the given array. Does not check that array length is consistent with vector dimension. Inverse of the E method.
    
    Specified by:
    
    assignTo in interface Vector
  - equals
```
public boolean equals(Vector v)
```
    Description copied from interface: Vector
    
    Returns true if all corresponding elements of this and the given vector are equal; returns false otherwise.
    
    Specified by:
    
    equals in interface Vector
  - isZero
```
public boolean isZero()
```
    Description copied from interface: Vector
    
    Returns true if all components of this vector are zero; false otherwise.
    
    Specified by:
    
    isZero in interface Vector
  - E
```
public void E(Vector u)
```
    Description copied from interface: Vector
    
    Sets the components of this vector equal to those of the given vector.
    
    Specified by:
    
    E in interface Vector
  - E
```
public void E(double a)
```
    Description copied from interface: Vector
    
    Sets all components of this vector equal to the given value.
    
    Specified by:
    
    E in interface Vector
  - E
```
public void E(double a,
              double b,
              double c)
```
  - E
```
public void E(double[] u)
```
    Description copied from interface: Vector
    
    Sets the components of this vector equal to the corresponding elements of the given array. Inverse of the assignTo method.
    
    Specified by:
    
    E in interface Vector
  - Ea1Tv1
```
public void Ea1Tv1(double a1,
                   Vector u)
```
    Description copied from interface: Vector
    
    Operation (= a1 * v1); sets the components of this to those of the given vector multiplied by the given constant.
    
    Specified by:
    
    Ea1Tv1 in interface Vector
  - PEa1Tv1
```
public void PEa1Tv1(double a1,
                    Vector u)
```
    Description copied from interface: Vector
    
    Increments (+=) components by (a1 * v1)
    
    Specified by:
    
    PEa1Tv1 in interface Vector
  - PE
```
public void PE(Vector u)
```
    Description copied from interface: Vector
    
    Plus-equals (+=) operation. Increments each component of this vector by the corresponding value in the given vector.
    
    Specified by:
    
    PE in interface Vector
  - PE
```
public void PE(double a)
```
    Description copied from interface: Vector
    
    Plus-equals (+=) operation, causing a constant value to be added to all components of this vector.
    
    Specified by:
    
    PE in interface Vector
  - ME
```
public void ME(Vector u)
```
    Description copied from interface: Vector
    
    Minus-equals (-=) operation. Decrements each component of this vector by the corresponding value in the given vector.
    
    Specified by:
    
    ME in interface Vector
  - TE
```
public void TE(double a)
```
    Description copied from interface: Vector
    
    Multiplies all components by a constant.
    
    Specified by:
    
    TE in interface Vector
  - TE
```
public void TE(Vector u)
```
    Description copied from interface: Vector
    
    Times-equals (*=) operation. Multiplies each component of this vector by the corresponding value in the given vector.
    
    Specified by:
    
    TE in interface Vector
  - DE
```
public void DE(Vector u)
```
    Description copied from interface: Vector
    
    Divide-equals (/=) operation. Divides each component of this vector by the corresponding value in the given vector.
    
    Specified by:
    
    DE in interface Vector
  - Ev1Pv2
```
public void Ev1Pv2(Vector u1,
                   Vector u2)
```
    Description copied from interface: Vector
    
    Sets the components of this vector equal to (v1 + v2)
    
    Specified by:
    
    Ev1Pv2 in interface Vector
  - Ev1Mv2
```
public void Ev1Mv2(Vector u1,
                   Vector u2)
```
    Description copied from interface: Vector
    
    Sets the components of this vector equal to (v1 - v2)
    
    Specified by:
    
    Ev1Mv2 in interface Vector
  - mod
```
public void mod(Vector u)
```
    Description copied from interface: Vector
    
    Replaces each component of this vector with its value modulo the corresponding component in u
    
    Specified by:
    
    mod in interface Vector
  - mod
```
public void mod(Vector3D u)
```
  - squared
```
public double squared()
```
    Description copied from interface: Vector
    
    Returns the square magnitude of this vector, e.g., x^2 + y^2 for D = 2.
    
    Specified by:
    
    squared in interface Vector
  - Mv1Squared
```
public double Mv1Squared(Vector u)
```
    Description copied from interface: Vector
    
    Returns square of vector resulting from subtracting given vector from this one. Neither vector is changed by this operation.
    
    Specified by:
    
    Mv1Squared in interface Vector
  - dot
```
public double dot(Vector u)
```
    Description copied from interface: Vector
    
    Returns the dot product of this vector with the given one.
    
    Specified by:
    
    dot in interface Vector
  - setPerpendicularTo
```
public void setPerpendicularTo(Vector v)
```
  - setX
```
public void setX(int a,
                 double d)
```
    Description copied from interface: Vector
    
    Sets the i-th component of the vector to the given value d. If index exceeds dimension of vector, no error is given and the last element of the vector is assigned.
    
    Specified by:
    
    setX in interface Vector
  - setRandomCube
```
public void setRandomCube(IRandom random)
```
    Description copied from interface: Vector
    
    Assigns each component to (its own) random value between -0.5 and + 0.5.
    
    Specified by:
    
    setRandomCube in interface Vector
    
    Parameters:
    
    random - the random number generator used to perform the operation
  - setRandomInSphere
```
public void setRandomInSphere(IRandom random)
```
    Description copied from interface: Vector
    
    Assigns this vector to equal a point chosen randomly in the volume of a unit sphere.
    
    Specified by:
    
    setRandomInSphere in interface Vector
    
    Parameters:
    
    random - the random number generator used to perform the operation
  - nearestImage
```
public void nearestImage(Vector dimensions)
```
    Specified by:
    
    nearestImage in interface Vector
  - setRandomSphere
```
public void setRandomSphere(IRandom random)
```
    Creating a random unit vector on unit sphere Uses only two random number generator at a time Based on M.P. Allen and D.J. Tildesley, Computer Simulation of Liquids, p 349.
    
    Specified by:
    
    setRandomSphere in interface Vector
    
    Parameters:
    
    random - the random number generator used to perform the operation
  - XE
```
public void XE(Vector u)
```
    Description copied from interface: Vector
    
    Sets this vector equal to the cross product of this vector with the given vector (only works for 3D vectors).
    
    Specified by:
    
    XE in interface Vector
  - normalize
```
public void normalize()
```
    Description copied from interface: Vector
    
    Normalizes this vector, so this.squared() == 1. Divides all components by Math.sqrt(this.squared()).
    
    Specified by:
    
    normalize in interface Vector
  - isNaN
```
public boolean isNaN()
```
    Description copied from interface: Vector
    
    Returns true if any element of the vector is not-a-number.
    
    Specified by:
    
    isNaN in interface Vector
  - map
```
public void map(IFunction function)
```
    Description copied from interface: Vector
    
    Applies the given function to each element of the vector.
    
    Specified by:
    
    map in interface Vector
  - cubeRoot
```
protected static double cubeRoot(double R)
```

Class Vector3D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface etomica.space.Vector

Field Detail

x

y

z

nLookUp

lookUp

Constructor Detail

Vector3D

Vector3D

Vector3D

Vector3D

Method Detail

getD

toString

getX

assignTo

equals

isZero

E

E

E

E

Ea1Tv1

PEa1Tv1

PE

PE

ME

TE

TE

DE

Ev1Pv2

Ev1Mv2

mod

mod

squared

Mv1Squared

dot

setPerpendicularTo

setX

setRandomCube

setRandomInSphere

nearestImage

setRandomSphere

XE

normalize

isNaN

map

cubeRoot