us.ihmc.euclid.tuple2D.interfaces

Interface Tuple2DReadOnly

All Known Subinterfaces:

Point2DBasics, Point2DReadOnly, Tuple2DBasics, Vector2DBasics, Vector2DReadOnly

All Known Implementing Classes:

Point2D, Point2D32, Vector2D, Vector2D32

public interface Tuple2DReadOnly

Read-only interface for a 2 dimensional tuple.

A tuple is an abstract geometry object holding onto the common math between a 2D point and vector.

Although a point and vector hold onto the same type of information, the distinction is made between them as they represent different geometry objects and are typically not handled the same way:

• a point represents the coordinate of a location in space. A notable difference with a vector is that the distance between two points has a physical meaning. When a point is transformed with a homogeneous transformation matrix, a point's coordinates are susceptible to be scaled, rotated, and translated.
• a vector is not constrained to a location in space. Instead, a vector represents some physical quantity that has a direction and a magnitude such as: a velocity, a force, the translation from one point to another, etc. When a vector is transformed with a homogeneous transformation matrix, its components are susceptible to be scaled and rotated, but never to be translated.

Method Summary

Modifier and Type	Method and Description
default boolean	containsNaN() Tests if this tuple contains a Double.NaN.
default boolean	epsilonEquals(Tuple2DReadOnly other, double epsilon) Tests on a per component basis if this tuple is equal to the given other to an epsilon.
default boolean	equals(Tuple2DReadOnly other) Tests on a per component basis, if this tuple is exactly equal to other.
default void	get(org.ejml.data.DenseMatrix64F tupleMatrixToPack) Packs the components x, y in order in a column vector starting from its first row index.
default void	get(double[] tupleArrayToPack) Packs the components x, y in order in an array starting from its first index.
default void	get(float[] tupleArrayToPack) Packs the components x, y in order in an array starting from its first index.
default void	get(int startRow, org.ejml.data.DenseMatrix64F tupleMatrixToPack) Packs the components x, y in order in a column vector starting from startRow.
default void	get(int startIndex, double[] tupleArrayToPack) Packs the components x, y in order in an array starting from startIndex.
default void	get(int startIndex, float[] tupleArrayToPack) Packs the components x, y in order in an array starting from startIndex.
default void	get(int startRow, int column, org.ejml.data.DenseMatrix64F tupleMatrixToPack) Packs the components x, y in order in a column vector starting from startRow at the column index column.
default double	getElement(int index) Selects a component of this tuple based on index and returns its value.
default float	getElement32(int index) Selects a component of this tuple based on index and returns its value.
double	getX() Returns the x-component of this tuple.
default float	getX32() Returns the x-component of this tuple.
double	getY() Returns the y-component of this tuple.
default float	getY32() Returns the y-component of this tuple.

Method Detail

getX

double getX()

Returns the x-component of this tuple.

Returns:

the x-component.

getY

double getY()

Returns the y-component of this tuple.

Returns:

the y-component.

getX32

default float getX32()

Returns the x-component of this tuple.

Returns:

the x-component.

getY32

default float getY32()

Returns the y-component of this tuple.

Returns:

the y-component.

containsNaN

default boolean containsNaN()

Tests if this tuple contains a Double.NaN.

Returns:

true if this tuple contains a Double.NaN, false otherwise.

getElement

default double getElement(int index)

Selects a component of this tuple based on index and returns its value.

For an index of 0, the corresponding component is x, while for 1 it is y.

Parameters:

index - the index of the component to get.

Returns:

the value of the component.

Throws:

java.lang.IndexOutOfBoundsException - if index ∉ [0, 1].

getElement32

default float getElement32(int index)

Selects a component of this tuple based on index and returns its value. For an index of 0, the corresponding component is x, while for 1 it is y.

Parameters:

index - the index of the component to get.

Returns:

the value of the component.

Throws:

java.lang.IndexOutOfBoundsException - if index ∉ [0, 1].

get

default void get(double[] tupleArrayToPack)

Packs the components x, y in order in an array starting from its first index.

Parameters:

tupleArrayToPack - the array in which this tuple is stored. Modified.

get

default void get(int startIndex,
                 double[] tupleArrayToPack)

Packs the components x, y in order in an array starting from startIndex.

Parameters:

startIndex - the index in the array where the first component is stored.

tupleArrayToPack - the array in which this tuple is stored. Modified.

get

default void get(float[] tupleArrayToPack)

Packs the components x, y in order in an array starting from its first index.

Parameters:

tupleArrayToPack - the array in which this tuple is stored. Modified.

get

default void get(int startIndex,
                 float[] tupleArrayToPack)

Packs the components x, y in order in an array starting from startIndex.

Parameters:

startIndex - the index in the array where the first component is stored.

tupleArrayToPack - the array in which this tuple is stored. Modified.

get

default void get(org.ejml.data.DenseMatrix64F tupleMatrixToPack)

Packs the components x, y in order in a column vector starting from its first row index.

Parameters:

tupleMatrixToPack - the array in which this tuple is stored. Modified.

get

default void get(int startRow,
                 org.ejml.data.DenseMatrix64F tupleMatrixToPack)

Packs the components x, y in order in a column vector starting from startRow.

Parameters:

startRow - the first row index to start writing in the dense-matrix.

tupleMatrixToPack - the column vector in which this tuple is stored. Modified.

get

default void get(int startRow,
                 int column,
                 org.ejml.data.DenseMatrix64F tupleMatrixToPack)

Packs the components x, y in order in a column vector starting from startRow at the column index column.

Parameters:

startRow - the first row index to start writing in the dense-matrix.

column - the column index to write in the dense-matrix.

tupleMatrixToPack - the matrix in which this tuple is stored. Modified.

epsilonEquals

default boolean epsilonEquals(Tuple2DReadOnly other,
                              double epsilon)

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

Parameters:

other - the other tuple 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.

equals

default boolean equals(Tuple2DReadOnly other)

Tests on a per component basis, if this tuple is exactly equal to other.

Parameters:

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

Returns:

true if the two tuples are exactly equal component-wise, false otherwise.