Package org.tinfour.interpolation

Enum NaturalNeighborElements.ResultType

java.lang.Object

java.lang.Enum<NaturalNeighborElements.ResultType>

org.tinfour.interpolation.NaturalNeighborElements.ResultType

All Implemented Interfaces:

Serializable, Comparable<NaturalNeighborElements.ResultType>

Enclosing class:

NaturalNeighborElements

public static enum NaturalNeighborElements.ResultType
extends Enum<NaturalNeighborElements.ResultType>

Indicate the kind of results that are stored in this instance.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COLOCATION	Indicates that the query point was co-located with one of the defining vertices in the data set.
EXTERIOR	Indicates that the query point was located on or outside the boundary of the underlying Delaunay triangulation.
SUCCESS	Indicates that the interpolation was successful and all member elements are populated

Method Summary

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

SUCCESS

public static final NaturalNeighborElements.ResultType SUCCESS

Indicates that the interpolation was successful and all member elements are populated

COLOCATION

public static final NaturalNeighborElements.ResultType COLOCATION

Indicates that the query point was co-located with one of the defining vertices in the data set. Although this result represents a successful query, there is no meaningful assignments to the set of natural neighbors. Instead, the co-located vertex is stored in the result. The array of natural neighbors will contain exactly one element and the corresponding array of weights will include one element with a value of 1.0

EXTERIOR

public static final NaturalNeighborElements.ResultType EXTERIOR

Indicates that the query point was located on or outside the boundary of the underlying Delaunay triangulation. The arrays of natural neighbors and weights will be dimensioned to a size of zero. This behavior may be subject to change in the future in order to support extrapolation.

Method Detail

values

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

Returns:

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

valueOf

public static NaturalNeighborElements.ResultType 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