org.tinfour.gwr

Enum SurfaceModel

java.lang.Object

java.lang.Enum<SurfaceModel>

org.tinfour.gwr.SurfaceModel

All Implemented Interfaces:

Serializable, Comparable<SurfaceModel>

public enum SurfaceModel
extends Enum<SurfaceModel>

An enumeration defining model selections for interpolation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Cubic z(x, y) = b0 + b1*x + b2*y + b3*x^2 +b4*y^2 + b5*x^3 + b6*y^3.
CubicWithCrossTerms z(x, y) = b0 + b1*x + b2*y + b3*x^2 +b4*y^2 + b5*x*y + b6*x^2*y + b7*x*y^2 + b8*x^3 + b9*y^3.
Planar z(x,y) = b0 + b1*x + b2*y
PlanarWithCrossTerms z(x,y) = b0 + b1*x + b2*y + b3*x*y
Quadratic z(x, y) = b0 + b1*x + b2*y + b3*x^2 +b4*y^2
QuadraticWithCrossTerms z(x, y) = b0 + b1*x + b2*y + b3*x^2 +b4*y^2 + b5*x*y

Method Summary

Modifier and Type	Method and Description
String	getAbbreviation() Gets a three letter abbreviation indicating the model type, intended for tabular data output.
int	getCoefficientCount()
int	getIndependentVariableCount()
static SurfaceModel	valueOf(String name) Returns the enum constant of this type with the specified name.
static SurfaceModel[]	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

Planar

public static final SurfaceModel Planar

z(x,y) = b0 + b1*x + b2*y

PlanarWithCrossTerms

public static final SurfaceModel PlanarWithCrossTerms

z(x,y) = b0 + b1*x + b2*y + b3*x*y

Quadratic

public static final SurfaceModel Quadratic

z(x, y) = b0 + b1*x + b2*y + b3*x^2 +b4*y^2

QuadraticWithCrossTerms

public static final SurfaceModel QuadraticWithCrossTerms

z(x, y) = b0 + b1*x + b2*y + b3*x^2 +b4*y^2 + b5*x*y

Cubic

public static final SurfaceModel Cubic

z(x, y) = b0 + b1*x + b2*y + b3*x^2 +b4*y^2 + b5*x^3 + b6*y^3.

CubicWithCrossTerms

public static final SurfaceModel CubicWithCrossTerms

z(x, y) = b0 + b1*x + b2*y + b3*x^2 +b4*y^2 + b5*x*y + b6*x^2*y + b7*x*y^2 + b8*x^3 + b9*y^3.

Method Detail

values

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

Returns:

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

valueOf

public static SurfaceModel 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

getCoefficientCount

public int getCoefficientCount()

getIndependentVariableCount

public int getIndependentVariableCount()

getAbbreviation

public String getAbbreviation()

Gets a three letter abbreviation indicating the model type, intended for tabular data output.

Returns:

a three letter abbreviation.