gov.usgs.earthquake.nshmp.data

Class Interpolate

java.lang.Object

gov.usgs.earthquake.nshmp.data.Interpolate

Deprecated.

@Deprecated
public final class Interpolate
extends Object

Utility class to perform linear interpolations. Methods are also provided to perform interpolations in log space. The methods of this class are designed to be fast and, as such perform almost no argument checking.

NOTE: This class is designed to be used primarily with the OpenSHA function classes and should probably be relocated to that package and given default visibility due to the lack of error-checking. We could write public methods that do thorough error checking.

Warning: These methods do no error checking for null , empty, or single valued arrays; arrays of different lengths; nor does it check that the supplied x-values are monotonically increasing (sorted). Internally the method uses binary search and it is up to the user to supply valid data.

Author:

Peter Powers

Method Summary

Modifier and Type	Method and Description
static double	findLogLogY(double[] xs, double[] ys, double x) Deprecated. Returns the log-log interpolated or extrapolated y-value using the supplied x- and y-value arrays.
static double[]	findLogLogY(double[] xs, double[] ys, double[] x) Deprecated. Returns the log-log interpolated or extrapolated y-values using the supplied x- and y-value arrays.
static double	findLogY(double[] xs, double[] ys, double x) Deprecated. Returns the log interpolated or extrapolated y-value using the supplied x- and y-value arrays.
static double[]	findLogY(double[] xs, double[] ys, double[] x) Deprecated. Returns the log interpolated or extrapolated y-values using the supplied x- and y-value arrays.
static double	findX(double x1, double y1, double x2, double y2, double y) Deprecated. Returns the interpolated or extrapolated x-value corresponding to the supplied y-value.
static double	findY(double[] xs, double[] ys, double x) Deprecated. Returns the interpolated or extrapolated y-value using the supplied x- and y-value arrays.
static double[]	findY(double[] xs, double[] ys, double[] x) Deprecated. Returns interpolated or extrapolated y-values using the supplied x- and y-value arrays.
static double	findY(double x1, double y1, double x2, double y2, double x) Deprecated. Returns the interpolated or extrapolated y-value corresponding to the supplied x-value.
static double	findY(List<Double> xs, List<Double> ys, double x) Deprecated.
static double[]	findY(List<Double> xs, List<Double> ys, double[] x) Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

findX

public static double findX(double x1,
                           double y1,
                           double x2,
                           double y2,
                           double y)

Deprecated.

Returns the interpolated or extrapolated x-value corresponding to the supplied y-value. If any supplied value is NaN, returned value will also be NaN. Method does not do any input validation such that if the supplied points are coincident or define a horizontal line, the method may return Infinity, -Infinity, or NaN .

Parameters:

x1 - x-value of first point

y1 - y-value of first point

x2 - x-value of second point

y2 - y-value of second point

y - value at which to find x

Returns:

the interpolated x-value

findY

public static double findY(double x1,
                           double y1,
                           double x2,
                           double y2,
                           double x)

Deprecated.

Returns the interpolated or extrapolated y-value corresponding to the supplied x-value. If any supplied value is NaN, returned value will also be NaN. Method does not do any input validation such that if the supplied points are coincident or define a vertical line, the method may return Infinity, -Infinity, or NaN.

Parameters:

x1 - x-value of first point

y1 - y-value of first point

x2 - x-value of second point

y2 - y-value of second point

x - value at which to find y

Returns:

the interpolated y-value

findY

public static double findY(double[] xs,
                           double[] ys,
                           double x)

Deprecated.

Returns the interpolated or extrapolated y-value using the supplied x- and y-value arrays.

Parameters:

xs - x-values of some function

ys - y-values of some function

x - value at which to find y

Returns:

the interpolated y-value

findY

public static double findY(List<Double> xs,
                           List<Double> ys,
                           double x)

Deprecated.

findLogY

public static double findLogY(double[] xs,
                              double[] ys,
                              double x)

Deprecated.

Returns the log interpolated or extrapolated y-value using the supplied x- and y-value arrays. TODO needs unit test

Parameters:

xs - x-values of some function

ys - y-values of some function

x - value at which to find y

Returns:

the interpolated y-value

findLogLogY

public static double findLogLogY(double[] xs,
                                 double[] ys,
                                 double x)

Deprecated.

Returns the log-log interpolated or extrapolated y-value using the supplied x- and y-value arrays.

Parameters:

xs - x-values of some function

ys - y-values of some function

x - value at which to find y

Returns:

the log-log interpolated y-value

findY

public static double[] findY(double[] xs,
                             double[] ys,
                             double[] x)

Deprecated.

Returns interpolated or extrapolated y-values using the supplied x- and y-value arrays.

Parameters:

xs - x-values of some function

ys - y-values of some function

x - value at which to find y

Returns:

the interpolated y-values

findY

public static double[] findY(List<Double> xs,
                             List<Double> ys,
                             double[] x)

Deprecated.

findLogY

public static double[] findLogY(double[] xs,
                                double[] ys,
                                double[] x)

Deprecated.

Returns the log interpolated or extrapolated y-values using the supplied x- and y-value arrays.

Parameters:

xs - x-values of some function

ys - y-values of some function

x - value at which to find y

Returns:

the log interpolated y-values

findLogLogY

public static double[] findLogLogY(double[] xs,
                                   double[] ys,
                                   double[] x)

Deprecated.

Returns the log-log interpolated or extrapolated y-values using the supplied x- and y-value arrays.

Parameters:

xs - x-values of some function

ys - y-values of some function

x - value at which to find y

Returns:

the log-log interpolated y-values