Package org.hipparchus.analysis.interpolation

Class FieldBilinearInterpolatingFunction<T extends CalculusFieldElement<T>>

java.lang.Object

org.hipparchus.analysis.interpolation.FieldBilinearInterpolatingFunction<T>

Type Parameters:

T - Type of the field elements.

All Implemented Interfaces:

CalculusFieldBivariateFunction<T>

public class FieldBilinearInterpolatingFunction<T extends CalculusFieldElement<T>>
extends Object
implements CalculusFieldBivariateFunction<T>

Interpolate grid data using bi-linear interpolation.

This interpolator is thread-safe.

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
FieldBilinearInterpolatingFunction(T[] xVal, T[] yVal, T[][] fVal)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
T	getXInf()	Get the lowest grid x coordinate.
T	getXSup()	Get the highest grid x coordinate.
T	getYInf()	Get the lowest grid y coordinate.
T	getYSup()	Get the highest grid y coordinate.
T	value(T x, T y)	Compute the value for the function.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldBilinearInterpolatingFunction

public FieldBilinearInterpolatingFunction(T[] xVal,
                                          T[] yVal,
                                          T[][] fVal)
                                   throws MathIllegalArgumentException

Simple constructor.

Parameters:

xVal - All the x-coordinates of the interpolation points, sorted in increasing order.

yVal - All the y-coordinates of the interpolation points, sorted in increasing order.

fVal - The values of the interpolation points on all the grid knots: fVal[i][j] = f(xVal[i], yVal[j]).

Throws:

MathIllegalArgumentException - if grid size is smaller than 2 or if the grid is not sorted in strict increasing order

Method Detail

getXInf

public T getXInf()

Get the lowest grid x coordinate.

Returns:

lowest grid x coordinate

getXSup

public T getXSup()

Get the highest grid x coordinate.

Returns:

highest grid x coordinate

getYInf

public T getYInf()

Get the lowest grid y coordinate.

Returns:

lowest grid y coordinate

getYSup

public T getYSup()

Get the highest grid y coordinate.

Returns:

highest grid y coordinate

value

public T value(T x,
               T y)

Compute the value for the function.

Specified by:

value in interface CalculusFieldBivariateFunction<T extends CalculusFieldElement<T>>

Parameters:

x - Abscissa for which the function value should be computed.

y - Ordinate for which the function value should be computed.

Returns:

the value.