net.charlesames.utility.contour
Enum CalculationMode

java.lang.Object
  java.lang.Enum<CalculationMode>
      net.charlesames.utility.contour.CalculationMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CalculationMode>

public enum CalculationMode
extends java.lang.Enum<CalculationMode>

The CalculationMode determines how given an ordinate within a segment, the value of the contour is calculated using the segments left bound, right bound, origin, and goal.

Author:

Charles Ames

Enum Constant Summary

DISCRETE
The value of the contour at any ordinate within the segment is the same as the segment origin.

EXPONENTIAL
The value of the contour at any ordinate within the segment is exponentially interpolated, based on where the ordinate falls within the segment's left and right boundaries.

LINEAR
The value of the contour at any ordinate within the segment is linearly interpolated, based on where the ordinate falls within the segment's left and right boundaries.

SPLINE
The value of the contour at any ordinate within the segment from a to b is interpolated using a spline function q(x) where q'(a)=0 and q'(b)=0.

SPLINEX
The value of the contour at any ordinate within the segment from a to b is interpolated using an exponential-spline function pow(a,q(x)) where q'(a)=0 and q'(b)=0.

Method Summary

static CalculationMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CalculationMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISCRETE

public static final CalculationMode DISCRETE

The value of the contour at any ordinate within the segment is the same as the segment origin.

LINEAR

public static final CalculationMode LINEAR

The value of the contour at any ordinate within the segment is linearly interpolated, based on where the ordinate falls within the segment's left and right boundaries.

EXPONENTIAL

public static final CalculationMode EXPONENTIAL

The value of the contour at any ordinate within the segment is exponentially interpolated, based on where the ordinate falls within the segment's left and right boundaries. The origin and goal of any segment must both be positive numbers.

SPLINE

public static final CalculationMode SPLINE

The value of the contour at any ordinate within the segment from a to b is interpolated using a spline function q(x) where q'(a)=0 and q'(b)=0.

SPLINEX

public static final CalculationMode SPLINEX

The value of the contour at any ordinate within the segment from a to b is interpolated using an exponential-spline function pow(a,q(x)) where q'(a)=0 and q'(b)=0.

Method Detail

values

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

Returns:

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

valueOf

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