Package georegression.struct

Class GeoTuple2D_F32<T extends GeoTuple2D_F32>

java.lang.Object
georegression.struct.GeoTuple<T>
georegression.struct.GeoTuple_F32<T>
georegression.struct.GeoTuple2D_F32<T>
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
Point2D_F32, Vector2D_F32
@Generated("georegression.struct.GeoTuple2D_F64") public abstract class GeoTuple2D_F32<T extends GeoTuple2D_F32> extends GeoTuple_F32<T>
Generic Tuple for geometric objects that store (x,y)
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    float
    x
     
    float
    y
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    GeoTuple2D_F32()
     
    protected
    GeoTuple2D_F32(float x, float y)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    _setTo(GeoTuple2D_F32 a)
     
    float
    distance(float x, float y)
    Euclidean distance from the point
    float
    distance(T t)
     
    float
    distance2(float x, float y)
    Euclidean squared distance from the point
    float
    distance2(T t)
     
    boolean
    equals(Object obj)
     
    int
    getDimension()
    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)
     
    boolean
    isIdentical(float x, float y, float tol)
     
    boolean
    isIdentical(T 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 NaN
    float
    norm()
    Computes the Euclidean norm.
    float
    normSq()
    Computes the square of the Euclidean norm.
    T
    plus(GeoTuple2D_F32 a)
    Addition
    void
    plusIP(GeoTuple2D_F32 a)
    In-place addition
    void
    print()
     
    void
    scale(float scalar)
    In-place scalar multiplication
    void
    setIdx(int index, float value)
     
    T
    setTo(float x, float y)
     
    T
    setTo(T src)
    Sets this equal to 'src'
    T
    times(float scalar)
    Scalar multiplication
    void
    timesIP(float scalar)
    In-place scalar multiplication
    protected String
    toString(String name)
     
    void
    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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • x

      public float x

    • y

      public float y

  • Constructor Details

    • GeoTuple2D_F32

      protected GeoTuple2D_F32(float x, float y)

    • GeoTuple2D_F32

      protected GeoTuple2D_F32()

  • Method Details

    • _setTo

      protected void _setTo(GeoTuple2D_F32 a)

    • setTo

      public T setTo(float x, float y)

    • 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 class GeoTuple<T extends GeoTuple2D_F32>

    • isIdentical

      public boolean isIdentical(float x, float y)

    • isIdentical

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

    • isIdentical

      public boolean isIdentical(T 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 GeoTuple2D_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.

    • plusIP

      public void plusIP(GeoTuple2D_F32 a)

      In-place addition

      this.x = this.x + a.x;
      Parameters:
      a - value which is to be added

    • plus

      public T plus(GeoTuple2D_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

    • distance

      public float distance(float x, float y)
      Euclidean distance from the point
      Parameters:
      x - x-coordinate
      y - y-coordinate
      Returns:
      distance

    • distance2

      public float distance2(float x, float y)
      Euclidean squared distance from the point
      Parameters:
      x - x-coordinate
      y - y-coordinate
      Returns:
      distance squared

    • setTo

      public T setTo(T src)
      Description copied from class: GeoTuple
      Sets this equal to 'src'
      Specified by:
      setTo in class GeoTuple<T extends GeoTuple2D_F32>
      Parameters:
      src - The tuple being copied
      Returns:
      Reference to 'this' class instance. Used to chain operations.

    • distance

      public float distance(T t)
      Overrides:
      distance in class GeoTuple_F32<T extends GeoTuple2D_F32>

    • distance2

      public float distance2(T t)
      Overrides:
      distance2 in class GeoTuple_F32<T extends GeoTuple2D_F32>

    • 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 class GeoTuple_F32<T extends GeoTuple2D_F32>
      Parameters:
      index - Which axis in the coordinate system.
      Returns:
      Its value.

    • setIdx

      public void setIdx(int index, float value)
      Specified by:
      setIdx in class GeoTuple_F32<T extends GeoTuple2D_F32>

    • norm

      public float norm()
      Description copied from class: GeoTuple_F32
      Computes the Euclidean norm.
      Overrides:
      norm in class GeoTuple_F32<T extends GeoTuple2D_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 GeoTuple2D_F32>
      Returns:
      norm squared.

    • 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 GeoTuple2D_F32>
      Returns:
      Dimensionality of the object.

    • print

      public void print()

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class GeoTuple_F32<T extends GeoTuple2D_F32>

    • isNaN

      public boolean isNaN()
      Description copied from class: GeoTuple_F32
      Returns true if at least one value is NaN
      Overrides:
      isNaN in class GeoTuple_F32<T extends GeoTuple2D_F32>

    • toString

      protected String toString(String name)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class GeoTuple_F32<T extends GeoTuple2D_F32>