Class Vector2D
- All Implemented Interfaces:
Serializable
,Point<Euclidean2D>
,Vector<Euclidean2D,
,Vector2D> Blendable<Vector<Euclidean2D,
Vector2D>>
Instances of this class are guaranteed to be immutable.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Vector2D
Opposite of the first canonical vector (coordinates: -1, 0).static final Vector2D
Opposite of the second canonical vector (coordinates: 0, -1).static final Vector2D
A vector with all coordinates set to NaN.static final Vector2D
A vector with all coordinates set to negative infinity.static final Vector2D
First canonical vector (coordinates: 1, 0).static final Vector2D
Second canonical vector (coordinates: 0, 1).static final Vector2D
A vector with all coordinates set to positive infinity.static final Vector2D
Origin (coordinates: 0, 0). -
Constructor Summary
ConstructorDescriptionVector2D
(double[] v) Simple constructor.Vector2D
(double x, double y) Simple constructor.Multiplicative constructor Build a vector from another one and a scale factor.Linear constructor Build a vector from two other ones and corresponding scale factors.Linear constructor Build a vector from three other ones and corresponding scale factors.Vector2D
(double a1, Vector2D u1, double a2, Vector2D u2, double a3, Vector2D u3, double a4, Vector2D u4) Linear constructor Build a vector from four other ones and corresponding scale factors. -
Method Summary
Modifier and TypeMethodDescriptionadd
(double factor, Vector<Euclidean2D, Vector2D> v) Add a scaled vector to the instance.add
(Vector<Euclidean2D, Vector2D> v) Add a vector to the instance.static double
Compute the angular separation between two vectors.double
crossProduct
(Vector2D p1, Vector2D p2) Compute the cross-product of the instance and the given points.static double
Compute the distance between two vectors according to the L2 norm.double
distance
(Point<Euclidean2D> p) Compute the distance between the instance and another point.static double
Compute the distance between two vectors according to the L1 norm.double
Compute the distance between the instance and another vector according to the L1 norm.static double
distanceInf
(Vector2D p1, Vector2D p2) Compute the distance between two vectors according to the L∞ norm.double
Compute the distance between the instance and another vector according to the L∞ norm.static double
distanceSq
(Vector2D p1, Vector2D p2) Compute the square of the distance between two vectors.double
Compute the square of the distance between the instance and another vector.double
Compute the dot-product of the instance and another vector.boolean
Test for the equality of two 2D vectors.boolean
equalsIeee754
(Object other) Test for the equality of two 2D vectors.double
getNorm()
Get the L2 norm for the vector.double
getNorm1()
Get the L1 norm for the vector.double
Get the L∞ norm for the vector.double
Get the square of the norm for the vector.getSpace()
Get the space to which the point belongs.double
getX()
Get the abscissa of the vector.double
getY()
Get the ordinate of the vector.getZero()
Get the null vector of the vectorial space or origin point of the affine space.int
hashCode()
Get a hashCode for the 2D vector.boolean
Returns true if any coordinate of this vector is infinite and none are NaN; false otherwiseboolean
isNaN()
Returns true if any coordinate of this point is NaN; false otherwisenegate()
Get the opposite of the instance.static double
orientation
(Vector2D p, Vector2D q, Vector2D r) Compute the orientation of a triplet of points.scalarMultiply
(double a) Multiply the instance by a scalar.subtract
(double factor, Vector<Euclidean2D, Vector2D> v) Subtract a scaled vector from the instance.Subtract a vector from the instance.double[]
toArray()
Get the vector coordinates as a dimension 2 array.toString()
Get a string representation of this vector.toString
(NumberFormat format) Get a string representation of this vector.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hipparchus.geometry.Vector
blendArithmeticallyWith, normalize
-
Field Details
-
ZERO
Origin (coordinates: 0, 0). -
PLUS_I
First canonical vector (coordinates: 1, 0).- Since:
- 1.6
-
MINUS_I
Opposite of the first canonical vector (coordinates: -1, 0).- Since:
- 1.6
-
PLUS_J
Second canonical vector (coordinates: 0, 1).- Since:
- 1.6
-
MINUS_J
Opposite of the second canonical vector (coordinates: 0, -1).- Since:
- 1.6
-
NaN
A vector with all coordinates set to NaN. -
POSITIVE_INFINITY
A vector with all coordinates set to positive infinity. -
NEGATIVE_INFINITY
A vector with all coordinates set to negative infinity.
-
-
Constructor Details
-
Vector2D
public Vector2D(double x, double y) Simple constructor. Build a vector from its coordinates -
Vector2D
Simple constructor. Build a vector from its coordinates- Parameters:
v
- coordinates array- Throws:
MathIllegalArgumentException
- if array does not have 2 elements- See Also:
-
Vector2D
Multiplicative constructor Build a vector from another one and a scale factor. The vector built will be a * u- Parameters:
a
- scale factoru
- base (unscaled) vector
-
Vector2D
Linear constructor Build a vector from two other ones and corresponding scale factors. The vector built will be a1 * u1 + a2 * u2- Parameters:
a1
- first scale factoru1
- first base (unscaled) vectora2
- second scale factoru2
- second base (unscaled) vector
-
Vector2D
Linear constructor Build a vector from three other ones and corresponding scale factors. The vector built will be a1 * u1 + a2 * u2 + a3 * u3- Parameters:
a1
- first scale factoru1
- first base (unscaled) vectora2
- second scale factoru2
- second base (unscaled) vectora3
- third scale factoru3
- third base (unscaled) vector
-
Vector2D
public Vector2D(double a1, Vector2D u1, double a2, Vector2D u2, double a3, Vector2D u3, double a4, Vector2D u4) Linear constructor Build a vector from four other ones and corresponding scale factors. The vector built will be a1 * u1 + a2 * u2 + a3 * u3 + a4 * u4- Parameters:
a1
- first scale factoru1
- first base (unscaled) vectora2
- second scale factoru2
- second base (unscaled) vectora3
- third scale factoru3
- third base (unscaled) vectora4
- fourth scale factoru4
- fourth base (unscaled) vector
-
-
Method Details
-
getX
public double getX()Get the abscissa of the vector.- Returns:
- abscissa of the vector
- See Also:
-
getY
public double getY()Get the ordinate of the vector.- Returns:
- ordinate of the vector
- See Also:
-
toArray
public double[] toArray()Get the vector coordinates as a dimension 2 array.- Returns:
- vector coordinates
- See Also:
-
getSpace
Get the space to which the point belongs.- Specified by:
getSpace
in interfacePoint<Euclidean2D>
- Returns:
- containing space
-
getZero
Get the null vector of the vectorial space or origin point of the affine space.- Specified by:
getZero
in interfaceVector<Euclidean2D,
Vector2D> - Returns:
- null vector of the vectorial space or origin point of the affine space
-
getNorm1
public double getNorm1()Get the L1 norm for the vector.- Specified by:
getNorm1
in interfaceVector<Euclidean2D,
Vector2D> - Returns:
- L1 norm for the vector
-
getNorm
public double getNorm()Get the L2 norm for the vector.- Specified by:
getNorm
in interfaceVector<Euclidean2D,
Vector2D> - Returns:
- Euclidean norm for the vector
-
getNormSq
public double getNormSq()Get the square of the norm for the vector.- Specified by:
getNormSq
in interfaceVector<Euclidean2D,
Vector2D> - Returns:
- square of the Euclidean norm for the vector
-
getNormInf
public double getNormInf()Get the L∞ norm for the vector.- Specified by:
getNormInf
in interfaceVector<Euclidean2D,
Vector2D> - Returns:
- L∞ norm for the vector
-
add
Add a vector to the instance.- Specified by:
add
in interfaceVector<Euclidean2D,
Vector2D> - Parameters:
v
- vector to add- Returns:
- a new vector
-
add
Add a scaled vector to the instance.- Specified by:
add
in interfaceVector<Euclidean2D,
Vector2D> - Parameters:
factor
- scale factor to apply to v before adding itv
- vector to add- Returns:
- a new vector
-
subtract
Subtract a vector from the instance.- Specified by:
subtract
in interfaceVector<Euclidean2D,
Vector2D> - Parameters:
p
- vector to subtract- Returns:
- a new vector
-
subtract
Subtract a scaled vector from the instance.- Specified by:
subtract
in interfaceVector<Euclidean2D,
Vector2D> - Parameters:
factor
- scale factor to apply to v before subtracting itv
- vector to subtract- Returns:
- a new vector
-
angle
Compute the angular separation between two vectors.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.
- Parameters:
v1
- first vectorv2
- second vector- Returns:
- angular separation between v1 and v2
- Throws:
MathRuntimeException
- if either vector has a null norm
-
negate
Get the opposite of the instance.- Specified by:
negate
in interfaceVector<Euclidean2D,
Vector2D> - Returns:
- a new vector which is opposite to the instance
-
scalarMultiply
Multiply the instance by a scalar.- Specified by:
scalarMultiply
in interfaceVector<Euclidean2D,
Vector2D> - Parameters:
a
- scalar- Returns:
- a new vector
-
isNaN
public boolean isNaN()Returns true if any coordinate of this point is NaN; false otherwise- Specified by:
isNaN
in interfacePoint<Euclidean2D>
- Returns:
- true if any coordinate of this point is NaN; false otherwise
-
isInfinite
public boolean isInfinite()Returns true if any coordinate of this vector is infinite and none are NaN; false otherwise- Specified by:
isInfinite
in interfaceVector<Euclidean2D,
Vector2D> - Returns:
- true if any coordinate of this vector is infinite and none are NaN; false otherwise
-
distance1
Compute the distance between the instance and another vector according to the L1 norm.Calling this method is equivalent to calling:
q.subtract(p).getNorm1()
except that no intermediate vector is built- Specified by:
distance1
in interfaceVector<Euclidean2D,
Vector2D> - Parameters:
p
- second vector- Returns:
- the distance between the instance and p according to the L1 norm
-
distance
Compute the distance between the instance and another point.- Specified by:
distance
in interfacePoint<Euclidean2D>
- Parameters:
p
- second point- Returns:
- the distance between the instance and p
-
distanceInf
Compute the distance between the instance and another vector according to the L∞ norm.Calling this method is equivalent to calling:
q.subtract(p).getNormInf()
except that no intermediate vector is built- Specified by:
distanceInf
in interfaceVector<Euclidean2D,
Vector2D> - Parameters:
p
- second vector- Returns:
- the distance between the instance and p according to the L∞ norm
-
distanceSq
Compute the square of the distance between the instance and another vector.Calling this method is equivalent to calling:
q.subtract(p).getNormSq()
except that no intermediate vector is built- Specified by:
distanceSq
in interfaceVector<Euclidean2D,
Vector2D> - Parameters:
p
- second vector- Returns:
- the square of the distance between the instance and p
-
dotProduct
Compute the dot-product of the instance and another vector.- Specified by:
dotProduct
in interfaceVector<Euclidean2D,
Vector2D> - Parameters:
v
- second vector- Returns:
- the dot product this.v
-
crossProduct
Compute the cross-product of the instance and the given points.The cross product can be used to determine the location of a point with regard to the line formed by (p1, p2) and is calculated as: \[ P = (x_2 - x_1)(y_3 - y_1) - (y_2 - y_1)(x_3 - x_1) \] with \(p3 = (x_3, y_3)\) being this instance.
If the result is 0, the points are collinear, i.e. lie on a single straight line L; if it is positive, this point lies to the left, otherwise to the right of the line formed by (p1, p2).
- Parameters:
p1
- first point of the linep2
- second point of the line- Returns:
- the cross-product
- See Also:
-
distance1
Compute the distance between two vectors according to the L1 norm.Calling this method is equivalent to calling:
p1.subtract(p2).getNorm1()
except that no intermediate vector is built- Parameters:
p1
- first vectorp2
- second vector- Returns:
- the distance between p1 and p2 according to the L1 norm
- Since:
- 1.6
-
distance
Compute the distance between two vectors according to the L2 norm.Calling this method is equivalent to calling:
p1.subtract(p2).getNorm()
except that no intermediate vector is built- Parameters:
p1
- first vectorp2
- second vector- Returns:
- the distance between p1 and p2 according to the L2 norm
-
distanceInf
Compute the distance between two vectors according to the L∞ norm.Calling this method is equivalent to calling:
p1.subtract(p2).getNormInf()
except that no intermediate vector is built- Parameters:
p1
- first vectorp2
- second vector- Returns:
- the distance between p1 and p2 according to the L∞ norm
-
distanceSq
Compute the square of the distance between two vectors.Calling this method is equivalent to calling:
p1.subtract(p2).getNormSq()
except that no intermediate vector is built- Parameters:
p1
- first vectorp2
- second vector- Returns:
- the square of the distance between p1 and p2
-
orientation
Compute the orientation of a triplet of points.- Parameters:
p
- first vector of the tripletq
- second vector of the tripletr
- third vector of the triplet- Returns:
- a positive value if (p, q, r) defines a counterclockwise oriented triangle, a negative value if (p, q, r) defines a clockwise oriented triangle, and 0 if (p, q, r) are collinear or some points are equal
- Since:
- 1.2
-
equals
Test for the equality of two 2D vectors.If all coordinates of two 2D vectors are exactly the same, and none are
Double.NaN
, the two 2D vectors are considered to be equal.NaN
coordinates are considered to affect globally the vector and be equals to each other - i.e, if either (or all) coordinates of the 2D vector are equal toDouble.NaN
, the 2D vector is equal toNaN
. -
equalsIeee754
Test for the equality of two 2D vectors.If all coordinates of two 2D vectors are exactly the same, and none are
NaN
, the two 2D vectors are considered to be equal.In compliance with IEEE754 handling, if any coordinates of any of the two vectors are
NaN
, then the vectors are considered different. This implies thatVector2D.NaN
.equals(Vector2D.NaN
) returnsfalse
despite the instance is checked against itself.- Parameters:
other
- Object to test for equality to this- Returns:
- true if two 2D vector objects are equal, false if object is null, not an instance of Vector2D, or not equal to this Vector2D instance
- Since:
- 2.1
-
hashCode
public int hashCode()Get a hashCode for the 2D vector.All NaN values have the same hash code.
-
toString
Get a string representation of this vector. -
toString
Get a string representation of this vector.- Specified by:
toString
in interfaceVector<Euclidean2D,
Vector2D> - Parameters:
format
- the custom format for components- Returns:
- a string representation of this vector
-