org.apache.commons.geometry.core.partitioning

Enum HyperplaneLocation

java.lang.Object

java.lang.Enum<HyperplaneLocation>

org.apache.commons.geometry.core.partitioning.HyperplaneLocation

All Implemented Interfaces:

Serializable, Comparable<HyperplaneLocation>

public enum HyperplaneLocation
extends Enum<HyperplaneLocation>

Enumeration containing possible locations of a point with respect to a hyperplane.

See Also:

Hyperplane

Enum Constant Summary

Enum Constants

Enum Constant and Description
MINUS Value indicating that a point lies on the minus side of a hyperplane.
ON Value indicating that a point lies directly on a hyperplane.
PLUS Value indicating that a point lies on the plus side of a hyperplane.

Method Summary

Modifier and Type	Method and Description
static HyperplaneLocation	valueOf(String name) Returns the enum constant of this type with the specified name.
static HyperplaneLocation[]	values() 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 Detail

MINUS

public static final HyperplaneLocation MINUS

Value indicating that a point lies on the minus side of a hyperplane.

PLUS

public static final HyperplaneLocation PLUS

Value indicating that a point lies on the plus side of a hyperplane.

ON

public static final HyperplaneLocation ON

Value indicating that a point lies directly on a hyperplane.

Method Detail

values

public static HyperplaneLocation[] 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 (HyperplaneLocation c : HyperplaneLocation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HyperplaneLocation 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