EnclosingBall (Apache Commons Math 3.3 API)

org.apache.commons.math3.geometry.enclosing

## Class EnclosingBall<S extends Space,P extends Point<S>>

- java.lang.Object
- - org.apache.commons.math3.geometry.enclosing.EnclosingBall<S,P>

- Type Parameters:
    `S` - Space type.
    `P` - Point type.
  All Implemented Interfaces:
    Serializable

      public class EnclosingBall<S extends Space,P extends Point<S>>
      extends Object
      implements Serializable

  This class represents a ball enclosing some points.
  Since:
    3.3
  Version:
    $Id: EnclosingBall.java 1562220 2014-01-28 20:29:27Z luc $
  See Also:
    `Space`, `Point`, `Encloser`, Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `EnclosingBall(P center, double radius, P... support)` Simple constructor.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `contains(P point)` Check if a point is within the ball or at boundary.
    `boolean` | `contains(P point, double margin)` Check if a point is within an enlarged ball or at boundary.
    `P` | `getCenter()` Get the center of the ball.
    `double` | `getRadius()` Get the radius of the ball.
    `P[]` | `getSupport()` Get the support points used to define the ball.
    `int` | `getSupportSize()` Get the number of support points used to define the ball.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### EnclosingBall

          public EnclosingBall(P center,
                       double radius,
                       P... support)

      Simple constructor.
      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 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 at boundary.
      Parameters:
        `point` - point to test
      Returns:
        true if the point is within the ball or at boundary

    - #### contains

          public boolean contains(P point,
                         double margin)

      Check if a point is within an enlarged ball or at boundary.
      Parameters:
        `point` - point to test
        `margin` - margin to consider
      Returns:
        true if the point is within the ball enlarged by the margin or at boundary

Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.