Package us.ihmc.euclid.tuple2D

Class Vector2D

java.lang.Object

us.ihmc.euclid.tuple2D.Vector2D

All Implemented Interfaces:

Clearable, EpsilonComparable<Vector2D>, GeometricallyComparable<Vector2D>, GeometryObject<Vector2D>, Settable<Vector2D>, Transformable, Tuple2DBasics, Tuple2DReadOnly, Vector2DBasics, Vector2DReadOnly

public class Vector2D
extends java.lang.Object
implements Vector2DBasics, GeometryObject<Vector2D>

A 2D vector represents a physical quantity with a magnitude and a direction in the XY-plane. For instance, it can be used to represent a 2D velocity, force, or translation from one 2D point to another.

This version of 2D vector uses double precision fields to save the value of each component. It is meant for garbage free usage.

Author:

Sylvain Bertrand

Constructor Summary

Constructors

Constructor	Description
Vector2D()	Creates a new vector and initializes it components to zero.
Vector2D(double[] vectorArray)	Creates a new vector and initializes its component x, y in order from the given array.
Vector2D(double x, double y)	Creates a new vector and initializes it with the given components.
Vector2D(Tuple2DReadOnly other)	Creates a new vector and initializes it to other.
Vector2D(Tuple3DReadOnly tuple3DReadOnly)	Creates a new vector and initializes it to tuple3DReadOnly x and y components.

Method Summary

Modifier and Type	Method	Description
boolean	epsilonEquals(Vector2D other, double epsilon)	Tests on a per component basis if this vector is equal to the given other to an epsilon.
boolean	equals(java.lang.Object object)	Tests if the given object's class is the same as this, in which case the method returns Tuple2DReadOnly.equals(Tuple2DReadOnly), it returns false otherwise.
boolean	geometricallyEquals(Vector2D other, double epsilon)	Tests if this and other represent the same vector 2D to an epsilon.
double	getX()	Returns the value of the x-component of this vector.
double	getY()	Returns the value of the y-component of this vector.
int	hashCode()	Calculates and returns a hash code value from the value of each component of this vector 2D.
void	set(Vector2D other)	Sets this vector to other.
void	setX(double x)	Sets the x-component of this vector.
void	setY(double y)	Sets the y-component of this vector.
java.lang.String	toString()	Provides a String representation of this vector 2D as follows: (x, y).

Methods inherited from class java.lang.Object

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

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Tuple2DBasics

absolute, add, add, add, addX, addY, clipToMax, clipToMin, clipToMinMax, containsNaN, interpolate, interpolate, negate, scale, scale, scaleAdd, scaleAdd, scaleSub, scaleSub, set, set, set, set, set, set, set, set, set, set, setAndAbsolute, setAndClipToMax, setAndClipToMin, setAndClipToMinMax, setAndNegate, setAndScale, setElement, setToNaN, setToZero, sub, sub, sub, subX, subY

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Tuple2DReadOnly

epsilonEquals, equals, get, get, get, get, get, get, get, getElement, getElement32, getX32, getY32

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Vector2DBasics

applyInverseTransform, applyInverseTransform, applyTransform, applyTransform, clipToMaxLength, normalize, setAndNormalize

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Vector2DReadOnly

angle, cross, dot, geometricallyEquals, length, lengthSquared

Constructor Detail

Vector2D

public Vector2D()

Creates a new vector and initializes it components to zero.

Vector2D

public Vector2D(double x,
                double y)

Creates a new vector and initializes it with the given components.

Parameters:

x - the x-component.

y - the y-component.

Vector2D

public Vector2D(double[] vectorArray)

Creates a new vector and initializes its component x, y in order from the given array.

Parameters:

vectorArray - the array containing this vector's components. Not modified.

Vector2D

public Vector2D(Tuple2DReadOnly other)

Creates a new vector and initializes it to other.

Parameters:

other - the tuple to copy the components from. Not modified.

Vector2D

public Vector2D(Tuple3DReadOnly tuple3DReadOnly)

Creates a new vector and initializes it to tuple3DReadOnly x and y components.

Parameters:

tuple3DReadOnly - the tuple to copy the coordinates from. Not modified.

Method Detail

set

public void set(Vector2D other)

Sets this vector to other.

Specified by:

set in interface Settable<Vector2D>

Parameters:

other - the other vector to copy the values from. Not modified.

setX

public void setX(double x)

Sets the x-component of this vector.

Specified by:

setX in interface Tuple2DBasics

Parameters:

x - the x-component.

setY

public void setY(double y)

Sets the y-component of this vector.

Specified by:

setY in interface Tuple2DBasics

Parameters:

y - the y-component.

getX

public double getX()

Returns the value of the x-component of this vector.

Specified by:

getX in interface Tuple2DReadOnly

Returns:

the x-component's value.

getY

public double getY()

Returns the value of the y-component of this vector.

Specified by:

getY in interface Tuple2DReadOnly

Returns:

the y-component's value.

equals

public boolean equals(java.lang.Object object)

Tests if the given object's class is the same as this, in which case the method returns Tuple2DReadOnly.equals(Tuple2DReadOnly), it returns false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

object - the object to compare against this. Not modified.

Returns:

true if object and this are exactly equal, false otherwise.

epsilonEquals

public boolean epsilonEquals(Vector2D other,
                             double epsilon)

Tests on a per component basis if this vector is equal to the given other to an epsilon.

Specified by:

epsilonEquals in interface EpsilonComparable<Vector2D>

Parameters:

other - the other vector to compare against this. Not modified.

epsilon - the tolerance to use when comparing each component.

Returns:

true if the two tuples are equal, false otherwise.

geometricallyEquals

public boolean geometricallyEquals(Vector2D other,
                                   double epsilon)

Tests if this and other represent the same vector 2D to an epsilon.

Two vectors are considered geometrically equal if the length of their difference is less than or equal to epsilon.

Note that this.geometricallyEquals(other, epsilon) == true does not necessarily imply this.epsilonEquals(other, epsilon) and vice versa.

Specified by:

geometricallyEquals in interface GeometricallyComparable<Vector2D>

Parameters:

other - the other vector 2D to compare against this. Not modified.

epsilon - the maximum length of the difference vector can be for the two vectors to be considered equal.

Returns:

true if the two vectors represent the same geometry, false otherwise.

toString

public java.lang.String toString()

Provides a String representation of this vector 2D as follows: (x, y).

Overrides:

toString in class java.lang.Object

Returns:

the String representing this vector 2D.

hashCode

public int hashCode()

Calculates and returns a hash code value from the value of each component of this vector 2D.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this vector 2D.