org.monospark.geometrix.vector

Class VecHelper

java.lang.Object

org.monospark.geometrix.vector.VecHelper

public final class VecHelper
extends java.lang.Object

This class which contains static helper methods for Vec objects.

See Also:

Vec

Method Summary

Modifier and Type	Method and Description
static <D extends OneMin> Vec<D>	add(Vec<D> v1, Vec<D> v2) Adds two vectors together.
static <D extends OneMin> java.util.Optional<Vec<D>>	addOptional(Vec<D> v1, Vec<D> v2) Adds two vectors together.
static <D extends OneMin> double	calculateAngleBetween(Vec<D> v1, Vec<D> v2) Calculates the angle between two vectors.
static double	calculateLength(Vec<?> v) Calculates the length of a vector.
static <D extends OneMin> Vec<D>	calculateVectorComponent(Vec<D> v, Vec<D> direc) Calculates the vector projection of v on direc, which is an orthogonal projection of v onto a straight line parallel to direc.
static Vec<Three>	cross(Vec<Three> v1, Vec<Three> v2) Calculates the cross product of two vectors.
static java.util.Optional<Vec<Three>>	crossOptional(Vec<Three> v1, Vec<Three> v2) Calculates the cross product of two vectors.
static <D extends OneMin> Vec<D>	divide(Vec<D> v, double s) Divides the vector by a scalar.
static <D extends OneMin> java.util.Optional<Vec<D>>	divideOptional(Vec<D> v, double s) Divides the vector by a scalar.
static <D extends OneMin> double	dot(Vec<D> v1, Vec<D> v2) Calculates the dot product of two vectors.
static <D extends OneMin> java.util.Optional<java.lang.Double>	dotOptional(Vec<D> v1, Vec<D> v2) Calculates the dot product of two vectors.
static <D extends OneMin> Vec<D>	multiply(Vec<D> v, double s) Multiplies the vector with a scalar.
static <R extends OneMin,C extends OneMin> Vec<C>	multiply(Vec<R> v, Mat<R,C> m) Multiplies a vector with a matrix.
static <D extends OneMin> java.util.Optional<Vec<D>>	multiplyOptional(Vec<D> v, double s) Multiplies the vector with a scalar.
static <R extends OneMin,C extends OneMin> java.util.Optional<Vec<C>>	multiplyOptional(Vec<R> v, Mat<R,C> m) Multiplies a vector with a matrix.
static <D extends OneMin> Vec<D>	negate(Vec<D> v) Negates the vector.
static <D extends OneMin> Vec<D>	normalize(Vec<D> v) Normalizes the vector.
static <D extends OneMin> Vec<D>	subtract(Vec<D> v1, Vec<D> v2) Subtracts a vector from another vector.
static <D extends OneMin> java.util.Optional<Vec<D>>	subtractOptional(Vec<D> v1, Vec<D> v2) Subtracts a vector from another vector.

Methods inherited from class java.lang.Object

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

Method Detail

add

public static <D extends OneMin> Vec<D> add(Vec<D> v1,
                                            Vec<D> v2)

Adds two vectors together.

Parameters:

v1 - the first vector

v2 - the second vector

Returns:

the result of v1 + v2.

Throws:

java.lang.NullPointerException - if v1 or v2 is null

java.lang.IllegalArgumentException - if the resulting vector lies outside of the vector space

addOptional

public static <D extends OneMin> java.util.Optional<Vec<D>> addOptional(Vec<D> v1,
                                                                        Vec<D> v2)

Adds two vectors together.

Parameters:

v1 - the first vector

v2 - the second vector

Returns:

the result of v1 + v2. If the resulting vector lies outside of the vector space, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if v1 or v2 is null

subtract

public static <D extends OneMin> Vec<D> subtract(Vec<D> v1,
                                                 Vec<D> v2)

Subtracts a vector from another vector.

Parameters:

v1 - the first vector

v2 - the second vector

Returns:

the result of v1 - v2.

Throws:

java.lang.NullPointerException - if v1 or v2 is null

java.lang.IllegalArgumentException - if the resulting vector lies outside of the vector space

subtractOptional

public static <D extends OneMin> java.util.Optional<Vec<D>> subtractOptional(Vec<D> v1,
                                                                             Vec<D> v2)

Subtracts a vector from another vector.

Parameters:

v1 - the first vector

v2 - the second vector

Returns:

the result of v1 - v2. If the resulting vector lies outside of the vector space, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if v1 or v2 is null

multiply

public static <D extends OneMin> Vec<D> multiply(Vec<D> v,
                                                 double s)

Multiplies the vector with a scalar.

Parameters:

v - the vector

s - the scalar

Returns:

the result of v * s

Throws:

java.lang.NullPointerException - if v1 or v2 is null

java.lang.IllegalArgumentException - if the resulting vector lies outside of the vector space

multiplyOptional

public static <D extends OneMin> java.util.Optional<Vec<D>> multiplyOptional(Vec<D> v,
                                                                             double s)

