Enum SplitLocation
- java.lang.Object
-
- java.lang.Enum<SplitLocation>
-
- org.apache.commons.geometry.core.partitioning.SplitLocation
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<SplitLocation>
public enum SplitLocation extends java.lang.Enum<SplitLocation>
Enumeration representing the location of a split object with respect to its splittinghyperplane
.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BOTH
Value indicating that the split object lies in both the plus and minus sides of the splitting hyperplane.MINUS
Value indicating that the split object lies entirely on the minus side of the splitting hyperplane.NEITHER
Value indicating that the split object lies neither on the plus or minus sides of the splitting hyperplane.PLUS
Value indicating that the split object lies entirely on the plus side of the splitting hyperplane.
-
Constructor Summary
Constructors Modifier Constructor Description private
SplitLocation()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static SplitLocation
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static SplitLocation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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).
-
-
Method Detail
-
values
public static SplitLocation[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (SplitLocation c : SplitLocation.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SplitLocation valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-