georegression.struct

Class GeoTuple3D_F32<T extends GeoTuple3D_F32>

java.lang.Object

georegression.struct.GeoTuple<T>

georegression.struct.GeoTuple_F32<T>

georegression.struct.GeoTuple3D_F32<T>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Point3D_F32, Vector3D_F32

public abstract class GeoTuple3D_F32<T extends GeoTuple3D_F32>
extends GeoTuple_F32<T>

Generic Tuple for geometric objects that store (x,y,z)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
float	x
float	y
float	z

Constructor Summary

Constructors

Constructor and Description
GeoTuple3D_F32()
GeoTuple3D_F32(float x, float y, float z)

Method Summary

Modifier and Type	Method and Description
float	distance(GeoTuple3D_F32 t)
float	distance2(GeoTuple3D_F32 t)
int	getDimension() The dimensionality of space the tuple is contained in and the number of values it has.
float	getIndex(int index) Returns the value of the tuple along the specified coordinate system axis.
float	getX()
float	getY()
float	getZ()
boolean	isIdentical(float x, float y, float z)
boolean	isIdentical(float x, float y, float z, float tol)
boolean	isIdentical(GeoTuple3D_F32 t, float tol) Checks to see if the two GeoTuple have values which are nearly the same.
boolean	isNaN()
float	norm() Computes the Euclidean norm.
float	normSq() Computes the square of the Euclidean norm.
T	plus(GeoTuple3D_F32 a) Addition
void	plusIP(GeoTuple3D_F32 a) In-place addition
void	print()
void	scale(float scalar) In-place scalar multiplication
void	set(float x, float y, float z)
void	setIndex(int index, float value)
void	setX(float x)
void	setY(float y)
void	setZ(float z)
T	times(float scalar) Scalar multiplication
void	timesIP(float scalar) In-place scalar multiplication

Methods inherited from class georegression.struct.GeoTuple_F32

copy

Methods inherited from class georegression.struct.GeoTuple

createNewInstance

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

x

public float x

y

public float y

z

public float z

Constructor Detail

GeoTuple3D_F32

public GeoTuple3D_F32(float x,
                      float y,
                      float z)

GeoTuple3D_F32

public GeoTuple3D_F32()

Method Detail

getDimension

public int getDimension()

Description copied from class: GeoTuple

The dimensionality of space the tuple is contained in and the number of values it has.

Specified by:

getDimension in class GeoTuple<T extends GeoTuple3D_F32>

Returns:

Dimensionality of the object.

set

public void set(float x,
                float y,
                float z)

isIdentical

public boolean isIdentical(float x,
                           float y,
                           float z)

isIdentical

public boolean isIdentical(float x,
                           float y,
                           float z,
                           float tol)

isIdentical

public boolean isIdentical(GeoTuple3D_F32 t,
                           float tol)

Description copied from class: GeoTuple_F32

Checks to see if the two GeoTuple have values which are nearly the same. False is always returned if the dimension is different.

Overrides:

isIdentical in class GeoTuple_F32<T extends GeoTuple3D_F32>

Parameters:

t - The GeoTuple it is being compared against.

tol - How similar each element must be for them to be considered identical.

Returns:

if they are identical or not.

getX

public float getX()

getY

public float getY()

getZ

public float getZ()

getIndex

public float getIndex(int index)

Description copied from class: GeoTuple_F32

Returns the value of the tuple along the specified coordinate system axis.

Specified by:

getIndex in class GeoTuple_F32<T extends GeoTuple3D_F32>

Parameters:

index - Which axis in the coordinate system.

Returns:

Its value.

setIndex

public void setIndex(int index,
                     float value)

Specified by:

setIndex in class GeoTuple_F32<T extends GeoTuple3D_F32>

plusIP

public void plusIP(GeoTuple3D_F32 a)

In-place addition

this.x = this.x + a.x;

Parameters:

a - value which is to be added

plus

public T plus(GeoTuple3D_F32 a)

Addition

ret.x = this.x + a.x;

Parameters:

a - value which is to be added

timesIP

public void timesIP(float scalar)

In-place scalar multiplication

Parameters:

scalar - value that it is multiplied by

scale

public void scale(float scalar)

In-place scalar multiplication

Parameters:

scalar - value that it is multiplied by

times

public T times(float scalar)

Scalar multiplication

Parameters:

scalar - value which is it multiplied by

Returns:

new matrix which is the original scaled

norm

public float norm()

Description copied from class: GeoTuple_F32

Computes the Euclidean norm.

Overrides:

norm in class GeoTuple_F32<T extends GeoTuple3D_F32>

Returns:

norm.

normSq

public float normSq()

Description copied from class: GeoTuple_F32

Computes the square of the Euclidean norm.

Overrides:

normSq in class GeoTuple_F32<T extends GeoTuple3D_F32>

Returns:

norm squared.

distance

public float distance(GeoTuple3D_F32 t)

Overrides:

distance in class GeoTuple_F32<T extends GeoTuple3D_F32>

distance2

public float distance2(GeoTuple3D_F32 t)

Overrides:

distance2 in class GeoTuple_F32<T extends GeoTuple3D_F32>

print

public void print()

isNaN

public boolean isNaN()

setX

public void setX(float x)

setY

public void setY(float y)

setZ

public void setZ(float z)