Interval (Apache Commons Geometry Euclidean 1.0 API)

java.lang.Object
- org.apache.commons.geometry.euclidean.oned.Interval

All Implemented Interfaces:

HyperplaneBoundedRegion<Vector1D>, Splittable<Vector1D,HyperplaneBoundedRegion<Vector1D>>, Region<Vector1D>, Sized
```
public final class Interval
extends Object
implements HyperplaneBoundedRegion<Vector1D>
```
Class representing an interval in one dimension. The interval is defined by minimum and maximum values. One or both of these values may be infinite although not with the same sign.
Instances of this class are guaranteed to be immutable.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RegionLocation`	`classify(double location)` Classify a point with respect to the interval.
`RegionLocation`	`classify(Vector1D pt)`
`boolean`	`contains(double x)` Return true if the given point location is on the inside or boundary of the region.
`static Interval`	`full()` Return an interval representing the entire real number line.
`double`	`getBoundarySize()`
`Vector1D`	`getCentroid()`
`double`	`getMax()` Get the maximum value for the interval or `Double.POSITIVE_INFINITY` if no maximum value exists.
`OrientedPoint`	`getMaxBoundary()` Get the `OrientedPoint` forming the maximum bounding hyperplane of the interval, or null if none exists.
`double`	`getMin()` Get the minimum value for the interval or `Double.NEGATIVE_INFINITY` if no minimum value exists.
`OrientedPoint`	`getMinBoundary()` Get the `OrientedPoint` forming the minimum bounding hyperplane of the interval, or null if none exists.
`double`	`getSize()`
`boolean`	`hasMaxBoundary()` Return true if the interval has a maximum (upper) boundary.
`boolean`	`hasMinBoundary()` Return true if the interval has a minimum (lower) boundary.
`boolean`	`isEmpty()`
`boolean`	`isFinite()` True if the region is finite, meaning that both the minimum and maximum boundaries exist and the region size is finite.
`boolean`	`isFull()`
`boolean`	`isInfinite()` True if the region is infinite, meaning that at least one of the boundaries does not exist.
`static Interval`	`max(double max, Precision.DoubleEquivalence precision)` Return an interval with the given max value and no min.
`static Interval`	`min(double min, Precision.DoubleEquivalence precision)` Return an interval with the given min value and no max.
`static Interval`	`of(double a, double b, Precision.DoubleEquivalence precision)` Create a new interval from the given point locations.
`static Interval`	`of(OrientedPoint a, OrientedPoint b)` Create a new interval from the given hyperplanes.
`static Interval`	`of(Vector1D a, Vector1D b, Precision.DoubleEquivalence precision)` Create a new interval from the given points.
`static Interval`	`point(double location, Precision.DoubleEquivalence precision)` Return an interval representing a single point at the given location.
`Vector1D`	`project(Vector1D pt)`
`Split<Interval>`	`split(Hyperplane<Vector1D> splitter)`
`String`	`toString()`
`RegionBSPTree1D`	`toTree()` Return a `RegionBSPTree1D` representing the same region as this instance.
`Interval`	`transform(Transform<Vector1D> transform)` Return a new instance transformed by the argument.

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

- Method Detail
  - getMin
```
public double getMin()
```
    Get the minimum value for the interval or Double.NEGATIVE_INFINITY if no minimum value exists.
    
    Returns:
    
    the minimum value for the interval or Double.NEGATIVE_INFINITY if no minimum value exists.
  - getMax
```
public double getMax()
```
    Get the maximum value for the interval or Double.POSITIVE_INFINITY if no maximum value exists.
    
    Returns:
    
    the maximum value for the interval or Double.POSITIVE_INFINITY if no maximum value exists.
  - getMinBoundary
```
public OrientedPoint getMinBoundary()
```
    Get the OrientedPoint forming the minimum bounding hyperplane of the interval, or null if none exists. If present, This hyperplane is oriented to point in the negative direction.
    
    Returns:
    
    the hyperplane forming the minimum boundary of the interval or null if no minimum boundary exists
  - getMaxBoundary
```
public OrientedPoint getMaxBoundary()
```
    Get the OrientedPoint forming the maximum bounding hyperplane of the interval, or null if none exists. If present, this hyperplane is oriented to point in the positive direction.
    
    Returns:
    
    the hyperplane forming the maximum boundary of the interval or null if no maximum boundary exists
  - hasMinBoundary
```
public boolean hasMinBoundary()
```
    Return true if the interval has a minimum (lower) boundary.
    
    Returns:
    
    true if the interval has minimum (lower) boundary
  - hasMaxBoundary
```
public boolean hasMaxBoundary()
```
    Return true if the interval has a maximum (upper) boundary.
    
    Returns:
    
    true if the interval has maximum (upper) boundary
  - isInfinite
```
public boolean isInfinite()
```
    True if the region is infinite, meaning that at least one of the boundaries does not exist.
    
    Specified by:
    
    isInfinite in interface Sized
    
    Returns:
    
    true if the region is infinite
  - isFinite
```
public boolean isFinite()
```
    True if the region is finite, meaning that both the minimum and maximum boundaries exist and the region size is finite.
    
    Specified by:
    
    isFinite in interface Sized
    
    Returns:
    
    true if the region is finite
  - classify
```
public RegionLocation classify(Vector1D pt)
```
    Specified by:
    
    classify in interface Region<Vector1D>
  - classify
```
public RegionLocation classify(double location)
```
    Classify a point with respect to the interval.
    
    Parameters:
    
    location - the location to classify
    
    Returns:
    
    the classification of the point with respect to the interval
    
    See Also:
    
    classify(Vector1D)
  - contains
```
public boolean contains(double x)
```
    Return true if the given point location is on the inside or boundary of the region.
    
    Parameters:
    
    x - the location to test
    
    Returns:
    
    true if the location is on the inside or boundary of the region
    
    See Also:
    
    Region.contains(org.apache.commons.geometry.core.Point)
  - project
```
public Vector1D project(Vector1D pt)
```
    The point is projected onto the nearest interval boundary. When a point is on the inside of the interval and is equidistant from both boundaries, then the minimum boundary is selected. when a point is on the outside of the interval and is equidistant from both boundaries (as is the case for intervals representing a single point), then the boundary facing the point is returned, ensuring that the returned offset is positive.
    
    Specified by:
    
    project in interface Region<Vector1D>
  - transform
```
public Interval transform(Transform<Vector1D> transform)
```
    Return a new instance transformed by the argument.
    
    Parameters:
    
    transform - transform to apply
    
    Returns:
    
    a new instance transformed by the argument
  - isEmpty
```
public boolean isEmpty()
```
    This method always returns false since there is always at least one point that can be classified as not being on the outside of the region.
    
    Specified by:
    
    isEmpty in interface Region<Vector1D>
  - isFull
```
public boolean isFull()
```
    Specified by:
    
    isFull in interface Region<Vector1D>
  - 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<Vector1D>
  - getCentroid
```
public Vector1D getCentroid()
```
    Specified by:
    
    getCentroid in interface Region<Vector1D>
  - split
```
public Split<Interval> split(Hyperplane<Vector1D> splitter)
```
    Specified by:
    
    split in interface Splittable<Vector1D,HyperplaneBoundedRegion<Vector1D>>
  - toTree
```
public RegionBSPTree1D toTree()
```
    Return a RegionBSPTree1D representing the same region as this instance.
    
    Returns:
    
    a BSP tree representing the same region
    
    See Also:
    
    RegionBSPTree1D.from(Interval, Interval...)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - of
```
public static Interval of(double a,
                          double b,
                          Precision.DoubleEquivalence precision)
