AngularInterval (Apache Commons Geometry Spherical 1.0 API)

java.lang.Object
- org.apache.commons.geometry.spherical.oned.AngularInterval

All Implemented Interfaces:

HyperplaneBoundedRegion<Point1S>, Splittable<Point1S,HyperplaneBoundedRegion<Point1S>>, Region<Point1S>, Sized

Direct Known Subclasses:

AngularInterval.Convex
```
public class AngularInterval
extends Object
implements HyperplaneBoundedRegion<Point1S>
```
Class representing an angular interval of size greater than zero to 2pi. The interval is defined by two azimuth angles: a min and a max. The interval starts at the min azimuth angle and contains all points in the direction of increasing azimuth angles up to max.
Instances of this class are guaranteed to be immutable.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AngularInterval.Convex
Class representing an angular interval with the additional property that the region is convex.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AngularInterval.Convex` Class representing an angular interval with the additional property that the region is convex.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RegionLocation`	`classify(Point1S pt)`
`static AngularInterval.Convex`	`full()` Return an instance representing the full space.
`double`	`getBoundarySize()`
`Point1S`	`getCentroid()`
`double`	`getMax()` Get the maximum azimuth angle for the interval, or `2pi` if the interval represents the full space.
`CutAngle`	`getMaxBoundary()` Get the maximum point for the interval.
`Point1S`	`getMidPoint()` Get the midpoint of the interval or null if the interval represents the full space.
`double`	`getMin()` Get the minimum azimuth angle for the interval, or `0` if the interval is full.
`CutAngle`	`getMinBoundary()` Get the minimum boundary for the interval, or null if the interval represents the full space.
`double`	`getSize()`
`boolean`	`isEmpty()`
`boolean`	`isFull()`
`static AngularInterval`	`of(CutAngle a, CutAngle b)` Return an instance representing the angular interval between the given oriented points.
`static AngularInterval`	`of(double min, double max, Precision.DoubleEquivalence precision)` Return an instance representing the angular interval between the given min and max azimuth values.
`static AngularInterval`	`of(Point1S min, Point1S max, Precision.DoubleEquivalence precision)` Return an instance representing the angular interval between the given min and max azimuth points.
`Point1S`	`project(Point1S pt)`
`Split<RegionBSPTree1S>`	`split(Hyperplane<Point1S> splitter)`
`List<AngularInterval.Convex>`	`toConvex()` Return a list of convex intervals comprising this region.
`String`	`toString()`
`RegionBSPTree1S`	`toTree()` Return a `RegionBSPTree1S` instance representing the same region as this instance.
`AngularInterval`	`transform(Transform<Point1S> transform)` Return a new instance transformed by the argument.
`boolean`	`wrapsZero()` Return true if the interval wraps around the zero/`2pi` point.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.geometry.core.Region
contains

Methods inherited from interface org.apache.commons.geometry.core.Sized
isFinite, isInfinite

- Method Detail
  - getMin
```
public double getMin()
```
    Get the minimum azimuth angle for the interval, or 0 if the interval is full.
    
    Returns:
    
    the minimum azimuth angle for the interval or 0 if the interval represents the full space.
  - getMinBoundary
```
public CutAngle getMinBoundary()
```
    Get the minimum boundary for the interval, or null if the interval represents the full space.
    
    Returns:
    
    the minimum point for the interval or null if the interval represents the full space
  - getMax
```
public double getMax()
```
    Get the maximum azimuth angle for the interval, or 2pi if the interval represents the full space.
    
    Returns:
    
    the maximum azimuth angle for the interval or 2pi if the interval represents the full space.
  - getMaxBoundary
```
public CutAngle getMaxBoundary()
```
    Get the maximum point for the interval. This will be null if the interval represents the full space.
    
    Returns:
    
    the maximum point for the interval or null if the interval represents the full space
  - getMidPoint
```
public Point1S getMidPoint()
```
    Get the midpoint of the interval or null if the interval represents the full space.
    
    Returns:
    
    the midpoint of the interval or null if the interval represents the full space
    
    See Also:
    
    getCentroid()
  - isFull
```
public boolean isFull()
```
    Specified by:
    
    isFull in interface Region<Point1S>
  - isEmpty
```
public boolean isEmpty()
```
    This method always returns false.
    
    Specified by:
    
    isEmpty in interface Region<Point1S>
  - getSize
```
public double getSize()
```
    Specified by:
    
    getSize in interface Sized
  - getBoundarySize
```
public double getBoundarySize()
```
    This method simply returns 0 because boundaries in one dimension do not have any size.
    
    Specified by:
    
    getBoundarySize in interface Region<Point1S>
  - getCentroid
