Package org.hipparchus.geometry.spherical.oned

Class Arc

java.lang.Object
org.hipparchus.geometry.spherical.oned.Arc
public class Arc extends Object
This class represents an arc on a circle.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Arc(double lower, double upper, double tolerance)
    Simple constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Region.Location
    checkPoint(double point)
    Check a point with respect to the arc.
    double
    getBarycenter()
    Get the barycenter of the arc.
    double
    getInf()
    Get the lower angular bound of the arc.
    double
    getOffset(double point)
    Get the distance (arc length) from a point to the edge of the arc.
    double
    getOffset(S1Point point)
    Get the distance (arc length) from a point to the edge of the arc.
    double
    getSize()
    Get the angular size of the arc.
    double
    getSup()
    Get the upper angular bound of the arc.
    double
    getTolerance()
    Get the tolerance below which angles are considered identical.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Arc

      public Arc(double lower, double upper, double tolerance) throws MathIllegalArgumentException
      Simple constructor.

      If either lower is equals to upper or the interval exceeds \( 2 \pi \), the arc is considered to be the full circle and its initial defining boundaries will be forgotten. lower is not allowed to be greater than upper (an exception is thrown in this case). lower will be canonicalized between 0 and \( 2 \pi \), and upper shifted accordingly, so the getInf() and getSup() may not return the value used at instance construction.

      Parameters:
      lower - lower angular bound of the arc
      upper - upper angular bound of the arc
      tolerance - tolerance below which angles are considered identical
      Throws:
      MathIllegalArgumentException - if lower is greater than upper or tolerance is smaller than Sphere1D.SMALLEST_TOLERANCE

  • Method Details

    • getInf

      public double getInf()
      Get the lower angular bound of the arc.
      Returns:
      lower angular bound of the arc, always between 0 and \( 2 \pi \)

    • getSup

      public double getSup()
      Get the upper angular bound of the arc.
      Returns:
      upper angular bound of the arc, always between getInf() and getInf() \( + 2 \pi \)

    • getSize

      public double getSize()
      Get the angular size of the arc.
      Returns:
      angular size of the arc

    • getBarycenter

      public double getBarycenter()
      Get the barycenter of the arc.
      Returns:
      barycenter of the arc

    • getTolerance

      public double getTolerance()
      Get the tolerance below which angles are considered identical.
      Returns:
      tolerance below which angles are considered identical

    • checkPoint

      public Region.Location checkPoint(double point)
      Check a point with respect to the arc.
      Parameters:
      point - point to check
      Returns:
      a code representing the point status: either Region.Location.INSIDE, Region.Location.OUTSIDE or Region.Location.BOUNDARY

    • getOffset

      public double getOffset(double point)
      Get the distance (arc length) from a point to the edge of the arc.

      This method does not use getTolerance().

      Parameters:
      point - to test.
      Returns:
      offset, negative if the point is inside the arc, positive if it is outside the arc, or zero if point is getInf() or getSup().

    • getOffset

      public double getOffset(S1Point point)
      Get the distance (arc length) from a point to the edge of the arc.

      This method does not use getTolerance().

      Parameters:
      point - to test.
      Returns:
      offset, negative if the point is inside the arc, positive if it is outside the arc, or zero if point is getInf() or getSup().