Package de.articdive.jnoise.generators.noise_parameters.distance_functions

Enum Class DistanceFunctionType

java.lang.Object

java.lang.Enum<DistanceFunctionType>

de.articdive.jnoise.generators.noise_parameters.distance_functions.DistanceFunctionType

All Implemented Interfaces:

DistanceFunction, Serializable, Comparable<DistanceFunctionType>, Constable

public enum DistanceFunctionType
extends Enum<DistanceFunctionType>
implements DistanceFunction

Enum representing a few commonly used distance functions for noise generation.

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	Chebyshev distance function
EUCLIDEAN	Euclidean distance function
EUCLIDEAN_SQUARED	Euclidean distance function (squared)
MANHATTAN	Manhatten distance function

Method Summary

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

Methods inherited from interface de.articdive.jnoise.generators.noise_parameters.distance_functions.DistanceFunction

distance, distance, distance, distance

Enum Constant Details

EUCLIDEAN

public static final DistanceFunctionType EUCLIDEAN

Euclidean distance function

EUCLIDEAN_SQUARED

public static final DistanceFunctionType EUCLIDEAN_SQUARED

Euclidean distance function (squared)

MANHATTAN

public static final DistanceFunctionType MANHATTAN

Manhatten distance function

CHEBYSHEV

public static final DistanceFunctionType CHEBYSHEV

Chebyshev distance function

Method Details

values

public static DistanceFunctionType[] 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 DistanceFunctionType 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