org.apache.commons.geometry.euclidean.oned

Class Vector1D.Unit

java.lang.Object

org.apache.commons.geometry.euclidean.EuclideanVector<Vector1D>

org.apache.commons.geometry.euclidean.oned.Vector1D

org.apache.commons.geometry.euclidean.oned.Vector1D.Unit

All Implemented Interfaces:

Point<Vector1D>, Spatial, Vector<Vector1D>

Enclosing class:

Vector1D

public static final class Vector1D.Unit
extends Vector1D

Represent unit vectors. This allows optimizations to be performed for certain operations.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.geometry.euclidean.oned.Vector1D

Vector1D.Sum, Vector1D.Unit

Field Summary

Fields

Modifier and Type	Field and Description
static Vector1D.Unit	MINUS Negation of unit vector (coordinates: -1).
static Vector1D.Unit	PLUS Unit vector (coordinates: 1).

Fields inherited from class org.apache.commons.geometry.euclidean.oned.Vector1D

COORDINATE_ASCENDING_ORDER, NaN, NEGATIVE_INFINITY, POSITIVE_INFINITY, ZERO

Method Summary

Modifier and Type	Method and Description
static Vector1D.Unit	from(double x) Create a normalized vector.
static Vector1D.Unit	from(Vector1D v) Create a normalized vector.
Vector1D	negate()
double	norm()
Vector1D.Unit	normalize()
Vector1D.Unit	normalizeOrNull()
double	normSq()
Vector1D	withNorm(double mag)

Methods inherited from class org.apache.commons.geometry.euclidean.oned.Vector1D

add, add, angle, directionTo, distance, distanceSq, dot, eq, equals, getDimension, getX, getZero, hashCode, isFinite, isInfinite, isNaN, lerp, multiply, of, parse, subtract, subtract, toString, transform, vectorTo

Methods inherited from class org.apache.commons.geometry.euclidean.EuclideanVector

getCheckedNorm, isZero

Methods inherited from class java.lang.Object

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

Field Detail

PLUS

public static final Vector1D.Unit PLUS

Unit vector (coordinates: 1).

MINUS

public static final Vector1D.Unit MINUS

Negation of unit vector (coordinates: -1).

Method Detail

norm

public double norm()

Specified by:

norm in interface Vector<Vector1D>

Overrides:

norm in class Vector1D

normSq

public double normSq()

Specified by:

normSq in interface Vector<Vector1D>

Overrides:

normSq in class Vector1D

normalize

public Vector1D.Unit normalize()

Specified by:

normalize in interface Vector<Vector1D>

Overrides:

normalize in class Vector1D

normalizeOrNull

public Vector1D.Unit normalizeOrNull()

Specified by:

normalizeOrNull in interface Vector<Vector1D>

Overrides:

normalizeOrNull in class Vector1D

withNorm

public Vector1D withNorm(double mag)

Specified by:

withNorm in interface Vector<Vector1D>

Overrides:

withNorm in class Vector1D

negate

public Vector1D negate()

Specified by:

negate in interface Vector<Vector1D>

Overrides:

negate in class Vector1D

from

public static Vector1D.Unit from(double x)

Create a normalized vector.

Parameters:

x - Vector coordinate.

Returns:

a vector whose norm is 1.

Throws:

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

from

public static Vector1D.Unit from(Vector1D v)

Create a normalized vector.

Parameters:

v - Vector.

Returns:

a vector whose norm is 1.

Throws:

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