com.io7m.jtensors.core.unparameterized.vectors

Class Vectors4I

java.lang.Object

com.io7m.jtensors.core.unparameterized.vectors.Vectors4I

public final class Vectors4I
extends Object

Functions over Vector4I values.

See "Mathematics for 3D Game Programming and Computer Graphics" 2nd Ed for the derivations of most of the code in this class (ISBN: 1-58450-277-0).

Since:

8.0.0

Method Summary

Modifier and Type	Method and Description
static Vector4I	absolute(Vector4I v0) Calculate the absolute of v0.
static Vector4I	add(Vector4I v0, Vector4I v1) Add v0 to v1.
static Vector4I	addScaled(Vector4I v0, Vector4I v1, double r) Add v0 to v1 * r.
static Vector4I	clamp(Vector4I v, Vector4I v_min, Vector4I v_max) Clamp the values in v by v_min and v_max.
static long	distance(Vector4I v0, Vector4I v1) Calculate the distance between v0 and v1.
static long	dotProduct(Vector4I v0, Vector4I v1) Calculate the scalar product of the vectors v0 and v1.
static Vector4I	interpolateLinear(Vector4I v0, Vector4I v1, double alpha) Linearly interpolate between v0 and v1 by the amount alpha.
static double	magnitude(Vector4I v0) Calculate the magnitude of the vector v0.
static long	magnitudeSquared(Vector4I v0) Calculate the squared magnitude of the vector v0.
static Vector4I	negate(Vector4I v) Calculate the negation of v.
static Vector4I	scale(Vector4I v0, double r) Scale v0 by r.
static Vector4I	subtract(Vector4I v0, Vector4I v1) Subtract v1 from v0.
static Vector4I	zero() The zero vector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

absolute

public static Vector4I absolute(Vector4I v0)

Calculate the absolute of v0.

Returns:

(abs v0.x, abs v0.y, abs v0.z, abs v0.w) * @param v0 The vector

add

public static Vector4I add(Vector4I v0,
                           Vector4I v1)

Add v0 to v1.

Parameters:

v1 - The right vector

Returns:

(v0.x + v1.x, v0.y + v0.y, v0.z + v1.z, v0.w + v1.w) * @param v0 The left vector

addScaled

public static Vector4I addScaled(Vector4I v0,
                                 Vector4I v1,
                                 double r)

Add v0 to v1 * r.

Parameters:

v1 - The right vector

r - The scaling value

Returns:

(v0.x + (v1.x * r), v0.y + (v0.y * r), v0.z + (v1.z * r), v0.w + (v1.w * r)) * @param v0 The left vector

clamp

public static Vector4I clamp(Vector4I v,
                             Vector4I v_min,
                             Vector4I v_max)

Clamp the values in v by v_min and v_max.

Parameters:

v_min - The minimum vector

v_max - The maximum vector

Returns:

(max(min(v.x, v_max.x()), v_min.x()), max(min(v.y, v_max.y()), v_min.y()), max(min(v.z, v_max.z()), v_min.z()), max(min(v.w, v_max.w()), v_min.w())) * @param v The source vector

distance

public static long distance(Vector4I v0,
                            Vector4I v1)

Calculate the distance between v0 and v1.

Parameters:

v1 - The right vector

Returns:

The distance between v0 and v1. * @param v0 The left vector

dotProduct

public static long dotProduct(Vector4I v0,
                              Vector4I v1)

Calculate the scalar product of the vectors v0 and v1. * @param v0 The left vector

Parameters:

v1 - The right vector

Returns:

The scalar product of the two vectors

interpolateLinear

public static Vector4I interpolateLinear(Vector4I v0,
                                         Vector4I v1,
                                         double alpha)

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) = v0
• interpolateLinear(v0, v1, 1.0) = v1

Parameters:

v0 - The left input vector

v1 - The right input vector

alpha - The interpolation value in the range [0, 1] * @return ((1 - alpha) * v0) + (alpha * v1)

magnitudeSquared

public static long magnitudeSquared(Vector4I v0)

Calculate the squared magnitude of the vector v0. * @param v0 The vector

Returns:

The squared magnitude of the vector

magnitude

public static double magnitude(Vector4I v0)

Calculate the magnitude of the vector v0. * @param v0 The vector

Returns:

The magnitude of the vector

negate

public static Vector4I negate(Vector4I v)

Calculate the negation of v.

Returns:

(-v.x, -v.y, -v.z, -v.w) * @param v The vector

scale

public static Vector4I scale(Vector4I v0,
                             double r)

Scale v0 by r.

Parameters:

r - The scaling value

Returns:

(v0.x * r, v0.y * r, v0.z * r, v0.w * r) * @param v0 The left vector

subtract

public static Vector4I subtract(Vector4I v0,
                                Vector4I v1)

Subtract v1 from v0.

Parameters:

v1 - The right vector

Returns:

(v0.x - v1.x, v0.y - v0.y, v0.z - v1.z, v0.w - v1.w) * @param v0 The left vector

zero

public static Vector4I zero()

The zero vector.

Returns:

(0, 0, 0, 0)