Package de.articdive.jnoise.generators.noise_parameters.return_type_functions

Enum Class ReturnDistanceFunctionType

java.lang.Object

java.lang.Enum<ReturnDistanceFunctionType>

de.articdive.jnoise.generators.noise_parameters.return_type_functions.ReturnDistanceFunctionType

All Implemented Interfaces:

ReturnDistanceFunction, Serializable, Comparable<ReturnDistanceFunctionType>, Constable, ToDoubleFunction<double[]>

public enum ReturnDistanceFunctionType
extends Enum<ReturnDistanceFunctionType>
implements ReturnDistanceFunction

Enum representing a few commonly used return 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
DISTANCE_0	Shortest distance.
DISTANCE_01_ADD	Addition of the two shortest distances.
DISTANCE_01_MUL	Multiplication of the two shortest distances.
DISTANCE_01_SUB	Subtraction of the two shortest distances.
DISTANCE_1	Second shortest distance.

Method Summary

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

applyAsDouble, isValidArrayLength

Enum Constant Details

DISTANCE_0

public static final ReturnDistanceFunctionType DISTANCE_0

Shortest distance.

DISTANCE_1

public static final ReturnDistanceFunctionType DISTANCE_1

Second shortest distance.

DISTANCE_01_ADD

public static final ReturnDistanceFunctionType DISTANCE_01_ADD

Addition of the two shortest distances.

DISTANCE_01_SUB

public static final ReturnDistanceFunctionType DISTANCE_01_SUB

Subtraction of the two shortest distances.

DISTANCE_01_MUL

public static final ReturnDistanceFunctionType DISTANCE_01_MUL

Multiplication of the two shortest distances.

Method Details

values

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