Enum SplitLocation

java.lang.Object
java.lang.Enum<SplitLocation>
org.apache.commons.geometry.core.partitioning.SplitLocation
All Implemented Interfaces:
Serializable, Comparable<SplitLocation>

public enum SplitLocation extends Enum<SplitLocation>
Enumeration representing the location of a split object with respect to its splitting hyperplane.
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Value indicating that the split object lies in both the plus and minus sides of the splitting hyperplane.
    Value indicating that the split object lies entirely on the minus side of the splitting hyperplane.
    Value indicating that the split object lies neither on the plus or minus sides of the splitting hyperplane.
    Value indicating that the split object lies entirely on the plus side of the splitting hyperplane.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this type with the specified name.
    static SplitLocation[]
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • PLUS

      public static final SplitLocation PLUS
      Value indicating that the split object lies entirely on the plus side of the splitting hyperplane.
    • MINUS

      public static final SplitLocation MINUS
      Value indicating that the split object lies entirely on the minus side of the splitting hyperplane.
    • BOTH

      public static final SplitLocation BOTH
      Value indicating that the split object lies in both the plus and minus sides of the splitting hyperplane.
    • NEITHER

      public static final SplitLocation NEITHER
      Value indicating that the split object lies neither on the plus or minus sides of the splitting hyperplane. This is the case when the object lies entirely on the hyperplane or is empty (and therefore "lies" nowhere).
  • Constructor Details

    • SplitLocation

      private SplitLocation()
  • Method Details

    • values

      public static SplitLocation[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static SplitLocation valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null