Class AbstractConvexHyperplaneBoundedRegion<P extends Point<P>, S extends HyperplaneConvexSubset<P>>

java.lang.Object
org.apache.commons.geometry.core.partitioning.AbstractConvexHyperplaneBoundedRegion<P,S>
Type Parameters:
P - Point implementation type
S - Hyperplane convex subset implementation type
All Implemented Interfaces:
HyperplaneBoundedRegion<P>, Splittable<P, HyperplaneBoundedRegion<P>>, Region<P>, Sized
Direct Known Subclasses:
ConvexArea, ConvexArea2S, ConvexVolume
public abstract class AbstractConvexHyperplaneBoundedRegion<P extends Point<P>, S extends HyperplaneConvexSubset<P>> extends Object implements HyperplaneBoundedRegion<P>
Base class for convex hyperplane-bounded regions. This class provides generic implementations of many algorithms related to convex regions.

  • Constructor Details

    • AbstractConvexHyperplaneBoundedRegion

      protected AbstractConvexHyperplaneBoundedRegion(List<S> boundaries)
      Simple constructor. Callers are responsible for ensuring that the given list of boundaries define a convex region. No validation is performed.
      Parameters:
      boundaries - the boundaries of the convex region

  • Method Details

    • getBoundaries

      public List<S> getBoundaries()
      Get the boundaries of the convex region. The exact ordering of the boundaries is not guaranteed.
      Returns:
      the boundaries of the convex region

    • isFull

      public boolean isFull()
      Return true if the region spans the entire space. In other words, a region is full if no points in the space are classified as outside.
      Specified by:
      isFull in interface Region<P extends Point<P>>
      Returns:
      true if the region spans the entire space

    • isEmpty

      public boolean isEmpty()
      Return true if the region is completely empty, ie all points in the space are classified as outside.

      This method always returns false.

      Specified by:
      isEmpty in interface Region<P extends Point<P>>
      Returns:
      true if the region is empty

    • getBoundarySize

      public double getBoundarySize()
      Get the size of the boundary of the region. The size is a value in the d-1 dimension space. For example, in Euclidean space, this will be a length in 2D and an area in 3D.
      Specified by:
      getBoundarySize in interface Region<P extends Point<P>>
      Returns:
      the size of the boundary of the region

    • classify

      public RegionLocation classify(P pt)
      Classify the given point with respect to the region.
      Specified by:
      classify in interface Region<P extends Point<P>>
      Parameters:
      pt - the point to classify
      Returns:
      the location of the point with respect to the region

    • project

      public P project(P pt)
      Project a point onto the boundary of the region. Null is returned if the region contains no boundaries (ie, is either full or empty).
      Specified by:
      project in interface Region<P extends Point<P>>
      Parameters:
      pt - pt to project
      Returns:
      projection of the point on the boundary of the region or null if the region does not contain any boundaries

    • trim

      public HyperplaneConvexSubset<P> trim(HyperplaneConvexSubset<P> sub)
      Trim the given hyperplane subset to the portion contained inside this instance.
      Parameters:
      sub - hyperplane subset to trim. Null is returned if the subset does not intersect the instance.
      Returns:
      portion of the argument that lies entirely inside the region represented by this instance, or null if it does not intersect.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • transformInternal

      protected <R extends AbstractConvexHyperplaneBoundedRegion<P,S>> R transformInternal(Transform<P> transform, R thisInstance, Class<S> boundaryType, Function<? super List<S>, R> factory)
      Generic, internal transform method. Subclasses should use this to implement their own transform methods.
      Type Parameters:
      R - Region implementation type
      Parameters:
      transform - the transform to apply to the instance
      thisInstance - a reference to the current instance; this is passed as an argument in order to allow it to be a generic type
      boundaryType - the type used for the boundary hyperplane subsets
      factory - function used to create new convex region instances
      Returns:
      the result of the transform operation

    • swapsInsideOutside

      protected boolean swapsInsideOutside(Transform<P> transform)
      Return true if the given transform swaps the inside and outside of the region.

      The default behavior of this method is to return true if the transform does not preserve spatial orientation (ie, Transform.preservesOrientation() is false). Subclasses may need to override this method to implement the correct behavior for their space and dimension.

      Parameters:
      transform - transform to check
      Returns:
      true if the given transform swaps the interior and exterior of the region

    • splitInternal

      protected <R extends AbstractConvexHyperplaneBoundedRegion<P,S>> Split<R> splitInternal(Hyperplane<P> splitter, R thisInstance, Class<S> boundaryType, Function<List<S>,R> factory)
      Generic, internal split method. Subclasses should call this from their Splittable.split(Hyperplane) methods.
      Type Parameters:
      R - Region implementation type
      Parameters:
      splitter - splitting hyperplane
      thisInstance - a reference to the current instance; this is passed as an argument in order to allow it to be a generic type
      boundaryType - the type used for the boundary hyperplane subsets
      factory - function used to create new convex region instances
      Returns:
      the result of the split operation