com.io7m.jtensors

Class VectorI3I

java.lang.Object

com.io7m.jtensors.VectorI3I

All Implemented Interfaces:

VectorReadable2IType, VectorReadable3IType

@Immutable
public final class VectorI3I
extends Object
implements VectorReadable3IType

A three-dimensional immutable vector type with integer elements.

Values of this type are immutable and can therefore be safely accessed from multiple threads.

Field Summary

Fields

Modifier and Type	Field and Description
static VectorI3I	ZERO The zero vector.

Constructor Summary

Constructors

Constructor and Description
VectorI3I() Default constructor, initializing the vector with values [0, 0, 0].
VectorI3I(int in_x, int in_y, int in_z) Construct a vector initialized with the given values.
VectorI3I(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 VectorI3I	absolute(VectorReadable3IType v) Calculate the absolute values of the elements in vector v.
static VectorI3I	add(VectorReadable3IType v0, VectorReadable3IType v1) Calculate the element-wise sum of the vectors v0 and v1.
static VectorI3I	addScaled(VectorReadable3IType v0, VectorReadable3IType v1, double r) Calculate the element-wise sum of the vectors v0 and the element-wise product of v1 and r.
static VectorI3I	clamp(VectorReadable3IType v, int minimum, int maximum) Clamp the elements of the vector v to the range {@code [minimum ..
static VectorI3I	clampByVector(VectorReadable3IType 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.
static VectorI3I	clampMaximum(VectorReadable3IType v, int maximum) Clamp the elements of the vector v to the range {@code [-Infinity ..
static VectorI3I	clampMaximumByVector(VectorReadable3IType v, VectorReadable3IType maximum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in maximum.
static VectorI3I	clampMinimum(VectorReadable3IType v, int minimum) Clamp the elements of the vector v to the range {@code [minimum ..
static VectorI3I	clampMinimumByVector(VectorReadable3IType v, VectorReadable3IType minimum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum.
static int	distance(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 VectorI3I	interpolateLinear(VectorReadable3IType v0, VectorReadable3IType v1, double alpha) Linearly interpolate between v0 and v1 by the amount alpha.
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 VectorI3I	projection(VectorReadable3IType p, VectorReadable3IType q) Calculate the projection of the vector p onto the vector q.
static VectorI3I	scale(VectorReadable3IType v, double r) Scale the vector v by the scalar r, saving the result to out.
static VectorI3I	subtract(VectorReadable3IType v0, VectorReadable3IType v1) Subtract the vector v1 from the vector v0.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

public static final VectorI3I ZERO

The zero vector.

Constructor Detail

VectorI3I

public VectorI3I()

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

VectorI3I

public VectorI3I(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

VectorI3I

public VectorI3I(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 VectorI3I absolute(VectorReadable3IType v)
                          throws ArithmeticException

Calculate the absolute values of the elements in vector v.

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

Since:

5.0.0

add

public static VectorI3I add(VectorReadable3IType v0,
                            VectorReadable3IType v1)
                     throws ArithmeticException

Calculate the element-wise sum of the vectors v0 and v1.

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 VectorI3I addScaled(VectorReadable3IType 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.

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 VectorI3I clamp(VectorReadable3IType v,
                              int minimum,
                              int maximum)

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

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

Since:

5.0.0

clampByVector

public static VectorI3I clampByVector(VectorReadable3IType 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.

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

Since:

5.0.0

clampMaximum

public static VectorI3I clampMaximum(VectorReadable3IType v,
                                     int maximum)

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

Parameters:

v - The input vector

maximum - The maximum allowed value

Returns:

A vector with both elements equal to at most maximum

Since:

5.0.0

clampMaximumByVector

public static VectorI3I clampMaximumByVector(VectorReadable3IType v,
                                             VectorReadable3IType maximum)

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

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

Since:

5.0.0

clampMinimum

public static VectorI3I clampMinimum(VectorReadable3IType v,
                                     int minimum)

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

Parameters:

v - The input vector

minimum - The minimum allowed value

Returns:

A vector with both elements equal to at least minimum

Since:

5.0.0

clampMinimumByVector

public static VectorI3I clampMinimumByVector(VectorReadable3IType v,
                                             VectorReadable3IType minimum)

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

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

Since:

5.0.0

distance

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

Calculate the distance between the two vectors v0 and v1.

Parameters:

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:

5.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

Since:

5.0.0

interpolateLinear

public static VectorI3I interpolateLinear(VectorReadable3IType v0,
                                          VectorReadable3IType v1,
                                          double alpha)
                                   throws ArithmeticException

Linearly interpolate between v0 and v1 by the amount alpha. 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

Parameters:

v0 - The left input vector.

v1 - The right input vector.

alpha - The interpolation value, between 0.0 and 1.0.

Returns:

(1 - alpha) * v0 + alpha * v1

Throws:

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

Since:

5.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

Since:

5.0.0

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

Since:

5.0.0

projection

public static VectorI3I projection(VectorReadable3IType p,
                                   VectorReadable3IType q)
                            throws ArithmeticException

Calculate the projection of the vector p onto the vector q.

Parameters:

q - The right vector

p - The left vector

Returns:

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

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

Since:

5.0.0

scale

public static VectorI3I scale(VectorReadable3IType v,
                              double r)
                       throws ArithmeticException

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

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 VectorI3I subtract(VectorReadable3IType v0,
                                 VectorReadable3IType v1)
                          throws ArithmeticException

Subtract the vector v1 from the vector v0.

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

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.

getYI

public int getYI()

Specified by:

getYI in interface VectorReadable2IType

Returns:

The Y value of the given vector.

getZI

public int getZI()

Specified by:

getZI in interface VectorReadable3IType

Returns:

The Z value of the given vector.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object