org.apache.commons.geometry.euclidean.internal

Class Vectors

java.lang.Object

org.apache.commons.geometry.euclidean.internal.Vectors

public final class Vectors
extends Object

This class consists exclusively of static vector utility methods.

Method Summary

Modifier and Type	Method and Description
static double	checkedNorm(double norm) Throws an IllegalArgumentException if the given norm value is not real (ie, not NaN or infinite) or zero.
static double	checkedNorm(Vector<?> vec) Returns the vector's norm value, throwing an IllegalArgumentException if the value is not real (ie, not NaN or infinite) or zero.
static boolean	isRealNonZero(double value) Returns true if the given value is real (ie, not NaN or infinite) and not equal to zero.
static double	norm(double x) Get the L2 norm (commonly known as the Euclidean norm) for the vector with the given components.
static double	norm(double x1, double x2) Get the L2 norm (commonly known as the Euclidean norm) for the vector with the given components.
static double	norm(double x1, double x2, double x3) Get the L2 norm (commonly known as the Euclidean norm) for the vector with the given components.
static double	normSq(double x) Get the square of the L2 norm (also known as the Euclidean norm) for the vector with the given components.
static double	normSq(double x1, double x2) Get the square of the L2 norm (also known as the Euclidean norm) for the vector with the given components.
static double	normSq(double x1, double x2, double x3) Get the square of the L2 norm (also known as the Euclidean norm) for the vector with the given components.
static <V extends Vector<V>> V	tryNormalize(V vec) Attempt to normalize the given vector, returning null if the vector cannot be normalized due to the norm being NaN, infinite, or null.

Methods inherited from class java.lang.Object

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

Method Detail

isRealNonZero

public static boolean isRealNonZero(double value)

Returns true if the given value is real (ie, not NaN or infinite) and not equal to zero.

Parameters:

value - the value to test

Returns:

true if value is not NaN, infinite, or zero; otherwise false

checkedNorm

public static double checkedNorm(double norm)

Throws an IllegalArgumentException if the given norm value is not real (ie, not NaN or infinite) or zero. The argument is returned to allow this method to be called inline.

Parameters:

norm - vector norm value

Returns:

the validated norm value

Throws:

IllegalArgumentException - if the given norm value is NaN, infinite, or zero

checkedNorm

public static double checkedNorm(Vector<?> vec)

Returns the vector's norm value, throwing an IllegalArgumentException if the value is not real (ie, not NaN or infinite) or zero.

Parameters:

vec - vector to obtain the real, non-zero norm of

Returns:

the validated norm value

Throws:

IllegalArgumentException - if the vector norm value is NaN, infinite, or zero

tryNormalize

public static <V extends Vector<V>> V tryNormalize(V vec)

Attempt to normalize the given vector, returning null if the vector cannot be normalized due to the norm being NaN, infinite, or null.

Type Parameters:

V - Vector implementation type

Parameters:

vec - the vector to attempt to normalize

Returns:

the normalized vector if successful, otherwise null

norm

public static double norm(double x)

Get the L₂ norm (commonly known as the Euclidean norm) for the vector with the given components. This corresponds to the common notion of vector magnitude or length and is defined as the square root of the sum of the squares of all vector components.

Parameters:

x - vector component

Returns:

L₂ norm for the vector with the given components

See Also:

L2 Norm

norm

public static double norm(double x1,
                          double x2)

Get the L₂ norm (commonly known as the Euclidean norm) for the vector with the given components. This corresponds to the common notion of vector magnitude or length and is defined as the square root of the sum of the squares of all vector components.

Parameters:

x1 - first vector component

x2 - second vector component

Returns:

L₂ norm for the vector with the given components

See Also:

L2 Norm

norm

public static double norm(double x1,
                          double x2,
                          double x3)

Get the L₂ norm (commonly known as the Euclidean norm) for the vector with the given components. This corresponds to the common notion of vector magnitude or length and is defined as the square root of the sum of the squares of all vector components.

Parameters:

x1 - first vector component

x2 - second vector component

x3 - third vector component

Returns:

L₂ norm for the vector with the given components

See Also:

L2 Norm

normSq

public static double normSq(double x)

Get the square of the L₂ norm (also known as the Euclidean norm) for the vector with the given components. This is equal to the sum of the squares of all vector components.

Parameters:

x - vector component

Returns:

square of the L₂ norm for the vector with the given components

See Also:

norm(double)

normSq

public static double normSq(double x1,
                            double x2)

Get the square of the L₂ norm (also known as the Euclidean norm) for the vector with the given components. This is equal to the sum of the squares of all vector components.

Parameters:

x1 - first vector component

x2 - second vector component

Returns:

square of the L₂ norm for the vector with the given components

See Also:

norm(double, double)

normSq

public static double normSq(double x1,
                            double x2,
                            double x3)

Get the square of the L₂ norm (also known as the Euclidean norm) for the vector with the given components. This is equal to the sum of the squares of all vector components.

Parameters:

x1 - first vector component

x2 - second vector component

x3 - third vector component

Returns:

square of the L₂ norm for the vector with the given components

See Also:

norm(double, double, double)