etomica.api

Interface IVector

All Known Subinterfaces:

IVectorMutable, IVectorRandom

All Known Implementing Classes:

Vector1D, Vector2D, Vector3D, VectorND

public interface IVector

Basic vector interface containing methods needed for basic vector operations and other accessor methods.

Method Summary

Modifier and Type	Method and Description
void	assignTo(double[] array) Assigns the components of this vector to the elements of the given array.
double	dot(IVector u) Returns the dot product of this vector with the given one.
boolean	equals(IVector v) Returns true if all corresponding elements of this and the given vector are equal; returns false otherwise.
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.
double	Mv1Squared(IVector v1) Returns square of vector resulting from subtracting given vector from this one.
double	squared() Returns the square magnitude of this vector, e.g., x^2 + y^2 for D = 2.

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.

equals

boolean equals(IVector 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(IVector 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(IVector v1)

Returns square of vector resulting from subtracting given vector from this one. Neither vector is changed by this operation.