```
    Create a new interval from the given point locations. The returned interval represents the region between the points, regardless of the order they are given as arguments.
    
    Parameters:
    
    a - first point location
    
    b - second point location
    
    precision - precision context used to compare floating point numbers
    
    Returns:
    
    a new interval representing the region between the given point locations
    
    Throws:
    
    IllegalArgumentException - if either number is NaN or the numbers are both infinite and have the same sign
  - of
```
public static Interval of(Vector1D a,
                          Vector1D b,
                          Precision.DoubleEquivalence precision)
```
    Create a new interval from the given points. The returned interval represents the region between the points, regardless of the order they are given as arguments.
    
    Parameters:
    
    a - first point
    
    b - second point
    
    precision - precision context used to compare floating point numbers
    
    Returns:
    
    a new interval representing the region between the given points
    
    Throws:
    
    IllegalArgumentException - if either point is NaN or the points are both infinite and have the same sign
  - of
```
public static Interval of(OrientedPoint a,
                          OrientedPoint b)
```
    Create a new interval from the given hyperplanes. The hyperplanes may be given in any order but one must be positive-facing and the other negative-facing, with the positive-facing hyperplane located above the negative-facing hyperplane. Either or both argument may be null, in which case the returned interval will extend to infinity in the appropriate direction. If both arguments are null, an interval representing the full space is returned.
    
    Parameters:
    
    a - first hyperplane; may be null
    
    b - second hyperplane; may be null
    
    Returns:
    
    a new interval representing the region between the given hyperplanes
    
    Throws:
    
    IllegalArgumentException - if the hyperplanes have the same orientation or do not form an interval (for example, if the positive-facing hyperplane is below the negative-facing hyperplane)
  - min
```
public static Interval min(double min,
                           Precision.DoubleEquivalence precision)
```
    Return an interval with the given min value and no max.
    
    Parameters:
    
    min - min value for the interval
    
    precision - precision context used to compare floating point numbers
    
    Returns:
    
    an interval with the given min value and no max.
  - max
```
public static Interval max(double max,
                           Precision.DoubleEquivalence precision)
```
    Return an interval with the given max value and no min.
    
    Parameters:
    
    max - max value for the interval
    
    precision - precision context used to compare floating point numbers
    
    Returns:
    
    an interval with the given max value and no min.
  - point
```
public static Interval point(double location,
                             Precision.DoubleEquivalence precision)
```
    Return an interval representing a single point at the given location.
    
    Parameters:
    
    location - the location of the interval
    
    precision - precision context used to compare floating point numbers
    
    Returns:
    
    an interval representing a single point
  - full
```
public static Interval full()
```
    Return an interval representing the entire real number line. The isFull() method of the instance will return true.
    
    Returns:
    
    an interval representing the entire real number line
    
    See Also:
    
    isFull()

Class Interval

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

getMin

getMax

getMinBoundary

getMaxBoundary

hasMinBoundary

hasMaxBoundary

isInfinite

isFinite

classify

classify

contains

project

transform

isEmpty

isFull

getSize

getBoundarySize

getCentroid

split

toTree

toString

of

of

of

min

max

point

full