Package com.epicbot.api.common

Enum Class DistanceFunction

java.lang.Object

java.lang.Enum<DistanceFunction>

com.epicbot.api.common.DistanceFunction

All Implemented Interfaces:

Serializable, Comparable<DistanceFunction>, Constable

public enum DistanceFunction
extends Enum<DistanceFunction>

An enum representing the distance function to use when calculating distance between two locatables.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHEBYSHEV	Distance calculated using the Chebyshev distance (max of x and y distance)
EUCLIDEAN	Distance calculated using the Euclidean distance (straight line)

Method Summary

Modifier and Type	Method	Description
static DistanceFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DistanceFunction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EUCLIDEAN

public static final DistanceFunction EUCLIDEAN

Distance calculated using the Euclidean distance (straight line)

CHEBYSHEV

public static final DistanceFunction CHEBYSHEV

Distance calculated using the Chebyshev distance (max of x and y distance)

Method Details

values

public static DistanceFunction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DistanceFunction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null