Multiplies the vector with a scalar.

Parameters:

v - the vector

s - the scalar

Returns:

the result of v * s. If the resulting vector lies outside of the vector space, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if v is null

java.lang.IllegalArgumentException - if s is equal to (+/-)Infinity or NaN

multiply

public static <R extends OneMin,C extends OneMin> Vec<C> multiply(Vec<R> v,
                                                                  Mat<R,C> m)

Multiplies a vector with a matrix.

Parameters:

m - the matrix

v - the vector

Returns:

the result of v * m

Throws:

java.lang.NullPointerException - if v1 or v2 is null

java.lang.IllegalArgumentException - if the resulting vector lies outside of the vector space

multiplyOptional

public static <R extends OneMin,C extends OneMin> java.util.Optional<Vec<C>> multiplyOptional(Vec<R> v,
                                                                                              Mat<R,C> m)

Multiplies a vector with a matrix.

Parameters:

m - the matrix

v - the vector

Returns:

the result of v * m. If the resulting vector lies outside of the vector space, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if m or v is null

divide

public static <D extends OneMin> Vec<D> divide(Vec<D> v,
                                               double s)

Divides the vector by a scalar.

Parameters:

v - the vector

s - the scalar

Returns:

the result of v / s

Throws:

java.lang.NullPointerException - if v1 or v2 is null

java.lang.IllegalArgumentException - if the resulting vector lies outside of the vector space

divideOptional

public static <D extends OneMin> java.util.Optional<Vec<D>> divideOptional(Vec<D> v,
                                                                           double s)

Divides the vector by a scalar.

Parameters:

v - the vector

s - the scalar

Returns:

the result of v / s. If the resulting vector lies outside of the vector space, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if v is null

java.lang.IllegalArgumentException - if s is equal to (+/-)Infinity or NaN

cross

public static Vec<Three> cross(Vec<Three> v1,
                               Vec<Three> v2)

Calculates the cross product of two vectors.

Parameters:

v1 - the first vector

v2 - the second vector

Returns:

the result of v1 x v2

Throws:

java.lang.NullPointerException - if v1 or v2 is null

java.lang.IllegalArgumentException - if the resulting vector lies outside of the vector space

crossOptional

public static java.util.Optional<Vec<Three>> crossOptional(Vec<Three> v1,
                                                           Vec<Three> v2)

Calculates the cross product of two vectors.

Parameters:

v1 - the first vector

v2 - the second vector

Returns:

the result of v1 x v2- If the resulting vector lies outside of the vector space, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if v1 or v2 is null

dot

public static <D extends OneMin> double dot(Vec<D> v1,
                                            Vec<D> v2)

Calculates the dot product of two vectors.

Parameters:

v1 - the first vector

v2 - the second vector

Returns:

the result of v1 · v2

Throws:

java.lang.NullPointerException - if v1 or v2 is null

java.lang.IllegalArgumentException - if the dot product is infinite

dotOptional

public static <D extends OneMin> java.util.Optional<java.lang.Double> dotOptional(Vec<D> v1,
                                                                                  Vec<D> v2)

Calculates the dot product of two vectors.

Parameters:

v1 - the first vector

v2 - the second vector

Returns:

the result of v1 · v2. If the dot product is infinite, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if v1 or v2 is null

negate

public static <D extends OneMin> Vec<D> negate(Vec<D> v)

Negates the vector.

Parameters:

v - the vector

Returns:

the result of -v

Throws:

java.lang.NullPointerException - if v is null

calculateLength

public static double calculateLength(Vec<?> v)

Calculates the length of a vector.

Parameters:

v - the vector

Returns:

the result of |v|

Throws:

java.lang.NullPointerException - if v is null

calculateAngleBetween

public static <D extends OneMin> double calculateAngleBetween(Vec<D> v1,
                                                              Vec<D> v2)

Calculates the angle between two vectors.

Parameters:

v1 - the first vector

v2 - the second vector

Returns:

the angle in degrees between the two vectors.

Throws:

java.lang.NullPointerException - if v1 or v2 is null

java.lang.IllegalArgumentException - if v1 or v2 is a zero vector

normalize

public static <D extends OneMin> Vec<D> normalize(Vec<D> v)

Normalizes the vector.

Parameters:

v - the vector

Returns:

the result of v / |v|

Throws:

java.lang.NullPointerException - if v is null

java.lang.IllegalArgumentException - if v is a zero vector

calculateVectorComponent

public static <D extends OneMin> Vec<D> calculateVectorComponent(Vec<D> v,
                                                                 Vec<D> direc)

Calculates the vector projection of v on direc, which is an orthogonal projection of v onto a straight line parallel to direc.

Parameters:

v - the vector which should be projected

direc - the direction of which the component should be calculated

Returns:

the vector component of v on direc.

Throws:

java.lang.NullPointerException - if v or direc is null

java.lang.IllegalArgumentException - if v is a zero vector