Vector3D (Apache Commons Geometry Euclidean 1.0 API)

java.lang.Object
- org.apache.commons.geometry.euclidean.EuclideanVector<V>
- - org.apache.commons.geometry.euclidean.MultiDimensionalEuclideanVector<Vector3D>
  - - org.apache.commons.geometry.euclidean.threed.Vector3D

All Implemented Interfaces:

Point<Vector3D>, Spatial, Vector<Vector3D>

Direct Known Subclasses:

Vector3D.Unit
```
public class Vector3D
extends MultiDimensionalEuclideanVector<Vector3D>
```
This class represents vectors and points in three-dimensional Euclidean space. Instances of this class are guaranteed to be immutable.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Vector3D.Sum
Class used to create high-accuracy sums of vectors.

static class Vector3D.Unit
Represents unit vectors.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Vector3D.Sum` Class used to create high-accuracy sums of vectors.
`static class`	`Vector3D.Unit` Represents unit vectors.

Field Summary

Fields
Modifier and Type	Field and Description
`static Comparator<Vector3D>`	`COORDINATE_ASCENDING_ORDER` Comparator that sorts vectors in component-wise ascending order.
`static Vector3D`	`NaN` A vector with all coordinates set to NaN.
`static Vector3D`	`NEGATIVE_INFINITY` A vector with all coordinates set to negative infinity.
`static Vector3D`	`POSITIVE_INFINITY` A vector with all coordinates set to positive infinity.
`static Vector3D`	`ZERO` Zero (null) vector (coordinates: 0, 0, 0).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Vector3D`	`add(double factor, Vector3D v)`
`Vector3D`	`add(Vector3D v)`
`double`	`angle(Vector3D v)`
`static Vector3D`	`centroid(Iterable<Vector3D> pts)` Compute the centroid of the given points.
`static Vector3D`	`centroid(Vector3D first, Vector3D... more)` Compute the centroid of the given points.
`Vector3D`	`cross(Vector3D v)` Compute the cross-product of the instance with another vector.
`Vector3D.Unit`	`directionTo(Vector3D v)` Return the unit vector representing the direction of displacement from this vector to the given vector.
`double`	`distance(Vector3D v)`
`double`	`distanceSq(Vector3D v)`
`double`	`dot(Vector3D v)`
`boolean`	`eq(Vector3D vec, Precision.DoubleEquivalence precision)` Return true if the current instance and given vector are considered equal as evaluated by the given precision context.
`boolean`	`equals(Object other)` d Test for the equality of two vector instances.
`int`	`getDimension()`
`double`	`getX()` Return the x coordinate value (abscissa) of the instance.
`double`	`getY()` Return the y coordinate value (ordinate) of the instance.
`double`	`getZ()` Returns the z coordinate value (height) of the instance.
`Vector3D`	`getZero()`
`int`	`hashCode()` Get a hashCode for the vector.
`boolean`	`isFinite()`
`boolean`	`isInfinite()`
`boolean`	`isNaN()`
`Vector3D`	`lerp(Vector3D p, double t)` Get a vector constructed by linearly interpolating between this vector and the given vector.
`static Vector3D`	`max(Iterable<Vector3D> vecs)` Return a vector containing the maximum component values from all input vectors.
`static Vector3D`	`max(Vector3D first, Vector3D... more)` Return a vector containing the maximum component values from all input vectors.
`static Vector3D`	`min(Iterable<Vector3D> vecs)` Return a vector containing the minimum component values from all input vectors.
`static Vector3D`	`min(Vector3D first, Vector3D... more)` Return a vector containing the minimum component values from all input vectors.
`Vector3D`	`multiply(double a)`
`Vector3D`	`negate()`
`double`	`norm()`
`Vector3D.Unit`	`normalize()`
`Vector3D.Unit`	`normalizeOrNull()`
`double`	`normSq()`
`static Vector3D`	`of(double[] v)` Creates a vector from the coordinates in the given 3-element array.
`static Vector3D`	`of(double x, double y, double z)` Returns a vector with the given coordinate values.
`Vector3D.Unit`	`orthogonal()` Get a unit vector orthogonal to the instance.
`Vector3D.Unit`	`orthogonal(Vector3D dir)` Get a unit vector orthogonal to the current vector and pointing in the direction of `dir`.
`static Vector3D`	`parse(String str)` Parses the given string and returns a new vector instance.
`Vector3D`	`project(Vector3D base)` Get the projection of the instance onto the given base vector.
`Vector3D`	`reject(Vector3D base)` Get the rejection of the instance from the given base vector.
`Vector3D`	`subtract(double factor, Vector3D v)`
`Vector3D`	`subtract(Vector3D v)`
`double[]`	`toArray()` Get the coordinates for this instance as a dimension 3 array.
`String`	`toString()`
`Vector3D`	`transform(UnaryOperator<Vector3D> fn)` Convenience method to apply a function to this vector.
`Vector3D`	`vectorTo(Vector3D v)` Return the vector representing the displacement from this vector to the given vector.
`Vector3D`	`withNorm(double magnitude)`

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
  - ZERO
