squidpony.squidmath

Enum AStarSearch.SearchType

java.lang.Object

java.lang.Enum<AStarSearch.SearchType>

squidpony.squidmath.AStarSearch.SearchType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AStarSearch.SearchType>

Enclosing class:

AStarSearch

public static enum AStarSearch.SearchType
extends java.lang.Enum<AStarSearch.SearchType>

The type of heuristic to use.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHEBYSHEV The distance it takes when diagonal movement costs the same as cardinal movement.
DIJKSTRA Full space search.
EUCLIDEAN The distance it takes as the crow flies.
MANHATTAN The distance it takes when only the four primary directions can be moved in.

Method Summary

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

MANHATTAN

public static final AStarSearch.SearchType MANHATTAN

The distance it takes when only the four primary directions can be moved in.

CHEBYSHEV

public static final AStarSearch.SearchType CHEBYSHEV

The distance it takes when diagonal movement costs the same as cardinal movement.

EUCLIDEAN

public static final AStarSearch.SearchType EUCLIDEAN

The distance it takes as the crow flies.

DIJKSTRA

public static final AStarSearch.SearchType DIJKSTRA

Full space search. Least efficient but guaranteed to return a path if one exists. See also DijkstraMap.

Method Detail

values

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

Returns:

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

valueOf

public static AStarSearch.SearchType 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 name

java.lang.NullPointerException - if the argument is null