Package 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:
Serializable
- Direct Known Subclasses:
Point3D_F32
,Vector3D_F32
@Generated("georegression.struct.GeoTuple3D_F64")
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:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
float
distance
(float x, float y, float z) float
float
distance2
(float x, float y, float z) float
void
divideIP
(float scalar) boolean
int
The dimensionality of space the tuple is contained in and the number of values it has.float
getIdx
(int index) Returns the value of the tuple along the specified coordinate system axis.int
hashCode()
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()
Returns true if at least one value is NaNfloat
norm()
Computes the Euclidean norm.float
normSq()
Computes the square of the Euclidean norm.plus
(float alpha, GeoTuple3D_F32 a) AdditionAdditionvoid
plusIP
(float alpha, GeoTuple3D_F32 a) In-place additionvoid
In-place additionvoid
print()
void
scale
(float scalar) In-place scalar multiplicationvoid
setIdx
(int index, float value) setTo
(float x, float y, float z) setTo
(GeoTuple2D_F32<?> p, float z) Sets this equal to 'src'times
(float scalar) Scalar multiplicationvoid
timesIP
(float scalar) In-place scalar multiplicationvoid
zero()
Sets all coefficients and parameters to zero, which is typically the initial state.Methods inherited from class georegression.struct.GeoTuple_F32
copy, isInfinite
Methods inherited from class georegression.struct.GeoTuple
createNewInstance
-
Field Details
-
x
public float x -
y
public float y -
z
public float z
-
-
Constructor Details
-
GeoTuple3D_F32
protected GeoTuple3D_F32(float x, float y, float z) -
GeoTuple3D_F32
protected GeoTuple3D_F32()
-
-
Method Details
-
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 classGeoTuple<T extends GeoTuple3D_F32>
- Returns:
- Dimensionality of the object.
-
_setTo
-
setTo
-
setTo
-
zero
public void zero()Description copied from class:GeoTuple
Sets all coefficients and parameters to zero, which is typically the initial state.- Specified by:
zero
in classGeoTuple<T extends GeoTuple3D_F32>
-
isIdentical
public boolean isIdentical(float x, float y, float z) -
isIdentical
public boolean isIdentical(float x, float y, float z, float tol) -
isIdentical
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 classGeoTuple_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.
-
getIdx
public float getIdx(int index) Description copied from class:GeoTuple_F32
Returns the value of the tuple along the specified coordinate system axis.- Specified by:
getIdx
in classGeoTuple_F32<T extends GeoTuple3D_F32>
- Parameters:
index
- Which axis in the coordinate system.- Returns:
- Its value.
-
setIdx
public void setIdx(int index, float value) - Specified by:
setIdx
in classGeoTuple_F32<T extends GeoTuple3D_F32>
-
plusIP
In-place addition
this.x = this.x + a.x;- Parameters:
a
- value which is to be added
-
plus
Addition
ret.x = this.x + a.x;- Parameters:
a
- value which is to be added
-
plusIP
In-place addition
this.x = this.x + alpha*a.x;- Parameters:
a
- value which is to be added
-
plus
Addition
ret.x = this.x + alpha*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
-
divideIP
public void divideIP(float scalar) -
times
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 classGeoTuple_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 classGeoTuple_F32<T extends GeoTuple3D_F32>
- Returns:
- norm squared.
-
distance
public float distance(float x, float y, float z) -
setTo
Description copied from class:GeoTuple
Sets this equal to 'src'- Specified by:
setTo
in classGeoTuple<T extends GeoTuple3D_F32>
- Parameters:
src
- The tuple being copied- Returns:
- Reference to 'this' class instance. Used to chain operations.
-
distance
- Overrides:
distance
in classGeoTuple_F32<T extends GeoTuple3D_F32>
-
distance2
- Overrides:
distance2
in classGeoTuple_F32<T extends GeoTuple3D_F32>
-
distance2
public float distance2(float x, float y, float z) -
print
public void print() -
isNaN
public boolean isNaN()Description copied from class:GeoTuple_F32
Returns true if at least one value is NaN- Overrides:
isNaN
in classGeoTuple_F32<T extends GeoTuple3D_F32>
-
equals
- Overrides:
equals
in classGeoTuple_F32<T extends GeoTuple3D_F32>
-
toString
-
hashCode
public int hashCode()- Overrides:
hashCode
in classGeoTuple_F32<T extends GeoTuple3D_F32>
-