com.io7m.jtensors.parameterized

Class PVectorI3F<T>

java.lang.Object

com.io7m.jtensors.parameterized.PVectorI3F<T>

Type Parameters:

T - A phantom type parameter.

All Implemented Interfaces:

PVectorReadable2FType<T>, PVectorReadable3FType<T>, VectorReadable2FType, VectorReadable3FType

@Immutable
public final class PVectorI3F<T>
extends Object
implements PVectorReadable3FType<T>

A three-dimensional immutable vector type with float elements.

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

Constructor Summary

Constructors

Constructor and Description
PVectorI3F() Default constructor, initializing the vector with values [0.0, 0.0, 0.0].
PVectorI3F(float in_x, float in_y, float in_z) Construct a vector initialized with the given values.
PVectorI3F(PVectorReadable3FType<T> in_v) Construct a vector initialized with the values given in the vector in_v.

Method Summary

Modifier and Type	Method and Description
static <T> PVectorI3F<T>	absolute(PVectorReadable3FType<T> v) Calculate the absolute value of the vector v.
static <T> PVectorI3F<T>	add(PVectorReadable3FType<T> v0, PVectorReadable3FType<T> v1) Calculate the element-wise sum of the vectors v0 and v1.
static <T> PVectorI3F<T>	addScaled(PVectorReadable3FType<T> v0, PVectorReadable3FType<T> v1, float r) Calculate the element-wise sum of the vectors v0 and the element-wise product of v1 and r.
static <T> boolean	almostEqual(com.io7m.jequality.AlmostEqualFloat.ContextRelative context, PVectorReadable3FType<T> va, PVectorReadable3FType<T> vb) Determine whether or not the vectors va and vb are equal to within the degree of error given in context.
static <T> PVectorI3F<T>	clamp(PVectorReadable3FType<T> v, float minimum, float maximum) Clamp the elements of the vector v to the range {@code [minimum ..
static <T> PVectorI3F<T>	clampByPVector(PVectorReadable3FType<T> v, PVectorReadable3FType<T> minimum, PVectorReadable3FType<T> maximum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum and maximum.
static <T> PVectorI3F<T>	clampMaximum(PVectorReadable3FType<T> v, float maximum) Clamp the elements of the vector v to the range {@code [-Infinity ..
static <T> PVectorI3F<T>	clampMaximumByPVector(PVectorReadable3FType<T> v, PVectorReadable3FType<T> maximum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in maximum.
static <T> PVectorI3F<T>	clampMinimum(PVectorReadable3FType<T> v, float minimum) Clamp the elements of the vector v to the range {@code [minimum ..
static <T> PVectorI3F<T>	clampMinimumByPVector(PVectorReadable3FType<T> v, PVectorReadable3FType<T> minimum) Clamp the elements of the vector v to the inclusive range given by the corresponding elements in minimum.
static <T> PVectorI3F<T>	crossProduct(PVectorReadable3FType<T> v0, PVectorReadable3FType<T> v1) Calculate the cross product of the vectors v0 and v1.
static <T> float	distance(PVectorReadable3FType<T> v0, PVectorReadable3FType<T> v1) Calculate the distance between the two vectors v0 and v1.
static <T> float	dotProduct(PVectorReadable3FType<T> v0, PVectorReadable3FType<T> v1) Calculate the scalar product of the vectors v0 and v1.
boolean	equals(Object obj)
float	getXF()
float	getYF()
float	getZF()
int	hashCode()
static <T> PVectorI3F<T>	interpolateLinear(PVectorReadable3FType<T> v0, PVectorReadable3FType<T> v1, float alpha) Linearly interpolate between v0 and v1 by the amount alpha.
static <T> float	magnitude(PVectorReadable3FType<T> v) Calculate the magnitude of the vector v.
static <T> float	magnitudeSquared(PVectorReadable3FType<T> v) Calculate the squared magnitude of the vector v.
static <T> PVectorI3F<T>	normalize(PVectorReadable3FType<T> v) Normalize the vector v, preserving its direction but reducing it to unit length.
static <T> com.io7m.jfunctional.Pair<PVectorI3F<T>,PVectorI3F<T>>	orthoNormalize(PVectorReadable3FType<T> v0, PVectorReadable3FType<T> v1) Orthonormalize and return the vectors v0 and v1 .
static <T> PVectorI3F<T>	projection(PVectorReadable3FType<T> p, PVectorReadable3FType<T> q) Calculate the projection of the vector p onto the vector q.
static <T> PVectorI3F<T>	scale(PVectorReadable3FType<T> v, float r) Scale the vector v by the scalar r.
static <T> PVectorI3F<T>	subtract(PVectorReadable3FType<T> v0, PVectorReadable3FType<T> v1) Subtract the vector v1 from the vector v0.
String	toString()
static <T> PVectorI3F<T>	zero()

Methods inherited from class java.lang.Object

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

Constructor Detail

PVectorI3F

public PVectorI3F()

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

PVectorI3F

public PVectorI3F(float in_x,
                  float in_y,
                  float 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

PVectorI3F

public PVectorI3F(PVectorReadable3FType<T> 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 <T> PVectorI3F<T> absolute(PVectorReadable3FType<T> v)

Calculate the absolute value of the vector v.

Type Parameters:

T - A phantom type parameter.

Parameters:

v - The input vector

Returns:

(abs v.getXF(), abs v.getYF(), abs v.getZF())

add

public static <T> PVectorI3F<T> add(PVectorReadable3FType<T> v0,
                                    PVectorReadable3FType<T> v1)

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

Type Parameters:

T - A phantom type parameter.

Parameters:

v0 - The left input vector

v1 - The right input vector

Returns:

(v0.getXF() + v1.getXF(), v0.getYF() + v1.getYF(), v0.getZF() + v1.getZF())

addScaled

public static <T> PVectorI3F<T> addScaled(PVectorReadable3FType<T> v0,
                                          PVectorReadable3FType<T> v1,
                                          float r)

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

Type Parameters:

T - A phantom type parameter.

Parameters:

v0 - The left input vector

v1 - The right input vector

r - The scaling value

Returns:

(v0.getXF() + (v1.getXF() * r), v0.getYF() + (v1.getYF() * r), v0.getZF() + (v1.getZF() * r))

almostEqual

public static <T> boolean almostEqual(com.io7m.jequality.AlmostEqualFloat.ContextRelative context,
                                      PVectorReadable3FType<T> va,
                                      PVectorReadable3FType<T> vb)

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

Type Parameters:

T - A phantom type parameter.

Parameters:

context - The equality context

va - The left input vector

vb - The right input vector

Returns:

true iff the vectors are almost equal.

Since:

7.0.0

See Also:

AlmostEqualFloat.almostEqual(AlmostEqualFloat.ContextRelative, float, float)

clamp

public static <T> PVectorI3F<T> clamp(PVectorReadable3FType<T> v,
                                      float minimum,
                                      float maximum)

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

Type Parameters:

T - A phantom type parameter.

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.

clampByPVector

public static <T> PVectorI3F<T> clampByPVector(PVectorReadable3FType<T> v,
                                               PVectorReadable3FType<T> minimum,
                                               PVectorReadable3FType<T> maximum)

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

Type Parameters:

T - A phantom type parameter.

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.getXF(), minimum.getXF()), maximum.getXF()), min(max(v.getYF(), minimum.getYF()), maximum.getYF()), min(max(v.getZF(), minimum.getZF()), maximum.getZF()) )

clampMaximum

public static <T> PVectorI3F<T> clampMaximum(PVectorReadable3FType<T> v,
                                             float maximum)

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

Type Parameters:

T - A phantom type parameter.

Parameters:

v - The input vector

maximum - The maximum allowed value

Returns:

A vector with both elements equal to at most maximum

clampMaximumByPVector

public static <T> PVectorI3F<T> clampMaximumByPVector(PVectorReadable3FType<T> v,
                                                      PVectorReadable3FType<T> maximum)

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

Type Parameters:

T - A phantom type parameter.

Parameters:

v - The input vector

maximum - The vector containing the maximum acceptable values

Returns:

(min(v.getXF(), maximum.getXF()), min(v.getYF(), maximum.getYF()), min(v.getZF(), maximum.getZF()))

clampMinimum

public static <T> PVectorI3F<T> clampMinimum(PVectorReadable3FType<T> v,
                                             float minimum)

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

Type Parameters:

T - A phantom type parameter.

Parameters:

v - The input vector

minimum - The minimum allowed value

Returns:

A vector with both elements equal to at least minimum

clampMinimumByPVector

public static <T> PVectorI3F<T> clampMinimumByPVector(PVectorReadable3FType<T> v,
                                                      PVectorReadable3FType<T> minimum)

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

Type Parameters:

T - A phantom type parameter.

Parameters:

v - The input vector

minimum - The vector containing the minimum acceptable values

Returns:

(max(v.getXF(), minimum.getXF()), max(v.getYF(), minimum.getYF()), max(v.getZF(), minimum.getZF()))

crossProduct

public static <T> PVectorI3F<T> crossProduct(PVectorReadable3FType<T> v0,
                                             PVectorReadable3FType<T> v1)

Calculate the cross product of the vectors v0 and v1. The result is a vector perpendicular to both vectors.

Type Parameters:

T - A phantom type parameter.

Parameters:

v0 - The left input vector

v1 - The right input vector

Returns:

A vector perpendicular to both v0 and v1

distance

public static <T> float distance(PVectorReadable3FType<T> v0,
                                 PVectorReadable3FType<T> v1)

Calculate the distance between the two vectors v0 and v1.

Type Parameters:

T - A phantom type parameter.

Parameters:

v0 - The left input vector

v1 - The right input vector

Returns:

The distance between the two vectors

dotProduct

public static <T> float dotProduct(PVectorReadable3FType<T> v0,
                                   PVectorReadable3FType<T> v1)

Calculate the scalar product of the vectors v0 and v1.

Type Parameters:

T - A phantom type parameter.

Parameters:

v0 - The left input vector

v1 - The right input vector

Returns:

The scalar product of the two vectors

interpolateLinear

public static <T> PVectorI3F<T> interpolateLinear(PVectorReadable3FType<T> v0,
                                                  PVectorReadable3FType<T> v1,
                                                  float 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

Type Parameters:

T - A phantom type parameter.

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

magnitude

public static <T> float magnitude(PVectorReadable3FType<T> v)

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

Type Parameters:

T - A phantom type parameter.

Parameters:

v - The input vector

Returns:

The magnitude of the input vector

magnitudeSquared

public static <T> float magnitudeSquared(PVectorReadable3FType<T> v)

Calculate the squared magnitude of the vector v.

Type Parameters:

T - A phantom type parameter.

Parameters:

v - The input vector

Returns:

The squared magnitude of the input vector

normalize

public static <T> PVectorI3F<T> normalize(PVectorReadable3FType<T> v)

Normalize the vector v, preserving its direction but reducing it to unit length.

Type Parameters:

T - A phantom type parameter.

Parameters:

v - The input vector

Returns:

A vector with the same orientation as v but with magnitude equal to 1.0

orthoNormalize

public static <T> com.io7m.jfunctional.Pair<PVectorI3F<T>,PVectorI3F<T>> orthoNormalize(PVectorReadable3FType<T> v0,
                                                                                        PVectorReadable3FType<T> v1)

Orthonormalize and return the vectors v0 and v1 .

See GSP

Type Parameters:

T - A phantom type parameter.

Parameters:

v0 - The left vector

v1 - The right vector

Returns:

A pair (v0, v1), orthonormalized.

Since:

7.0.0

projection

public static <T> PVectorI3F<T> projection(PVectorReadable3FType<T> p,
                                           PVectorReadable3FType<T> q)

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

Type Parameters:

T - A phantom type parameter.

Parameters:

p - The left vector

q - The right vector

Returns:

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

scale

public static <T> PVectorI3F<T> scale(PVectorReadable3FType<T> v,
                                      float r)

Scale the vector v by the scalar r.

Type Parameters:

T - A phantom type parameter.

Parameters:

v - The input vector

r - The scaling value

Returns:

(v.getXF() * r, v.getYF() * r, v.getZF() * r)

subtract

public static <T> PVectorI3F<T> subtract(PVectorReadable3FType<T> v0,
                                         PVectorReadable3FType<T> v1)

Subtract the vector v1 from the vector v0.

Type Parameters:

T - A phantom type parameter.

Parameters:

v0 - The left input vector

v1 - The right input vector

Returns:

(v0.getXF() - v1.getXF(), v0.getYF() - v1.getYF(), v0.getZF() - v1.getZF())

zero

public static <T> PVectorI3F<T> zero()

Type Parameters:

T - A phantom type parameter.

Returns:

The zero vector.

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

getXF

public float getXF()

Specified by:

getXF in interface VectorReadable2FType

Returns:

The X value of the given vector.

getYF

public float getYF()

Specified by:

getYF in interface VectorReadable2FType

Returns:

The Y value of the given vector.

getZF

public float getZF()

Specified by:

getZF in interface VectorReadable3FType

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