com.io7m.jtensors

Class VectorM3D

java.lang.Object

com.io7m.jtensors.VectorM3D

All Implemented Interfaces:

Vector3DType, VectorReadable2DType, VectorReadable3DType, VectorWritable2DType, VectorWritable3DType

public final class VectorM3D
extends Object
implements Vector3DType

A three-dimensional mutable vector type with double elements.

Values of this type cannot be accessed safely from multiple threads without explicit synchronization.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VectorM3D.ContextVM3D Preallocated storage to allow all vector functions to run without allocating.

Constructor Summary

Constructors

Constructor and Description
VectorM3D() Default constructor, initializing the vector with values [0.0, 0.0, 0.0].
VectorM3D(double in_x, double in_y, double in_z) Construct a vector initialized with the given values.
VectorM3D(VectorReadable3DType in_v) Construct a vector initialized with the values given in the vector v.

Method Summary

Modifier and Type	Method and Description
static <V extends VectorWritable3DType> V	absolute(VectorReadable3DType v, V out) Calculate the absolute values of the elements in vector v, saving the result to out.
static <V extends VectorWritable3DType & VectorReadable3DType> V	absoluteInPlace(V v) Calculate the absolute values of the elements in vector v, modifying the vector in-place.
static <V extends VectorWritable3DType> V	add(VectorReadable3DType v0, VectorReadable3DType v1, V out) Calculate the element-wise sum of the vectors v0 and v1, saving the result to out.
static <V extends VectorWritable3DType & VectorReadable3DType> V	addInPlace(V v0, VectorReadable3DType v1) Calculate the element-wise sum of the vectors v0 and v1, saving the result to v0.
static <V extends VectorWritable3DType> V	addScaled(VectorReadable3DType v0, VectorReadable3DType v1, double r, V out) Calculate the element-wise sum of the vectors v0 and the element-wise product of v1 and r, saving the result to out.
static <V extends VectorWritable3DType & VectorReadable3DType> V	addScaledInPlace(V v0, VectorReadable3DType v1, double r) Calculate the element-wise sum of the vectors v0 and the element-wise product of v1 and r, saving the result to v0.
static boolean	almostEqual(com.io7m.jequality.AlmostEqualDouble.ContextRelative context, VectorReadable3DType qa, VectorReadable3DType qb) Determine whether or not the vectors qa and qb are equal to within the degree of error given in context.
static <V extends VectorWritable3DType> V	clamp(VectorReadable3DType v, double minimum, double maximum, V out) Clamp the elements of the vector v to the range {@code [minimum ..
static <V extends VectorWritable3DType> V	clampByVector(VectorReadable3DType v, VectorReadable3DType minimum, VectorReadable3DType maximum, V out) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum and maximum, saving the result to out.
static <V extends VectorWritable3DType & VectorReadable3DType> V	clampByVectorInPlace(V v, VectorReadable3DType minimum, VectorReadable3DType maximum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum and maximum, saving the result to v.
static <V extends VectorWritable3DType & VectorReadable3DType> V	clampInPlace(V v, double minimum, double maximum) Clamp the elements of the vector v to the range {@code [minimum ..
static <V extends VectorWritable3DType> V	clampMaximum(VectorReadable3DType v, double maximum, V out) Clamp the elements of the vector v to the range {@code [-Infinity ..
static <V extends VectorWritable3DType> V	clampMaximumByVector(VectorReadable3DType v, VectorReadable3DType maximum, V out) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in maximum, saving the result to out.
static <V extends VectorWritable3DType & VectorReadable3DType> V	clampMaximumByVectorInPlace(V v, VectorReadable3DType maximum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in maximum, saving the result to v.
static <V extends VectorWritable3DType & VectorReadable3DType> V	clampMaximumInPlace(V v, double maximum) Clamp the elements of the vector v to the range {@code [-Infinity ..
static <V extends VectorWritable3DType> V	clampMinimum(VectorReadable3DType v, double minimum, V out) Clamp the elements of the vector v to the range {@code [minimum ..
static <V extends VectorWritable3DType> V	clampMinimumByVector(VectorReadable3DType v, VectorReadable3DType minimum, V out) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum, saving the result to out.
static <V extends VectorWritable3DType & VectorReadable3DType> V	clampMinimumByVectorInPlace(V v, VectorReadable3DType minimum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum, saving the result to v.
static <V extends VectorWritable3DType & VectorReadable3DType> V	clampMinimumInPlace(V v, double minimum) Clamp the elements of the vector v to the range {@code [minimum ..
static <V extends VectorWritable3DType> V	copy(VectorReadable3DType input, V output) Copy all elements of the vector input to the vector output.
void	copyFrom2D(VectorReadable2DType in_v) Set the current vector to the contents of the input vector.
void	copyFrom3D(VectorReadable3DType in_v) Set the current vector to the contents of the input vector.
static <V extends VectorWritable3DType> V	crossProduct(VectorReadable3DType v0, VectorReadable3DType v1, V out) Return a vector perpendicular to both v0 and v1 , saving the result in out.
static double	distance(VectorM3D.ContextVM3D c, VectorReadable3DType v0, VectorReadable3DType v1) Calculate the distance between the two vectors v0 and v1.
static double	dotProduct(VectorReadable3DType v0, VectorReadable3DType v1) Calculate the scalar product of the vectors v0 and v1.
boolean	equals(Object obj)
double	getXD()
double	getYD()
double	getZD()
int	hashCode()
static <V extends VectorWritable3DType> V	interpolateLinear(VectorM3D.ContextVM3D c, VectorReadable3DType v0, VectorReadable3DType v1, double alpha, V r) Linearly interpolate between v0 and v1 by the amount alpha, saving the result to r.
static double	magnitude(VectorReadable3DType v) Calculate the magnitude of the vector v.
static double	magnitudeSquared(VectorReadable3DType v) Calculate the squared magnitude of the vector v.
static <V extends VectorWritable3DType> V	normalize(VectorReadable3DType v, V out) Returns a vector with the same orientation as v but with magnitude equal to 1.0 in out.
static <V extends VectorWritable3DType & VectorReadable3DType> V	normalizeInPlace(V v) Returns a vector with the same orientation as v but with magnitude equal to 1.0 in v.
static <V extends VectorReadable3DType,U extends VectorWritable3DType> void	orthoNormalize(VectorM3D.ContextVM3D c, VectorReadable3DType v0, U v0_out, VectorReadable3DType v1, U v1_out) Orthonormalize and return the vectors v0 and v1 .
static <V extends VectorWritable3DType & VectorReadable3DType,W extends VectorWritable3DType & VectorReadable3DType> void	orthoNormalizeInPlace(VectorM3D.ContextVM3D c, V v0, W v1) Orthonormalize and the vectors v0 and v1.
static <V extends VectorWritable3DType> V	projection(VectorReadable3DType p, VectorReadable3DType q, V r) Calculate the projection of the vector p onto the vector q, saving the result in r.
static <V extends VectorWritable3DType> V	scale(VectorReadable3DType v, double r, V out) Scale the vector v by the scalar r, saving the result to out.
static <V extends VectorWritable3DType & VectorReadable3DType> V	scaleInPlace(V v, double r) Scale the vector v by the scalar r, saving the result to v.
void	set2D(double in_x, double in_y) Set the current x and y values of the current vector.
void	set3D(double in_x, double in_y, double in_z) Set the current x, y and z values of the current vector.
void	setXD(double in_x) Set the current x value of the current vector.
void	setYD(double in_y) Set the current y value of the current vector.
void	setZD(double in_z) Set the current z value of the current vector.
static <V extends VectorWritable3DType> V	subtract(VectorReadable3DType v0, VectorReadable3DType v1, V out) Subtract the vector v1 from the vector v0, saving the result to out.
static <V extends VectorWritable3DType & VectorReadable3DType> V	subtractInPlace(V v0, VectorReadable3DType v1) Subtract the vector v1 from the vector v0, saving the result to v0.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VectorM3D

public VectorM3D()

Default constructor, initializing the vector with values [0.0, 0.0, 0.0].

VectorM3D

public VectorM3D(double in_x,
                 double in_y,
                 double in_z)

Construct a vector initialized with the given values.

Parameters:

in_x - The x value

in_y - The y value

in_z - The z value

VectorM3D

public VectorM3D(VectorReadable3DType in_v)

Construct a vector initialized with the values given in the vector v.

Parameters:

in_v - The source vector

Method Detail

absolute

public static <V extends VectorWritable3DType> V absolute(VectorReadable3DType v,
                                                          V out)

Calculate the absolute values of the elements in vector v, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

out - The output vector

Returns:

(abs v.x, abs v.y, abs v.z)

absoluteInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V absoluteInPlace(V v)

Calculate the absolute values of the elements in vector v, modifying the vector in-place.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

Returns:

(abs v.x, abs v.y, abs v.z)

add

public static <V extends VectorWritable3DType> V add(VectorReadable3DType v0,
                                                     VectorReadable3DType v1,
                                                     V out)

Calculate the element-wise sum of the vectors v0 and v1, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v0 - The left input vector

v1 - The right input vector

out - The output vector

Returns:

(v0.x + v1.x, v0.y + v1.y, v0.z + v1.z)

addInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V addInPlace(V v0,
                                                                                   VectorReadable3DType v1)

Calculate the element-wise sum of the vectors v0 and v1, saving the result to v0.

Type Parameters:

V - The precise type of vector

Parameters:

v0 - The left input vector

v1 - The right input vector

Returns:

(v0.x + v1.x, v0.y + v1.y, v0.z + v1.z)

addScaled

public static <V extends VectorWritable3DType> V addScaled(VectorReadable3DType v0,
                                                           VectorReadable3DType v1,
                                                           double r,
                                                           V out)

Calculate the element-wise sum of the vectors v0 and the element-wise product of v1 and r, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v0 - The left input vector

v1 - The right input vector

out - The output vector

r - The scaling value

Returns:

(v0.x + (v1.x * r), v0.y + (v1.y * r), v0.z + (v1.z * r))

addScaledInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V addScaledInPlace(V v0,
                                                                                         VectorReadable3DType v1,
                                                                                         double r)

Calculate the element-wise sum of the vectors v0 and the element-wise product of v1 and r, saving the result to v0.

Type Parameters:

V - The precise type of vector

Parameters:

v0 - The left input vector

v1 - The right input vector

r - The scaling value

Returns:

(v0.x + (v1.x * r), v0.y + (v1.y * r), v0.z + (v1.z * r))

almostEqual

public static boolean almostEqual(com.io7m.jequality.AlmostEqualDouble.ContextRelative context,
                                  VectorReadable3DType qa,
                                  VectorReadable3DType qb)

Determine whether or not the vectors qa and qb are equal to within the degree of error given in context.

Parameters:

context - The equality context

qa - The left input vector

qb - The right input vector

Returns:

true if the vectors are almost equal

Since:

5.0.0

See Also:

AlmostEqualDouble.almostEqual(ContextRelative, double, double)

clamp

public static <V extends VectorWritable3DType> V clamp(VectorReadable3DType v,
                                                       double minimum,
                                                       double maximum,
                                                       V out)

Clamp the elements of the vector v to the range [minimum .. maximum] inclusive, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

minimum - The minimum allowed value

maximum - The maximum allowed value

out - The output vector

Returns:

A vector with both elements equal to at most maximum and at least minimum

clampByVector

public static <V extends VectorWritable3DType> V clampByVector(VectorReadable3DType v,
                                                               VectorReadable3DType minimum,
                                                               VectorReadable3DType maximum,
                                                               V out)

Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum and maximum, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

minimum - The vector containing the minimum acceptable values

maximum - The vector containing the maximum acceptable values

out - The output vector

Returns:

(min(max(v.x, minimum.x), maximum.x), min(max(v.y, minimum.y), maximum.y), min(max(v.z, minimum.z), maximum.z))

clampByVectorInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V clampByVectorInPlace(V v,
                                                                                             VectorReadable3DType minimum,
                                                                                             VectorReadable3DType maximum)

Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum and maximum, saving the result to v.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

minimum - The vector containing the minimum acceptable values

maximum - The vector containing the maximum acceptable values

Returns:

(min(max(v.x, minimum.x), maximum.x), min(max(v.y, minimum.y), maximum.y), min(max(v.z, minimum.z), maximum.z))

clampInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V clampInPlace(V v,
                                                                                     double minimum,
                                                                                     double maximum)

Clamp the elements of the vector v to the range [minimum .. maximum] inclusive, saving the result to v.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

minimum - The minimum allowed value

maximum - The maximum allowed value

Returns:

A vector with both elements equal to at most maximum and at least minimum, in v

clampMaximum

public static <V extends VectorWritable3DType> V clampMaximum(VectorReadable3DType v,
                                                              double maximum,
                                                              V out)

Clamp the elements of the vector v to the range [-Infinity .. maximum] inclusive, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

out - The output vector

maximum - The maximum allowed value

Returns:

A vector with both elements equal to at most maximum

clampMaximumByVector

public static <V extends VectorWritable3DType> V clampMaximumByVector(VectorReadable3DType v,
                                                                      VectorReadable3DType maximum,
                                                                      V out)

Clamp the elements of the vector v to the inclusive range given by the corresponding elements in maximum, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

maximum - The vector containing the maximum acceptable values

out - The output vector

Returns:

(min(v.x, maximum.x), min(v.y, maximum.y), min(v.z, maximum.z))

clampMaximumByVectorInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V clampMaximumByVectorInPlace(V v,
                                                                                                    VectorReadable3DType maximum)

Clamp the elements of the vector v to the inclusive range given by the corresponding elements in maximum, saving the result to v.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

maximum - The vector containing the maximum acceptable values

Returns:

(min(v.x, maximum.x), min(v.y, maximum.y), min(v.z, maximum.z))

clampMaximumInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V clampMaximumInPlace(V v,
                                                                                            double maximum)

Clamp the elements of the vector v to the range [-Infinity .. maximum] inclusive, saving the result to v.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

maximum - The maximum allowed value

Returns:

A vector with both elements equal to at most maximum , in v

clampMinimum

public static <V extends VectorWritable3DType> V clampMinimum(VectorReadable3DType v,
                                                              double minimum,
                                                              V out)

Clamp the elements of the vector v to the range [minimum .. Infinity] inclusive, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

out - The output vector

minimum - The minimum allowed value

Returns:

A vector with both elements equal to at least minimum

clampMinimumByVector

public static <V extends VectorWritable3DType> V clampMinimumByVector(VectorReadable3DType v,
                                                                      VectorReadable3DType minimum,
                                                                      V out)

Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

out - The output vector

minimum - The vector containing the minimum acceptable values

Returns:

(max(v.x, minimum.x), max(v.y, minimum.y), max(v.z, minimum.z))

clampMinimumByVectorInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V clampMinimumByVectorInPlace(V v,
                                                                                                    VectorReadable3DType minimum)

Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum, saving the result to v.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

minimum - The vector containing the minimum acceptable values

Returns:

(max(v.x, minimum.x), max(v.y, minimum.y), max(v.z, minimum.z)) , in v

clampMinimumInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V clampMinimumInPlace(V v,
                                                                                            double minimum)

Clamp the elements of the vector v to the range [minimum .. Infinity] inclusive, saving the result to v.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

minimum - The minimum allowed value

Returns:

A vector with both elements equal to at least minimum, in v.

copy

public static <V extends VectorWritable3DType> V copy(VectorReadable3DType input,
                                                      V output)

Copy all elements of the vector input to the vector output.

Type Parameters:

V - The precise type of vector

Parameters:

input - The input vector

output - The output vector

Returns:

output

crossProduct

public static <V extends VectorWritable3DType> V crossProduct(VectorReadable3DType v0,
                                                              VectorReadable3DType v1,
                                                              V out)

Return a vector perpendicular to both v0 and v1 , saving the result in out.

Type Parameters:

V - The precise type of vector

Parameters:

v0 - The left input vector.

v1 - The right input vector.

out - The output vector.

Returns:

out

distance

public static double distance(VectorM3D.ContextVM3D c,
                              VectorReadable3DType v0,
                              VectorReadable3DType v1)

Calculate the distance between the two vectors v0 and v1.

Parameters:

c - Preallocated storage

v0 - The left input vector

v1 - The right input vector

Returns:

The distance between the two vectors.

Since:

7.0.0

dotProduct

public static double dotProduct(VectorReadable3DType v0,
                                VectorReadable3DType v1)

Calculate the scalar product of the vectors v0 and v1.

Parameters:

v0 - The left input vector

v1 - The right input vector

Returns:

The scalar product of the two vectors

interpolateLinear

public static <V extends VectorWritable3DType> V interpolateLinear(VectorM3D.ContextVM3D c,
                                                                   VectorReadable3DType v0,
                                                                   VectorReadable3DType v1,
                                                                   double alpha,
                                                                   V r)

Linearly interpolate between v0 and v1 by the amount alpha, saving the result to r. The alpha parameter controls the degree of interpolation, such that:

• interpolateLinear(v0, v1, 0.0, r) -> r = v0
• interpolateLinear(v0, v1, 1.0, r) -> r = v1

Type Parameters:

V - The precise type of vector

Parameters:

c - Preallocated storage

v0 - The left input vector.

v1 - The right input vector.

alpha - The interpolation value, between 0.0 and 1.0.

r - The result vector.

Returns:

r

Since:

7.0.0

magnitude

public static double magnitude(VectorReadable3DType v)

Calculate the magnitude of the vector v. Correspondingly, magnitude(normalize(v)) == 1.0.

Parameters:

v - The input vector

Returns:

The magnitude of the input vector

magnitudeSquared

public static double magnitudeSquared(VectorReadable3DType v)

Calculate the squared magnitude of the vector v.

Parameters:

v - The input vector

Returns:

The squared magnitude of the input vector

normalize

public static <V extends VectorWritable3DType> V normalize(VectorReadable3DType v,
                                                           V out)

Returns a vector with the same orientation as v but with magnitude equal to 1.0 in out. The function returns the zero vector iff the input is the zero vector.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

out - The output vector

Returns:

out

normalizeInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V normalizeInPlace(V v)

Returns a vector with the same orientation as v but with magnitude equal to 1.0 in v. The function returns the zero vector iff the input is the zero vector.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

Returns:

v

orthoNormalize

public static <V extends VectorReadable3DType,U extends VectorWritable3DType> void orthoNormalize(VectorM3D.ContextVM3D c,
                                                                                                  VectorReadable3DType v0,
                                                                                                  U v0_out,
                                                                                                  VectorReadable3DType v1,
                                                                                                  U v1_out)

Orthonormalize and return the vectors v0 and v1 .

See GSP

Type Parameters:

V - The precise type of readable vectors

U - The precise type of writable vectors

Parameters:

c - Preallocated storage

v0 - The left vector

v0_out - The orthonormalized form of v0

v1 - The right vector

v1_out - The orthonormalized form of v1

Since:

7.0.0

orthoNormalizeInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType,W extends VectorWritable3DType & VectorReadable3DType> void orthoNormalizeInPlace(VectorM3D.ContextVM3D c,
                                                                                                                                                       V v0,
                                                                                                                                                       W v1)

Orthonormalize and the vectors v0 and v1.

See GSP

Type Parameters:

V - The precise type of readable/writable vector

W - The precise type of readable/writable vector

Parameters:

c - Preallocated storage

v0 - The left vector

v1 - The right vector

Since:

7.0.0

projection

public static <V extends VectorWritable3DType> V projection(VectorReadable3DType p,
                                                            VectorReadable3DType q,
                                                            V r)

Calculate the projection of the vector p onto the vector q, saving the result in r.

Type Parameters:

V - The precise type of vector

Parameters:

p - The left vector

q - The right vector

r - The output vector

Returns:

((dotProduct p q) / magnitudeSquared q) * q

scale

public static <V extends VectorWritable3DType> V scale(VectorReadable3DType v,
                                                       double r,
                                                       V out)

Scale the vector v by the scalar r, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

r - The scaling value

out - The output vector

Returns:

(v.x * r, v.y * r, v.z * r)

scaleInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V scaleInPlace(V v,
                                                                                     double r)

Scale the vector v by the scalar r, saving the result to v.

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

r - The scaling value

Returns:

(v.x * r, v.y * r, v.z * r)

subtract

public static <V extends VectorWritable3DType> V subtract(VectorReadable3DType v0,
                                                          VectorReadable3DType v1,
                                                          V out)

Subtract the vector v1 from the vector v0, saving the result to out.

Type Parameters:

V - The precise type of vector

Parameters:

v0 - The left input vector

v1 - The right input vector

out - The output vector

Returns:

(v0.x - v1.x, v0.y - v1.y, v0.z - v1.z)

subtractInPlace

public static <V extends VectorWritable3DType & VectorReadable3DType> V subtractInPlace(V v0,
                                                                                        VectorReadable3DType v1)

Subtract the vector v1 from the vector v0, saving the result to v0.

Type Parameters:

V - The precise type of vector

Parameters:

v0 - The left input vector

v1 - The right input vector

Returns:

(v0.x - v1.x, v0.y - v1.y, v0.z - v1.z)

copyFrom2D

public void copyFrom2D(VectorReadable2DType in_v)

Description copied from interface: VectorWritable2DType

Set the current vector to the contents of the input vector.

Specified by:

copyFrom2D in interface VectorWritable2DType

Parameters:

in_v - The input vector

copyFrom3D

public void copyFrom3D(VectorReadable3DType in_v)

Description copied from interface: VectorWritable3DType

Set the current vector to the contents of the input vector.

Specified by:

copyFrom3D in interface VectorWritable3DType

Parameters:

in_v - The input vector

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

getXD

public double getXD()

Specified by:

getXD in interface VectorReadable2DType

Returns:

The X value of the given vector.

setXD

public void setXD(double in_x)

Description copied from interface: VectorWritable2DType

Set the current x value of the current vector.

Specified by:

setXD in interface VectorWritable2DType

Parameters:

in_x - The new x value.

getYD

public double getYD()

Specified by:

getYD in interface VectorReadable2DType

Returns:

The Y value of the given vector.

setYD

public void setYD(double in_y)

Description copied from interface: VectorWritable2DType

Set the current y value of the current vector.

Specified by:

setYD in interface VectorWritable2DType

Parameters:

in_y - The new y value.

getZD

public double getZD()

Specified by:

getZD in interface VectorReadable3DType

Returns:

The Z value of the given vector.

setZD

public void setZD(double in_z)

Description copied from interface: VectorWritable3DType

Set the current z value of the current vector.

Specified by:

setZD in interface VectorWritable3DType

Parameters:

in_z - The new z value.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

set2D

public void set2D(double in_x,
                  double in_y)

Description copied from interface: VectorWritable2DType

Set the current x and y values of the current vector.

Specified by:

set2D in interface VectorWritable2DType

Parameters:

in_x - The new x value.

in_y - The new y value.

set3D

public void set3D(double in_x,
                  double in_y,
                  double in_z)

Description copied from interface: VectorWritable3DType

Set the current x, y and z values of the current vector.

Specified by:

set3D in interface VectorWritable3DType

Parameters:

in_x - The new x value.

in_y - The new y value.

in_z - The new z value.

toString

public String toString()

Overrides:

toString in class Object