```
public static final Vector3D ZERO
```
    Zero (null) vector (coordinates: 0, 0, 0).
  - NaN
```
public static final Vector3D NaN
```
    A vector with all coordinates set to NaN.
  - POSITIVE_INFINITY
```
public static final Vector3D POSITIVE_INFINITY
```
    A vector with all coordinates set to positive infinity.
  - NEGATIVE_INFINITY
```
public static final Vector3D NEGATIVE_INFINITY
```
    A vector with all coordinates set to negative infinity.
  - COORDINATE_ASCENDING_ORDER
```
public static final Comparator<Vector3D> COORDINATE_ASCENDING_ORDER
```
    Comparator that sorts vectors in component-wise ascending order. Vectors are only considered equal if their coordinates match exactly. Null arguments are evaluated as being greater than non-null arguments.
- Method Detail
  - getX
```
public double getX()
```
    Return the x coordinate value (abscissa) of the instance.
    
    Returns:
    
    the x coordinate value
  - getY
```
public double getY()
```
    Return the y coordinate value (ordinate) of the instance.
    
    Returns:
    
    the y coordinate value
  - getZ
```
public double getZ()
```
    Returns the z coordinate value (height) of the instance.
    
    Returns:
    
    the z coordinate value
  - toArray
```
public double[] toArray()
```
    Get the coordinates for this instance as a dimension 3 array.
    
    Returns:
    
    the coordinates for this instance
  - getDimension
```
public int getDimension()
```
  - isNaN
```
public boolean isNaN()
```
  - isInfinite
```
public boolean isInfinite()
```
  - isFinite
```
public boolean isFinite()
```
  - getZero
```
public Vector3D getZero()
```
  - vectorTo
```
public Vector3D vectorTo(Vector3D v)
```
    Return the vector representing the displacement from this vector to the given vector. This is exactly equivalent to v.subtract(thisVector) but with a method name that is much easier to visualize.
    
    Specified by:
    
    vectorTo in class EuclideanVector<Vector3D>
    
    Parameters:
    
    v - the vector that the returned vector will be directed toward
    
    Returns:
    
    vector representing the displacement from this vector to the given vector
  - directionTo
```
public Vector3D.Unit directionTo(Vector3D v)
```
    Return the unit vector representing the direction of displacement from this vector to the given vector. This is exactly equivalent to v.subtract(thisVector).normalize() but without the intermediate vector instance.
    
    Specified by:
    
    directionTo in class EuclideanVector<Vector3D>
    
    Parameters:
    
    v - the vector that the returned vector will be directed toward
    
    Returns:
    
    unit vector representing the direction of displacement from this vector to the given vector
  - lerp
```
public Vector3D lerp(Vector3D p,
                     double t)
```
    Get a vector constructed by linearly interpolating between this vector and the given vector. The vector coordinates are generated by the equation V = (1 - t)*A + t*B, where A is the current vector and B is the given vector. This means that if t = 0, a vector equal to the current vector will be returned. If t = 1, a vector equal to the argument will be returned. The t parameter is not constrained to the range [0, 1], meaning that linear extrapolation can also be performed with this method.
    
    Specified by:
    
    lerp in class EuclideanVector<Vector3D>
    
    Parameters:
    
    p - other vector
    
    t - interpolation parameter
    
    Returns:
    
    interpolated or extrapolated vector
  - norm
```
public double norm()
```
  - normSq
```
public double normSq()
```
  - withNorm
```
public Vector3D withNorm(double magnitude)
```
  - add
```
public Vector3D add(Vector3D v)
```
  - add
```
public Vector3D add(double factor,
                    Vector3D v)
```
  - subtract
```
public Vector3D subtract(Vector3D v)
```
  - subtract
```
public Vector3D subtract(double factor,
                         Vector3D v)
```
  - negate
