java.lang.Object
org.apache.commons.geometry.core.partitioning.Split<T>
Type Parameters:
T - Split type

public final class Split<T> extends Object
Class containing the result of splitting an object with a hyperplane.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final T
    Part of the object lying on the minus side of the splitting hyperplane.
    private final T
    Part of the object lying on the plus side of the splitting hyperplane.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Split(T minus, T plus)
    Build a new instance from its parts.
  • Method Summary

    Modifier and Type
    Method
    Description
    Get the location of the object with respect to its splitting hyperplane.
    Get the part of the object lying on the minus side of the splitting hyperplane or null if no such part exists.
    Get the part of the object lying on the plus side of the splitting hyperplane or null if no such part exists.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • minus

      private final T minus
      Part of the object lying on the minus side of the splitting hyperplane.
    • plus

      private final T plus
      Part of the object lying on the plus side of the splitting hyperplane.
  • Constructor Details

    • Split

      public Split(T minus, T plus)
      Build a new instance from its parts.
      Parameters:
      minus - part of the object lying on the minus side of the splitting hyperplane or null if no such part exists
      plus - part of the object lying on the plus side of the splitting hyperplane or null if no such part exists.
  • Method Details

    • getMinus

      public T getMinus()
      Get the part of the object lying on the minus side of the splitting hyperplane or null if no such part exists.
      Returns:
      part of the object lying on the minus side of the splitting hyperplane
    • getPlus

      public T getPlus()
      Get the part of the object lying on the plus side of the splitting hyperplane or null if no such part exists.
      Returns:
      part of the object lying on the plus side of the splitting hyperplane
    • getLocation

      public SplitLocation getLocation()
      Get the location of the object with respect to its splitting hyperplane.
      Returns:
    • toString

      public String toString()
      Overrides:
      toString in class Object