org.gridfour.interpolation

Class InterpolationResult

java.lang.Object

org.gridfour.interpolation.InterpolationResult

public class InterpolationResult
extends Object

A simple container class to carry the results from an interpolation.

The results in this class treat the dependent variable z as a function evaluated over the grid coordinate system (x, y) where x is the coordinate in the direction of columns and y is the coordinate in the direction of rows.

Note: This class is designed so that instances of it can be used and re-used across multiple operations. Therefore it offers little protection in terms of member access. All members are public. All of them are mutable. Applications using this class should apply caution to the way member elements are accessed since they are subject to change between interpolation calls.

Field Summary

Fields

Modifier and Type	Field and Description
double	column A floating-point value indicating the column coordinate that was specified for the interpolation.
boolean	firstDerivativesSet Indicates that the first derivatives were computed by the interpolator.
double	row A floating-point value indicating the row coordinate that was specified for the interpolation.
boolean	secondDerivativesSet Indicates that the second derivatives were computed by the interpolator.
double	z The interpolated value for the coordinate
double	zx The value for the partial derivative of z with respect to x (in the direction of the column axis).
double	zxx The value for the second derivative of z with respect to x (in the direction of the column axis).
double	zxy The value for the second partial derivative of z with respect to x and v.
double	zy The value for the partial derivative of z with respect to y (in the direction of the row axis).
double	zyx The value for the second partial derivative of z with respect to y and u.
double	zyy The value for the second partial derivative of z with respect to v.

Constructor Summary

Constructors

Constructor and Description
InterpolationResult()

Method Summary

Modifier and Type	Method and Description
double[]	getUnitNormal() Uses the derivatives (zx, zy) stored in this instance to compute a unit normal.
void	nullify()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

row

public double row

A floating-point value indicating the row coordinate that was specified for the interpolation. Row and column coordinates may be non-integral.

column

public double column

A floating-point value indicating the column coordinate that was specified for the interpolation. Row and column coordinates may be non-integral.

z

public double z

The interpolated value for the coordinate

firstDerivativesSet

public boolean firstDerivativesSet

Indicates that the first derivatives were computed by the interpolator.

zx

public double zx

The value for the partial derivative of z with respect to x (in the direction of the column axis).

zy

public double zy

The value for the partial derivative of z with respect to y (in the direction of the row axis).

secondDerivativesSet

public boolean secondDerivativesSet

Indicates that the second derivatives were computed by the interpolator.

zxx

public double zxx

The value for the second derivative of z with respect to x (in the direction of the column axis).

zxy

public double zxy

The value for the second partial derivative of z with respect to x and v.

zyx

public double zyx

The value for the second partial derivative of z with respect to y and u.

zyy

public double zyy

The value for the second partial derivative of z with respect to v.

Constructor Detail

InterpolationResult

public InterpolationResult()

Method Detail

getUnitNormal

public double[] getUnitNormal()

Uses the derivatives (zx, zy) stored in this instance to compute a unit normal.

Returns:

if successful, a valid array giving the x, y, and z coordinates of a unit normal to the surface at the interpolation point; in the event of a failure, a null.

nullify

public void nullify()