```
public Vector3D negate()
```
  - normalize
```
public Vector3D.Unit normalize()
```
  - normalizeOrNull
```
public Vector3D.Unit normalizeOrNull()
```
  - multiply
```
public Vector3D multiply(double a)
```
  - distance
```
public double distance(Vector3D v)
```
  - distanceSq
```
public double distanceSq(Vector3D v)
```
  - dot
```
public double dot(Vector3D v)
```
    The implementation uses specific multiplication and addition algorithms to preserve accuracy and reduce cancellation effects. It should be very accurate even for nearly orthogonal vectors.
    
    See Also:
    
    Sum
  - angle
```
public double angle(Vector3D v)
```
    This method computes the angular separation between two vectors using the dot product for well separated vectors and the cross product for almost aligned vectors. This allows to have a good accuracy in all cases, even for vectors very close to each other.
  - project
```
public Vector3D project(Vector3D base)
```
    Get the projection of the instance onto the given base vector. The returned vector is parallel to base. Vector projection and rejection onto a given base are related by the equation v = v_projection + v_rejection
    
    Specified by:
    
    project in class MultiDimensionalEuclideanVector<Vector3D>
    
    Parameters:
    
    base - base vector
    
    Returns:
    
    the vector projection of the instance onto base
    
    See Also:
    
    MultiDimensionalEuclideanVector.reject(MultiDimensionalEuclideanVector)
  - reject
```
public Vector3D reject(Vector3D base)
```
    Get the rejection of the instance from the given base vector. The returned vector is orthogonal to base. This operation can be interpreted as returning the orthogonal projection of the instance onto the hyperplane orthogonal to base. Vector projection and rejection onto a given base are related by the equation v = v_projection + v_rejection
    
    Specified by:
    
    reject in class MultiDimensionalEuclideanVector<Vector3D>
    
    Parameters:
    
    base - base vector
    
    Returns:
    
    the vector rejection of the instance from base
    
    See Also:
    
    MultiDimensionalEuclideanVector.project(MultiDimensionalEuclideanVector)
  - orthogonal
```
public Vector3D.Unit orthogonal()
```
    Get a unit vector orthogonal to the instance.
    There are an infinite number of normalized vectors orthogonal to the instance. This method picks up one of them almost arbitrarily. It is useful when one needs to compute a reference frame with one of the axes in a predefined direction. The following example shows how to build a frame having the k axis aligned with the known vector u :
```
   Vector3D k = u.normalize();
   Vector3D i = k.orthogonal();
   Vector3D j = k.cross(i);
 
```
    Specified by:
    
    orthogonal in class MultiDimensionalEuclideanVector<Vector3D>
    
    Returns:
    
    a unit vector orthogonal to the instance
    
    Throws:
    
    IllegalArgumentException - if the norm of the instance is zero, NaN, or infinite
  - orthogonal
```
public Vector3D.Unit orthogonal(Vector3D dir)
```
    Get a unit vector orthogonal to the current vector and pointing in the direction of dir. This method is equivalent to calling dir.reject(vec).normalize() except that no intermediate vector object is produced.
    
    Specified by:
    
    orthogonal in class MultiDimensionalEuclideanVector<Vector3D>
    
    Parameters:
    
    dir - the direction to use for generating the orthogonal vector
    
    Returns:
    
    unit vector orthogonal to the current vector and pointing in the direction of dir that does not lie along the current vector
  - cross
```
public Vector3D cross(Vector3D v)
```
    Compute the cross-product of the instance with another vector.
    
    Parameters:
    
    v - other vector
    
    Returns:
    
    the cross product this ^ v as a new Vector3D
  - transform
```
public Vector3D transform(UnaryOperator<Vector3D> fn)
```
    Convenience method to apply a function to this vector. This can be used to transform the vector inline with other methods.
    
    Parameters:
    
    fn - the function to apply
    
    Returns:
    
    the transformed vector
  - eq
```
public boolean eq(Vector3D vec,
                  Precision.DoubleEquivalence precision)
```
    Return true if the current instance and given vector are considered equal as evaluated by the given precision context.
    Equality is determined by comparing each pair of components in turn from the two vectors. If all components evaluate as equal, then the vectors are considered equal. If any are not equal, then the vectors are not considered equal. Note that this approach means that the calculated distance between two "equal" vectors may be as much as √(n * eps²), where n is the number of components in the vector and eps is the maximum epsilon value allowed by the precision context.
    
    Specified by:
    
    eq in class EuclideanVector<Vector3D>
    
    Parameters:
    
    vec - vector to check for equality
    
    precision - precision context used to determine floating point equality
    
    Returns:
    
    true if the current instance is considered equal to the given vector when using the given precision context; otherwise false
  - hashCode
