com.io7m.jtensors

Class VectorI2L

java.lang.Object

com.io7m.jtensors.VectorI2L

All Implemented Interfaces:

VectorReadable2LType

public class VectorI2L
extends Object
implements VectorReadable2LType

A two-dimensional immutable vector type with integer elements.

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

Since:

5.3.0

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
VectorI2L() Default constructor, initializing the vector with values [0, 0, 0].
VectorI2L(long in_x, long in_y) Construct a vector initialized with the given values.
VectorI2L(VectorReadable2LType in_v) Construct a vector initialized with the values given in the vector in_v.

Method Summary

Modifier and Type	Method and Description
static VectorI2L	absolute(VectorReadable2LType v) Calculate the absolute values of the elements in vector v.
static VectorI2L	add(VectorReadable2LType v0, VectorReadable2LType v1) Calculate the element-wise sum of the vectors v0 and v1.
static VectorI2L	addScaled(VectorReadable2LType v0, VectorReadable2LType v1, double r) Calculate the element-wise sum of the vectors v0 and the element-wise product of v1 and r.
static double	angle(VectorReadable2LType v0, VectorReadable2LType v1) Calculate the angle between the vectors v0 and v1 in radians.
static VectorI2L	clamp(VectorReadable2LType v, long minimum, long maximum) Clamp the elements of the vector v to the range [minimum ..
static VectorI2L	clampByVector(VectorReadable2LType v, VectorReadable2LType minimum, VectorReadable2LType maximum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum and maximum.
static VectorI2L	clampMaximum(VectorReadable2LType v, long maximum) Clamp the elements of the vector v to the range [-Infinity ..
static VectorI2L	clampMaximumByVector(VectorReadable2LType v, VectorReadable2LType maximum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in maximum.
static VectorI2L	clampMinimum(VectorReadable2LType v, long minimum) Clamp the elements of the vector v to the range [minimum ..
static VectorI2L	clampMinimumByVector(VectorReadable2LType v, VectorReadable2LType minimum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum.
static long	distance(VectorReadable2LType v0, VectorReadable2LType v1) Calculate the distance between the two vectors v0 and v1.
static long	dotProduct(VectorReadable2LType v0, VectorReadable2LType v1) Calculate the scalar product of the vectors v0 and v1.
boolean	equals(Object obj)
long	getXL()
long	getYL()
int	hashCode()
static VectorI2L	interpolateLinear(VectorReadable2LType v0, VectorReadable2LType v1, double alpha) Linearly interpolate between v0 and v1 by the amount alpha.
static long	magnitude(VectorReadable2LType v) Calculate the magnitude of the vector v.
static long	magnitudeSquared(VectorReadable2LType v) Calculate the squared magnitude of the vector v.
static VectorI2L	projection(VectorReadable2LType p, VectorReadable2LType q) Calculate the projection of the vector p onto the vector q.
static VectorI2L	scale(VectorReadable2LType v, double r) Scale the vector v by the scalar r.
static VectorI2L	subtract(VectorReadable2LType v0, VectorReadable2LType 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 VectorI2L ZERO

The zero vector.

Constructor Detail

VectorI2L

public VectorI2L()

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

VectorI2L

public VectorI2L(long in_x,
                 long in_y)

Construct a vector initialized with the given values.

Parameters:

in_x - The x value

in_y - The y value

VectorI2L

public VectorI2L(VectorReadable2LType in_v)

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

Parameters:

in_v - The input vector

Method Detail

absolute

public static final VectorI2L absolute(VectorReadable2LType 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 final VectorI2L add(VectorReadable2LType v0,
                                  VectorReadable2LType 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)

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

addScaled

public static final VectorI2L addScaled(VectorReadable2LType v0,
                                        VectorReadable2LType 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))

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

angle

public static final double angle(VectorReadable2LType v0,
                                 VectorReadable2LType v1)

Calculate the angle between the vectors v0 and v1 in radians.

Parameters:

v0 - The left input vector

v1 - The right input vector

Returns:

The angle between the two vectors, in radians.

clamp

public static final VectorI2L clamp(VectorReadable2LType v,
                                    long minimum,
                                    long 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 final VectorI2L clampByVector(VectorReadable2LType v,
                                            VectorReadable2LType minimum,
                                            VectorReadable2LType 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))

Since:

5.0.0

clampMaximum

public static final VectorI2L clampMaximum(VectorReadable2LType v,
                                           long 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 final VectorI2L clampMaximumByVector(VectorReadable2LType v,
                                                   VectorReadable2LType 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))

Since:

5.0.0

clampMinimum

public static final VectorI2L clampMinimum(VectorReadable2LType v,
                                           long 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 final VectorI2L clampMinimumByVector(VectorReadable2LType v,
                                                   VectorReadable2LType 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))

Since:

5.0.0

distance

public static final long distance(VectorReadable2LType v0,
                                  VectorReadable2LType 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 final long dotProduct(VectorReadable2LType v0,
                                    VectorReadable2LType 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 final VectorI2L interpolateLinear(VectorReadable2LType v0,
                                                VectorReadable2LType 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 final long magnitude(VectorReadable2LType 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 final long magnitudeSquared(VectorReadable2LType 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 final VectorI2L projection(VectorReadable2LType p,
                                         VectorReadable2LType q)
                                  throws ArithmeticException

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

Parameters:

p - The left vector

q - The right 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 final VectorI2L scale(VectorReadable2LType v,
                                    double r)
                             throws ArithmeticException

Scale the vector v by the scalar r.

Parameters:

v - The input vector

r - The scaling value

Returns:

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

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

subtract

public static final VectorI2L subtract(VectorReadable2LType v0,
                                       VectorReadable2LType 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)

Throws:

ArithmeticException - Iff an internal arithmetic operation causes an integer overflow

equals

public final boolean equals(@Nullable
                            Object obj)

Overrides:

equals in class Object

getXL

public final long getXL()

Specified by:

getXL in interface VectorReadable2LType

Returns:

The X value of the given vector.

getYL

public final long getYL()

Specified by:

getYL in interface VectorReadable2LType

Returns:

The Y value of the given vector.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object