org.monospark.geometrix.vector

Class Vec<D extends OneMin>

java.lang.Object

org.monospark.geometrix.GeometrixObject

org.monospark.geometrix.vector.Vec<D>

Type Parameters:

D - the dimension of the vector

public final class Vec<D extends OneMin>
extends GeometrixObject

A vector in any dimension.

See Also:

VecHelper

Method Summary

Modifier and Type	Method and Description
static <D extends OneMin> Vec<D>	create(D dim, double... values) Constructs a new Vec using an array of double values.
static <D extends OneMin> java.util.Optional<Vec<D>>	createOptional(D dim, double... values) Constructs a new Vec using an array of double values.
boolean	equals(java.lang.Object o)
static Vec<Four>	four(double x, double y, double z, double w)
D	getDimension()
double	getElement(int index) Gets the element of this vector at a specified location.
int	hashCode()
static boolean	isInObjectSpace(Vec<?> v) Checks if a vector lies inside of the object space.
static boolean	isZeroVec(Vec<?> v) Checks if a vector is a zero vector.
static Vec<One>	one(double x)
boolean	resembles(java.lang.Object o)
static Vec<Three>	three(double x, double y, double z)
java.lang.String	toString()
static Vec<Two>	two(double x, double y)
static <D extends OneMin> Vec<D>	zero(D dim)

Methods inherited from class java.lang.Object

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

Method Detail

zero

public static <D extends OneMin> Vec<D> zero(D dim)

one

public static Vec<One> one(double x)

two

public static Vec<Two> two(double x,
                           double y)

three

public static Vec<Three> three(double x,
                               double y,
                               double z)

four

public static Vec<Four> four(double x,
                             double y,
                             double z,
                             double w)

create

public static <D extends OneMin> Vec<D> create(D dim,
                                               double... values)

Constructs a new Vec using an array of double values.

Parameters:

values - the components of the vector

Returns:

the created vector.

Throws:

java.lang.IllegalArgumentException - if the specified dimension and the amount of values doesn't match

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

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

createOptional

public static <D extends OneMin> java.util.Optional<Vec<D>> createOptional(D dim,
                                                                           double... values)

Constructs a new Vec using an array of double values.

Parameters:

values - the components of the vector

Returns:

the created vector. If the vector lies outside of the vector space, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if dim is null

java.lang.IllegalArgumentException - if the specified dimension and the amount of values doesn't match

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

isZeroVec

public static boolean isZeroVec(Vec<?> v)

Checks if a vector is a zero vector.

Parameters:

v - the vector which should be checked

Returns:

true if the vector is a zero vector, false if not

Throws:

java.lang.NullPointerException - if v is null

isInObjectSpace

public static boolean isInObjectSpace(Vec<?> v)

Checks if a vector lies inside of the object space.

Parameters:

v - the vector which should be checked

Returns:

true if the vector is inside of the object space, false if not

Throws:

java.lang.NullPointerException - if v is null

getElement

public double getElement(int index)

Gets the element of this vector at a specified location.

Parameters:

index - the index of the component

Returns:

the element of this vector at the specified location

Throws:

java.lang.IllegalArgumentException - if index is out of bounds

resembles

public boolean resembles(java.lang.Object o)

Specified by:

resembles in class GeometrixObject

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class GeometrixObject

hashCode

public int hashCode()

Specified by:

hashCode in class GeometrixObject

toString

public java.lang.String toString()

Specified by:

toString in class GeometrixObject

getDimension

public D getDimension()