org.apache.commons.geometry.euclidean.twod

Class Bounds2D

java.lang.Object

org.apache.commons.geometry.euclidean.AbstractBounds<Vector2D,Bounds2D>

org.apache.commons.geometry.euclidean.twod.Bounds2D

public final class Bounds2D
extends AbstractBounds<Vector2D,Bounds2D>

Class containing minimum and maximum points defining a 2D axis-aligned bounding box. Unless otherwise noted, floating point comparisons used in this class are strict, meaning that values are considered equal if and only if they match exactly.

Instances of this class are guaranteed to be immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bounds2D.Builder Class used to construct Bounds2D instances.

Method Summary

Modifier and Type	Method and Description
static Bounds2D.Builder	builder() Construct a new Bounds2D.Builder instance for creating bounds.
boolean	contains(Vector2D pt) Return true if the given point is strictly within or on the boundary of the bounding box.
boolean	contains(Vector2D pt, Precision.DoubleEquivalence precision) Return true if the given point is within or on the boundary of the bounding box, using the given precision context for floating point comparisons.
boolean	equals(Object obj)
static Bounds2D	from(Iterable<Vector2D> points) Construct a new instance from the given points.
static Bounds2D	from(Vector2D first, Vector2D... more) Construct a new instance from the given points.
int	hashCode()
boolean	hasSize(Precision.DoubleEquivalence precision) Return true if the bounding box has non-zero size along each coordinate axis, as evaluated by the given precision context.
Bounds2D	intersection(Bounds2D other) Return the intersection of this bounding box and the argument, or null if no intersection exists.
boolean	intersects(Bounds2D other) Return true if any point on the interior or boundary of this instance is also considered to be on the interior or boundary of the argument.
Parallelogram	toRegion(Precision.DoubleEquivalence precision) Return a hyperplane-bounded region containing the same points as this instance.

Methods inherited from class org.apache.commons.geometry.euclidean.AbstractBounds

eq, getCentroid, getDiagonal, getMax, getMin, toString

Methods inherited from class java.lang.Object

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

Method Detail

hasSize

public boolean hasSize(Precision.DoubleEquivalence precision)

Return true if the bounding box has non-zero size along each coordinate axis, as evaluated by the given precision context.

Specified by:

hasSize in class AbstractBounds<Vector2D,Bounds2D>

Parameters:

precision - precision context used for floating point comparisons

Returns:

true if the bounding box has non-zero size along each coordinate axis

contains

public boolean contains(Vector2D pt)

Return true if the given point is strictly within or on the boundary of the bounding box. In other words, true if returned if pt >= mint and pt <= maxt for each coordinate value t. Floating point comparisons are strict; values are considered equal only if they match exactly.

Specified by:

contains in class AbstractBounds<Vector2D,Bounds2D>

Parameters:

pt - the point to check

Returns:

true if the given point is strictly within or on the boundary of the instance

See Also:

AbstractBounds.contains(EuclideanVector, Precision.DoubleEquivalence)

contains

public boolean contains(Vector2D pt,
                        Precision.DoubleEquivalence precision)

Return true if the given point is within or on the boundary of the bounding box, using the given precision context for floating point comparisons. This is similar to AbstractBounds.contains(EuclideanVector) but allows points that may be strictly outside of the box due to floating point errors to be considered inside.

Specified by:

contains in class AbstractBounds<Vector2D,Bounds2D>

Parameters:

pt - the point to check

precision - precision context used to compare floating point values

Returns:

if the given point is within or on the boundary of the bounds, as determined by the given precision context

See Also:

AbstractBounds.contains(EuclideanVector, Precision.DoubleEquivalence)

intersects

public boolean intersects(Bounds2D other)

Return true if any point on the interior or boundary of this instance is also considered to be on the interior or boundary of the argument. Specifically, true is returned if aMint <= bMaxt and aMaxt >= bMint for all coordinate values t, where a is the current instance and b is the argument. Floating point comparisons are strict; values are considered equal only if they match exactly.

Specified by:

intersects in class AbstractBounds<Vector2D,Bounds2D>

Parameters:

other - bounding box to intersect with

Returns:

true if the bounds intersect

intersection

public Bounds2D intersection(Bounds2D other)

Return the intersection of this bounding box and the argument, or null if no intersection exists. Floating point comparisons are strict; values are considered equal only if they match exactly. Note this this method may return bounding boxes with zero size in one or more coordinate axes.

Specified by:

intersection in class AbstractBounds<Vector2D,Bounds2D>

Parameters:

other - bounding box to intersect with

Returns:

the intersection of this instance and the argument, or null if no such intersection exists

See Also:

AbstractBounds.intersects(AbstractBounds)

toRegion

public Parallelogram toRegion(Precision.DoubleEquivalence precision)

Return a hyperplane-bounded region containing the same points as this instance.

Specified by:

toRegion in class AbstractBounds<Vector2D,Bounds2D>

Parameters:

precision - precision context used for floating point comparisons in the returned region instance

Returns:

a hyperplane-bounded region containing the same points as this instance

Throws:

IllegalArgumentException - if any dimension of the bounding box is zero as evaluated by the given precision context

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

from

public static Bounds2D from(Vector2D first,
                            Vector2D... more)

Construct a new instance from the given points.

Parameters:

first - first point

more - additional points

Returns:

a new instance containing the min and max coordinates values from the input points

from

public static Bounds2D from(Iterable<Vector2D> points)

Construct a new instance from the given points.

Parameters:

points - input points

Returns:

a new instance containing the min and max coordinates values from the input points

builder

public static Bounds2D.Builder builder()

Construct a new Bounds2D.Builder instance for creating bounds.

Returns:

a new builder instance for creating bounds