```
public int hashCode()
```
    Get a hashCode for the vector.
    All NaN values have the same hash code.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object
  - equals
```
public boolean equals(Object other)
```
    d Test for the equality of two vector instances.
    If all coordinates of two vectors are exactly the same, and none are Double.NaN, the two instances are considered to be equal.
    
    NaN coordinates are considered to globally affect the vector and be equal to each other - i.e, if either (or all) coordinates of the vector are equal to Double.NaN, the vector is equal to NaN.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - Object to test for equality to this
    
    Returns:
    
    true if two Vector3D objects are equal, false if object is null, not an instance of Vector3D, or not equal to this Vector3D instance
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - of
```
public static Vector3D of(double x,
                          double y,
                          double z)
```
    Returns a vector with the given coordinate values.
    
    Parameters:
    
    x - x coordinate value
    
    y - y coordinate value
    
    z - z coordinate value
    
    Returns:
    
    vector instance
  - of
```
public static Vector3D of(double[] v)
```
    Creates a vector from the coordinates in the given 3-element array.
    
    Parameters:
    
    v - coordinates array
    
    Returns:
    
    new vector
    
    Throws:
    
    IllegalArgumentException - if the array does not have 3 elements
  - parse
```
public static Vector3D parse(String str)
```
    Parses the given string and returns a new vector instance. The expected string format is the same as that returned by toString().
    
    Parameters:
    
    str - the string to parse
    
    Returns:
    
    vector instance represented by the string
    
    Throws:
    
    IllegalArgumentException - if the given string has an invalid format
  - max
```
public static Vector3D max(Vector3D first,
                           Vector3D... more)
```
    Return a vector containing the maximum component values from all input vectors.
    
    Parameters:
    
    first - first vector
    
    more - additional vectors
    
    Returns:
    
    a vector containing the maximum component values from all input vectors
  - max
```
public static Vector3D max(Iterable<Vector3D> vecs)
```
    Return a vector containing the maximum component values from all input vectors.
    
    Parameters:
    
    vecs - input vectors
    
    Returns:
    
    a vector containing the maximum component values from all input vectors
    
    Throws:
    
    IllegalArgumentException - if the argument does not contain any vectors
  - min
```
public static Vector3D min(Vector3D first,
                           Vector3D... more)
```
    Return a vector containing the minimum component values from all input vectors.
    
    Parameters:
    
    first - first vector
    
    more - additional vectors
    
    Returns:
    
    a vector containing the minimum component values from all input vectors
  - min
```
public static Vector3D min(Iterable<Vector3D> vecs)
```
    Return a vector containing the minimum component values from all input vectors.
    
    Parameters:
    
    vecs - input vectors
    
    Returns:
    
    a vector containing the minimum component values from all input vectors
    
    Throws:
    
    IllegalArgumentException - if the argument does not contain any vectors
  - centroid
```
public static Vector3D centroid(Vector3D first,
                                Vector3D... more)
```
    Compute the centroid of the given points. The centroid is the arithmetic mean position of a set of points.
    
    Parameters:
    
    first - first point
    
    more - additional points
    
    Returns:
    
    the centroid of the given points
  - centroid
```
public static Vector3D centroid(Iterable<Vector3D> pts)
```
    Compute the centroid of the given points. The centroid is the arithmetic mean position of a set of points.
    
    Parameters:
    
    pts - the points to compute the centroid of
    
    Returns:
    
    the centroid of the given points
    
    Throws:
    
    IllegalArgumentException - if the argument contains no points

Class Vector3D

Nested Class Summary

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

ZERO

NaN

POSITIVE_INFINITY

NEGATIVE_INFINITY

COORDINATE_ASCENDING_ORDER

Method Detail

getX

getY

getZ

toArray

getDimension

isNaN

isInfinite

isFinite

getZero

vectorTo

directionTo

lerp

norm

normSq

withNorm

add

add

subtract

subtract

negate

normalize

normalizeOrNull

multiply

distance

distanceSq

dot

angle

project

reject

orthogonal

orthogonal

cross

transform

eq

hashCode

equals

toString

of

of

parse

max

max

min

min

centroid

centroid