Vector

All Known Implementing Classes:

Vector1D, Vector2D, Vector3D, VectorND
```
public interface Vector
```
Interface containing vector operations, accessor, and mutator methods.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`assignTo(double[] array)`	Assigns the components of this vector to the elements of the given array.
`static Vector`	`d(int dimension)`	Creates a Vector of the given dimension.
`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[] a)`	Sets the components of this vector equal to the corresponding elements of the given array.
`void`	`E(Vector u)`	Sets the components of this vector equal to those of the given vector.
`void`	`Ea1Tv1(double a, Vector v1)`	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 v1, Vector v2)`	Sets the components of this vector equal to (v1 - v2)
`void`	`Ev1Pv2(Vector v1, Vector v2)`	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 f)`	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
`double`	`Mv1Squared(Vector v1)`	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.
`static Vector`	`of(double... components)`	Returns a Vector initialized to the given set of values.
`static Vector`	`of(int... components)`	Returns a Vector initialized to the given set of values (cast to double).
`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 a, Vector v1)`	Increments (+=) components by (a1 * v1)
`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)`	Assigns this vector to equal a point chosen randomly on the surface of a unit sphere.
`void`	`setX(int i, 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.
`default double[]`	`toArray()`
`void`	`XE(Vector u)`	Sets this vector equal to the cross product of this vector with the given vector (only works for 3D vectors).

- Method Detail
  - getD
```
int getD()
```
    Dimension of the space occupied by the vector. Number of elements in the vector.
  - assignTo
```
void assignTo(double[] array)
```
    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.
  - toArray
```
default double[] toArray()
```
  - equals
```
boolean equals(Vector v)
```
    Returns true if all corresponding elements of this and the given vector are equal; returns false otherwise.
  - getX
```
double getX(int i)
```
    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.
  - squared
```
double squared()
```
    Returns the square magnitude of this vector, e.g., x^2 + y^2 for D = 2.
  - isZero
```
boolean isZero()
```
    Returns true if all components of this vector are zero; false otherwise.
  - dot
```
double dot(Vector u)
```
    Returns the dot product of this vector with the given one.
  - isNaN
```
boolean isNaN()
```
    Returns true if any element of the vector is not-a-number.
  - Mv1Squared
```
double Mv1Squared(Vector v1)
```
    Returns square of vector resulting from subtracting given vector from this one. Neither vector is changed by this operation.
  - setX
```
void setX(int i,
          double d)
```
    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.
  - E
```
void E(Vector u)
```
    Sets the components of this vector equal to those of the given vector.
  - E
```
void E(double a)
```
    Sets all components of this vector equal to the given value.
  - E
```
void E(double[] a)
```
    Sets the components of this vector equal to the corresponding elements of the given array. Inverse of the assignTo method.
  - PE
```
void PE(Vector u)
```
    Plus-equals (+=) operation. Increments each component of this vector by the corresponding value in the given vector.
  - PE
```
void PE(double a)
```
    Plus-equals (+=) operation, causing a constant value to be added to all components of this vector.
  - ME
```
void ME(Vector u)
```
    Minus-equals (-=) operation. Decrements each component of this vector by the corresponding value in the given vector.
  - TE
```
void TE(Vector u)
```
    Times-equals (*=) operation. Multiplies each component of this vector by the corresponding value in the given vector.
  - DE
```
void DE(Vector u)
```
    Divide-equals (/=) operation. Divides each component of this vector by the corresponding value in the given vector.
  - TE
```
void TE(double a)
```
    Multiplies all components by a constant.
  - Ea1Tv1
```
void Ea1Tv1(double a,
            Vector v1)
```
    Operation (= a1 * v1); sets the components of this to those of the given vector multiplied by the given constant.
  - PEa1Tv1
```
void PEa1Tv1(double a,
             Vector v1)
```
    Increments (+=) components by (a1 * v1)
  - Ev1Pv2
```
void Ev1Pv2(Vector v1,
            Vector v2)
```
    Sets the components of this vector equal to (v1 + v2)
  - Ev1Mv2
```
void Ev1Mv2(Vector v1,
            Vector v2)
```
    Sets the components of this vector equal to (v1 - v2)
  - mod
```
void mod(Vector u)
```
    Replaces each component of this vector with its value modulo the corresponding component in u
  - normalize
```
void normalize()
```
    Normalizes this vector, so this.squared() == 1. Divides all components by Math.sqrt(this.squared()).
  - map
```
void map(IFunction f)
```
    Applies the given function to each element of the vector.
  - XE
```
void XE(Vector u)
```
    Sets this vector equal to the cross product of this vector with the given vector (only works for 3D vectors).
  - setRandomSphere
```
void setRandomSphere(IRandom random)
```
    Assigns this vector to equal a point chosen randomly on the surface of a unit sphere.
    
    Parameters:
    
    random - the random number generator used to perform the operation
  - setRandomCube
```
void setRandomCube(IRandom random)
```
    Assigns each component to (its own) random value between -0.5 and + 0.5.
    
    Parameters:
    
    random - the random number generator used to perform the operation
  - setRandomInSphere
```
void setRandomInSphere(IRandom random)
```
    Assigns this vector to equal a point chosen randomly in the volume of a unit sphere.
    
    Parameters:
    
    random - the random number generator used to perform the operation
  - nearestImage
```
void nearestImage(Vector dimensions)
```
  - of
```
static Vector of(double... components)
```
    Returns a Vector initialized to the given set of values. Spatial dimension of the Vector is determined by the number of components.
    
    Throws:
    
    java.lang.IllegalArgumentException - if number of components is not greater than 0
  - of
```
static Vector of(int... components)
```
    Returns a Vector initialized to the given set of values (cast to double). Spatial dimension of the Vector is determined by the number of components.
  - d
```
static Vector d(int dimension)
```
    Creates a Vector of the given dimension. Uses specific vector types for dimensions 1, 2, and 3, and VectorND for any higher dimension.
    
    Parameters:
    
    dimension - greater than 0
    
    Returns:
    
    a Vector of the given dimension.

Interface Vector

Method Summary

Method Detail

getD

assignTo

toArray

equals

getX

squared

isZero

dot

isNaN

Mv1Squared

setX

E

E

E

PE

PE

ME

TE

DE

TE

Ea1Tv1

PEa1Tv1

Ev1Pv2

Ev1Mv2

mod

normalize

map

XE

setRandomSphere

setRandomCube

setRandomInSphere

nearestImage

of

of

d