```
public Point1S getCentroid()
```
    This method is an alias for getMidPoint().
    
    Specified by:
    
    getCentroid in interface Region<Point1S>
    
    See Also:
    
    getMidPoint()
  - classify
```
public RegionLocation classify(Point1S pt)
```
    Specified by:
    
    classify in interface Region<Point1S>
  - project
```
public Point1S project(Point1S pt)
```
    Specified by:
    
    project in interface Region<Point1S>
  - wrapsZero
```
public boolean wrapsZero()
```
    Return true if the interval wraps around the zero/2pi point. In this case, the max boundary azimuth is less than that of the min boundary when both values are normalized to the range [0, 2pi).
    
    Returns:
    
    true if the interval wraps around the zero/2pi point
  - transform
```
public AngularInterval transform(Transform<Point1S> transform)
```
    Return a new instance transformed by the argument. If the transformed size of the interval is greater than or equal to 2pi, then an interval representing the full space is returned.
    
    Parameters:
    
    transform - transform to apply
    
    Returns:
    
    a new instance transformed by the argument
  - split
```
public Split<RegionBSPTree1S> split(Hyperplane<Point1S> splitter)
```
    This method returns instances of RegionBSPTree1S instead of AngularInterval since it is possible for a convex angular interval to be split into disjoint regions by a single hyperplane. These disjoint regions cannot be represented by this class and require the use of a BSP tree.
    
    Specified by:
    
    split in interface Splittable<Point1S,HyperplaneBoundedRegion<Point1S>>
    
    See Also:
    
    RegionBSPTree1S.split(Hyperplane)
  - toTree
```
public RegionBSPTree1S toTree()
```
    Return a RegionBSPTree1S instance representing the same region as this instance.
    
    Returns:
    
    a BSP tree representing the same region as this instance
  - toConvex
```
public List<AngularInterval.Convex> toConvex()
```
    Return a list of convex intervals comprising this region.
    
    Returns:
    
    a list of convex intervals comprising this region
    
    See Also:
    
    AngularInterval.Convex
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - full
```
public static AngularInterval.Convex full()
```
    Return an instance representing the full space. The returned instance contains all possible azimuth angles.
    
    Returns:
    
    an interval representing the full space
  - of
```
public static AngularInterval of(double min,
                                 double max,
                                 Precision.DoubleEquivalence precision)
```
    Return an instance representing the angular interval between the given min and max azimuth values. The max value is adjusted to be numerically above the min value, even if the resulting azimuth value is greater than or equal to 2pi. An instance representing the full space is returned if either point is infinite or min and max are equivalent as evaluated by the given precision context.
    
    Parameters:
    
    min - min azimuth value
    
    max - max azimuth value
    
    precision - precision precision context used to compare floating point values
    
    Returns:
    
    a new instance resulting the angular region between the given min and max azimuths
    
    Throws:
    
    IllegalArgumentException - if either azimuth is infinite or NaN
  - of
```
public static AngularInterval of(Point1S min,
                                 Point1S max,
                                 Precision.DoubleEquivalence precision)
```
    Return an instance representing the angular interval between the given min and max azimuth points. The max point is adjusted to be numerically above the min point, even if the resulting azimuth value is greater than or equal to 2pi. An instance representing the full space is returned if either point is infinite or min and max are equivalent as evaluated by the given precision context.
    
    Parameters:
    
    min - min azimuth value
    
    max - max azimuth value
    
    precision - precision precision context used to compare floating point values
    
    Returns:
    
    a new instance resulting the angular region between the given min and max points
    
    Throws:
    
    IllegalArgumentException - if either azimuth is infinite or NaN
  - of
```
public static AngularInterval of(CutAngle a,
                                 CutAngle b)
```
    Return an instance representing the angular interval between the given oriented points. The negative-facing point is used as the minimum boundary and the positive-facing point is adjusted to be above the minimum. The arguments can be given in any order. The full space is returned if the points are equivalent or are oriented in the same direction.
    
    Parameters:
    
    a - first oriented point
    
    b - second oriented point
    
    Returns:
    
    an instance representing the angular interval between the given oriented points
    
    Throws:
    
    IllegalArgumentException - if either argument is infinite or NaN

Class AngularInterval

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.commons.geometry.core.Region

Methods inherited from interface org.apache.commons.geometry.core.Sized

Method Detail

getMin

getMinBoundary

getMax

getMaxBoundary

getMidPoint

isFull

isEmpty

getSize

getBoundarySize

getCentroid

classify

project

wrapsZero

transform

split

toTree

toConvex

toString

full

of

of

of