Apache Commons Math 3.6.1 · org.apache.commons.math3.geometry.spherical.oned.Arc

Field Summary

Modifier and Type	Field and Description
private final double	lower The lower angular bound of the arc.
private final double	middle Middle point of the arc.
private final double	tolerance Tolerance below which angles are considered identical.
private final double	upper The upper angular bound of the arc.

Constructor Summary

Access	Constructor and Description
public	Arc(final double lower angular bound of the arc lower, final double upper angular bound of the arc upper, final double tolerance below which angles are considered identical tolerance) Simple constructor.

Method Summary

Modifier and Type	Method and Description
public Region.Location	Returns: a code representing the point status: either `Location#INSIDE`, `Location#OUTSIDE` or `Location#BOUNDARY` checkPoint(final double point to check point) Check a point with respect to the arc.
public double	Returns: barycenter of the arc getBarycenter() Get the barycenter of the arc.
public double	Returns: lower angular bound of the arc, always between 0 and \( 2 \pi \) getInf() Get the lower angular bound of the arc.
public double	Returns: angular size of the arc getSize() Get the angular size of the arc.
public double	Returns: upper angular bound of the arc, always between `getInf()` and `getInf()` \( + 2 \pi \) getSup() Get the upper angular bound of the arc.
public double	Returns: tolerance below which angles are considered identical getTolerance() Get the tolerance below which angles are considered identical.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

lower	back to summary
private final double lower The lower angular bound of the arc.

middle	back to summary
private final double middle Middle point of the arc.

tolerance	back to summary
private final double tolerance Tolerance below which angles are considered identical.

upper	back to summary
private final double upper The upper angular bound of the arc.

Constructor Detail

Arc back to summary

Arc	back to summary
public Arc(final double lower, final double upper, final double tolerance) throws NumberIsTooLargeException 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:double lower angular bound of the arc upper:double upper angular bound of the arc tolerance:double tolerance below which angles are considered identical Exceptions NumberIsTooLargeException: if lower is greater than upper

public Arc(final double lower, final double upper, final double tolerance) throws NumberIsTooLargeException

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:double: lower angular bound of the arc
upper:double: upper angular bound of the arc
tolerance:double: tolerance below which angles are considered identical

Exceptions

NumberIsTooLargeException:: if lower is greater than upper

Method Detail

checkPoint back to summary

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

public Region.Location checkPoint(final double point)

Check a point with respect to the arc.

Parameters

point:double: point to check

Returns:Region.Location

a code representing the point status: either Location#INSIDE, Location#OUTSIDE or Location#BOUNDARY

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

getBarycenter

back to summary

public double getBarycenter()

Get the barycenter of the arc.

Returns:double: barycenter of the arc

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

getInf

back to summary

public double getInf()

Get the lower angular bound of the arc.

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

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

getSize

back to summary

public double getSize()

Get the angular size of the arc.

Returns:double: angular size of the arc

getSup back to summary

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

public double getSup()

Get the upper angular bound of the arc.

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

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

getTolerance

back to summary

public double getTolerance()

Get the tolerance below which angles are considered identical.

Returns:double: tolerance below which angles are considered identical

public Class Arc

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail