com.io7m.jtensors

Class VectorM3I

java.lang.Object

com.io7m.jtensors.VectorM3I

All Implemented Interfaces:

Vector2IType, Vector3IType, VectorReadable2IType, VectorReadable3IType, VectorWritable2IType, VectorWritable3IType

public final class VectorM3I
extends Object
implements Vector3IType

A three-dimensional mutable vector type with integer 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	VectorM3I.ContextVM3I Preallocated storage to allow all vector functions to run without allocating.

Constructor Summary

Constructors

Constructor and Description
VectorM3I() Default constructor, initializing the vector with values [0, 0, 0].
VectorM3I(int in_x, int in_y, int in_z) Construct a vector initialized with the given values.
VectorM3I(VectorReadable3IType in_v) Construct a vector initialized with the values given in the vector in_v.

Method Summary

Modifier and Type	Method and Description
static <V extends VectorWritable3IType> V	absolute(VectorReadable3IType v, V out) Calculate the absolute values of the elements in vector v, saving the result to out.
static <V extends VectorWritable3IType & VectorReadable3IType> V	absoluteInPlace(V v) Calculate the absolute values of the elements in vector v, saving the result to v.
static <V extends VectorWritable3IType> V	add(VectorReadable3IType v0, VectorReadable3IType v1, V out) Calculate the element-wise sum of the vectors v0 and v1, saving the result to out.
static <V extends VectorWritable3IType & VectorReadable3IType> V	addInPlace(V v0, VectorReadable3IType v1) Calculate the element-wise sum of the vectors v0 and v1, saving the result to v0.
static <V extends VectorWritable3IType> V	addScaled(VectorReadable3IType v0, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V	addScaledInPlace(V v0, VectorReadable3IType 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 <V extends VectorWritable3IType> V	clamp(VectorReadable3IType v, int minimum, int maximum, V out) Clamp the elements of the vector v to the range {@code [minimum ..
static <V extends VectorWritable3IType> V	clampByVector(VectorReadable3IType v, VectorReadable3IType minimum, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V	clampByVectorInPlace(V v, VectorReadable3IType minimum, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V	clampInPlace(V v, int minimum, int maximum) Clamp the elements of the vector v to the range {@code [minimum ..
static <V extends VectorWritable3IType> V	clampMaximum(VectorReadable3IType v, int maximum, V out) Clamp the elements of the vector v to the range {@code [-Infinity ..
static <V extends VectorWritable3IType> V	clampMaximumByVector(VectorReadable3IType v, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V	clampMaximumByVectorInPlace(V v, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V	clampMaximumInPlace(V v, int maximum) Clamp the elements of the vector v to the range {@code [-Infinity ..
static <V extends VectorWritable3IType> V	clampMinimum(VectorReadable3IType v, int minimum, V out) Clamp the elements of the vector v to the range {@code [minimum ..
static <V extends VectorWritable3IType> V	clampMinimumByVector(VectorReadable3IType v, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V	clampMinimumByVectorInPlace(V v, VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V	clampMinimumInPlace(V v, int minimum) Clamp the elements of the vector v to the range {@code [minimum ..
static <V extends VectorWritable3IType> V	copy(VectorReadable3IType input, V output) Copy all elements of the vector input to the vector output.
void	copyFrom2I(VectorReadable2IType in_v) Set the current vector to the contents of the input vector.
void	copyFrom3I(VectorReadable3IType in_v) Set the current vector to the contents of the input vector.
static int	distance(VectorM3I.ContextVM3I c, VectorReadable3IType v0, VectorReadable3IType v1) Calculate the distance between the two vectors v0 and v1.
static int	dotProduct(VectorReadable3IType v0, VectorReadable3IType v1) Calculate the scalar product of the vectors v0 and v1.
boolean	equals(Object obj)
int	getXI()
int	getYI()
int	getZI()
int	hashCode()
static <V extends VectorWritable3IType> V	interpolateLinear(VectorM3I.ContextVM3I c, VectorReadable3IType v0, VectorReadable3IType v1, double alpha, V r) Linearly interpolate between v0 and v1 by the amount alpha, saving the result to r.
static int	magnitude(VectorReadable3IType v) Calculate the magnitude of the vector v.
static int	magnitudeSquared(VectorReadable3IType v) Calculate the squared magnitude of the vector v.
static <V extends VectorWritable3IType> V	projection(VectorReadable3IType p, VectorReadable3IType q, V r) Calculate the projection of the vector p onto the vector q, saving the result in r.
static <V extends VectorWritable3IType> V	scale(VectorReadable3IType v, double r, V out) Scale the vector v by the scalar r, saving the result to out.
static <V extends VectorWritable3IType & VectorReadable3IType> V	scaleInPlace(V v, int r) Scale the vector v by the scalar r, saving the result to v.
void	set2I(int in_x, int in_y) Set the current x and y values of the current vector.
void	set3I(int in_x, int in_y, int in_z) Set the current x, y and z values of the current vector.
void	setXI(int in_x) Set the current x value of the current vector.
void	setYI(int in_y) Set the current y value of the current vector.
void	setZI(int in_z) Set the current z value of the current vector.
static <V extends VectorWritable3IType> V	subtract(VectorReadable3IType v0, VectorReadable3IType v1, V out) Subtract the vector v1 from the vector v0, saving the result to out.
static <V extends VectorWritable3IType & VectorReadable3IType> V	subtractInPlace(V v0, VectorReadable3IType 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

VectorM3I

public VectorM3I()

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

VectorM3I

public VectorM3I(int in_x,
                 int in_y,
                 int 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

VectorM3I

public VectorM3I(VectorReadable3IType in_v)

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

Parameters:

in_v - The source vector

Method Detail

absolute

public static <V extends VectorWritable3IType> V absolute(VectorReadable3IType v,
                                                          V out)
                                                   throws ArithmeticException

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)

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

absoluteInPlace

public static <V extends VectorWritable3IType & VectorReadable3IType> V absoluteInPlace(V v)
                                                                                 throws ArithmeticException

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

Type Parameters:

V - The precise type of vector

Parameters:

v - The input vector

Returns:

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

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

add

public static <V extends VectorWritable3IType> V add(VectorReadable3IType v0,
                                                     VectorReadable3IType v1,
                                                     V out)
                                              throws ArithmeticException

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)

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

addInPlace

public static <V extends VectorWritable3IType & VectorReadable3IType> V addInPlace(V v0,
                                                                                   VectorReadable3IType v1)
                                                                            throws ArithmeticException

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)

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

addScaled

public static <V extends VectorWritable3IType> V addScaled(VectorReadable3IType v0,
                                                           VectorReadable3IType v1,
                                                           double r,
                                                           V out)
                                                    throws ArithmeticException

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))

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

addScaledInPlace

public static <V extends VectorWritable3IType & VectorReadable3IType> V addScaledInPlace(V v0,
                                                                                         VectorReadable3IType v1,
                                                                                         double r)
                                                                                  throws ArithmeticException

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))

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

clamp

public static <V extends VectorWritable3IType> V clamp(VectorReadable3IType v,
                                                       int minimum,
                                                       int 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 VectorWritable3IType> V clampByVector(VectorReadable3IType v,
                                                               VectorReadable3IType minimum,
                                                               VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V clampByVectorInPlace(V v,
                                                                                             VectorReadable3IType minimum,
                                                                                             VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V clampInPlace(V v,
                                                                                     int minimum,
                                                                                     int 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 VectorWritable3IType> V clampMaximum(VectorReadable3IType v,
                                                              int 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 VectorWritable3IType> V clampMaximumByVector(VectorReadable3IType v,
                                                                      VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V clampMaximumByVectorInPlace(V v,
                                                                                                    VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V clampMaximumInPlace(V v,
                                                                                            int 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 VectorWritable3IType> V clampMinimum(VectorReadable3IType v,
                                                              int 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 VectorWritable3IType> V clampMinimumByVector(VectorReadable3IType v,
                                                                      VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V clampMinimumByVectorInPlace(V v,
                                                                                                    VectorReadable3IType 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 VectorWritable3IType & VectorReadable3IType> V clampMinimumInPlace(V v,
                                                                                            int 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 VectorWritable3IType> V copy(VectorReadable3IType input,
                                                      V output)

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

Type Parameters:

V - The specific type of vector

Parameters:

input - The input vector

output - The output vector

Returns:

output

distance

public static int distance(VectorM3I.ContextVM3I c,
                           VectorReadable3IType v0,
                           VectorReadable3IType v1)
                    throws ArithmeticException

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.

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

Since:

7.0.0

dotProduct

public static int dotProduct(VectorReadable3IType v0,
                             VectorReadable3IType v1)
                      throws ArithmeticException

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

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

interpolateLinear

public static <V extends VectorWritable3IType> V interpolateLinear(VectorM3I.ContextVM3I c,
                                                                   VectorReadable3IType v0,
                                                                   VectorReadable3IType v1,
                                                                   double alpha,
                                                                   V r)
                                                            throws ArithmeticException

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

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow.

Since:

7.0.0

magnitude

public static int magnitude(VectorReadable3IType v)
                     throws ArithmeticException

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

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

magnitudeSquared

public static int magnitudeSquared(VectorReadable3IType v)
                            throws ArithmeticException

Calculate the squared magnitude of the vector v.

Parameters:

v - The input vector

Returns:

The squared magnitude of the input vector

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

projection

public static <V extends VectorWritable3IType> V projection(VectorReadable3IType p,
                                                            VectorReadable3IType q,
                                                            V r)
                                                     throws ArithmeticException

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

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

scale

public static <V extends VectorWritable3IType> V scale(VectorReadable3IType v,
                                                       double r,
                                                       V out)
                                                throws ArithmeticException

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)

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

scaleInPlace

public static <V extends VectorWritable3IType & VectorReadable3IType> V scaleInPlace(V v,
                                                                                     int r)
                                                                              throws ArithmeticException

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)

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

subtract

public static <V extends VectorWritable3IType> V subtract(VectorReadable3IType v0,
                                                          VectorReadable3IType v1,
                                                          V out)
                                                   throws ArithmeticException

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)

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

subtractInPlace

public static <V extends VectorWritable3IType & VectorReadable3IType> V subtractInPlace(V v0,
                                                                                        VectorReadable3IType v1)
                                                                                 throws ArithmeticException

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)

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

copyFrom2I

public void copyFrom2I(VectorReadable2IType in_v)

Description copied from interface: VectorWritable2IType

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

Specified by:

copyFrom2I in interface VectorWritable2IType

Parameters:

in_v - The input vector

copyFrom3I

public void copyFrom3I(VectorReadable3IType in_v)

Description copied from interface: VectorWritable3IType

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

Specified by:

copyFrom3I in interface VectorWritable3IType

Parameters:

in_v - The input vector

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

getXI

public int getXI()

Specified by:

getXI in interface VectorReadable2IType

Returns:

The X value of the given vector.

setXI

public void setXI(int in_x)

Description copied from interface: VectorWritable2IType

Set the current x value of the current vector.

Specified by:

setXI in interface VectorWritable2IType

Parameters:

in_x - The new x value.

getYI

public int getYI()

Specified by:

getYI in interface VectorReadable2IType

Returns:

The Y value of the given vector.

setYI

public void setYI(int in_y)

Description copied from interface: VectorWritable2IType

Set the current y value of the current vector.

Specified by:

setYI in interface VectorWritable2IType

Parameters:

in_y - The new y value.

getZI

public int getZI()

Specified by:

getZI in interface VectorReadable3IType

Returns:

The Z value of the given vector.

setZI

public void setZI(int in_z)

Description copied from interface: VectorWritable3IType

Set the current z value of the current vector.

Specified by:

setZI in interface VectorWritable3IType

Parameters:

in_z - The new z value.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

set2I

public void set2I(int in_x,
                  int in_y)

Description copied from interface: VectorWritable2IType

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

Specified by:

set2I in interface VectorWritable2IType

Parameters:

in_x - The new x value.

in_y - The new y value.

set3I

public void set3I(int in_x,
                  int in_y,
                  int in_z)

Description copied from interface: VectorWritable3IType

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

Specified by:

set3I in interface VectorWritable3IType

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