org.apache.commons.geometry.enclosing

Class EnclosingBall<P extends Point<P>>

java.lang.Object

org.apache.commons.geometry.enclosing.EnclosingBall<P>

Type Parameters:

P - Point type.

public class EnclosingBall<P extends Point<P>>
extends Object

This class represents a ball enclosing some points.

See Also:

Point, Encloser

Constructor Summary

Constructors

Constructor and Description
EnclosingBall(P center, double radius, Collection<P> support) Construct an enclosing ball defined by a collection of support points.

Method Summary

Modifier and Type	Method and Description
boolean	contains(P point) Check if a point is within the ball or on the boundary.
boolean	contains(P point, DoublePrecisionContext precision) Check if a point is within the ball or on the boundary, using the given precision context for floating point comparison.
P	getCenter() Get the center of the ball.
double	getRadius() Get the radius of the ball.
List<P>	getSupport() Get the support points used to define the ball.
int	getSupportSize() Get the number of support points used to define the ball.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EnclosingBall

public EnclosingBall(P center,
                     double radius,
                     Collection<P> support)

Construct an enclosing ball defined by a collection of support points. Callers are responsible for ensuring that the given points lie inside the ball. No validation is performed.

Parameters:

center - center of the ball

radius - radius of the ball

support - support points used to define the ball

Method Detail

getCenter

public P getCenter()

Get the center of the ball.

Returns:

center of the ball

getRadius

public double getRadius()

Get the radius of the ball.

Returns:

radius of the ball (can be negative if the ball is empty)

getSupport

public List<P> getSupport()

Get the support points used to define the ball.

Returns:

support points used to define the ball

getSupportSize

public int getSupportSize()

Get the number of support points used to define the ball.

Returns:

number of support points used to define the ball

contains

public boolean contains(P point)

Check if a point is within the ball or on the boundary. True is returned if the distance from the center of the ball to the given point is strictly less than or equal to the ball radius.

Parameters:

point - point to test

Returns:

true if the point is within the ball or on the boundary

contains

public boolean contains(P point,
                        DoublePrecisionContext precision)

Check if a point is within the ball or on the boundary, using the given precision context for floating point comparison. True is returned if the distance from the center of the ball to the given point is less than or equal to the ball radius as evaluated by the precision context.

Parameters:

point - point to test

precision - precision context to use for floating point comparisons

Returns:

true if the point is within the ball or on the boundary as evaluated by the precision context

toString

public String toString()

Overrides:

toString in class Object