georegression.struct

Class GeoTuple3D_F64<T extends GeoTuple3D_F64>

java.lang.Object

georegression.struct.GeoTuple<T>

georegression.struct.GeoTuple_F64<T>

georegression.struct.GeoTuple3D_F64<T>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Point3D_F64, Vector3D_F64

public abstract class GeoTuple3D_F64<T extends GeoTuple3D_F64>
extends GeoTuple_F64<T>

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

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GeoTuple3D_F64()
GeoTuple3D_F64(double x, double y, double z)

Method Summary

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

Methods inherited from class georegression.struct.GeoTuple_F64

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 double x

y

public double y

z

public double z

Constructor Detail

GeoTuple3D_F64

public GeoTuple3D_F64(double x,
                      double y,
                      double z)

GeoTuple3D_F64

public GeoTuple3D_F64()

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_F64>

Returns:

Dimensionality of the object.

set

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

isIdentical

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

isIdentical

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

isIdentical

public boolean isIdentical(GeoTuple3D_F64 t,
                           double tol)

Description copied from class: GeoTuple_F64

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_F64<T extends GeoTuple3D_F64>

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 double getX()

getY

public double getY()

getZ

public double getZ()

getIndex

public double getIndex(int index)

Description copied from class: GeoTuple_F64

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

Specified by:

getIndex in class GeoTuple_F64<T extends GeoTuple3D_F64>

Parameters:

index - Which axis in the coordinate system.

Returns:

Its value.

setIndex

public void setIndex(int index,
                     double value)

Specified by:

setIndex in class GeoTuple_F64<T extends GeoTuple3D_F64>

plusIP

public void plusIP(GeoTuple3D_F64 a)

In-place addition

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

Parameters:

a - value which is to be added

plus

public T plus(GeoTuple3D_F64 a)

Addition

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

Parameters:

a - value which is to be added

timesIP

public void timesIP(double scalar)

In-place scalar multiplication

Parameters:

scalar - value that it is multiplied by

scale

public void scale(double scalar)

In-place scalar multiplication

Parameters:

scalar - value that it is multiplied by

times

public T times(double scalar)

Scalar multiplication

Parameters:

scalar - value which is it multiplied by

Returns:

new matrix which is the original scaled

norm

public double norm()

Description copied from class: GeoTuple_F64

Computes the Euclidean norm.

Overrides:

norm in class GeoTuple_F64<T extends GeoTuple3D_F64>

Returns:

norm.

normSq

public double normSq()

Description copied from class: GeoTuple_F64

Computes the square of the Euclidean norm.

Overrides:

normSq in class GeoTuple_F64<T extends GeoTuple3D_F64>

Returns:

norm squared.

distance

public double distance(GeoTuple3D_F64 t)

Overrides:

distance in class GeoTuple_F64<T extends GeoTuple3D_F64>

distance2

public double distance2(GeoTuple3D_F64 t)

Overrides:

distance2 in class GeoTuple_F64<T extends GeoTuple3D_F64>

print

public void print()

isNaN

public boolean isNaN()

setX

public void setX(double x)

setY

public void setY(double y)

setZ

public void setZ(double z)