Interpolation.GridLinearInterpolator Method

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.1.0

Overload List

GridLinearInterpolator(IReadOnlyList<IReadOnlyList<Double>>, IReadOnlyList<Double>, ExtrapolationMode)	Creates a grid-based linear interpolator over an N-dimensional rectilinear grid.
GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, Matrix<Double>, ExtrapolationMode)	Creates a grid-based linear interpolator over a 2D rectilinear grid.
GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, ExtrapolationMode)	Creates a grid-based linear interpolator over a 2D rectilinear grid.
GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, Double[,], ExtrapolationMode)	Creates a grid-based linear interpolator over a 2D rectilinear grid.
GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, ExtrapolationMode)	Creates a grid-based linear interpolator over a 3D rectilinear grid.
GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, Double[,,], ExtrapolationMode)	Creates a grid-based linear interpolator over a 3D rectilinear grid.

GridLinearInterpolator(IReadOnlyList<IReadOnlyList<Double>>, IReadOnlyList<Double>, ExtrapolationMode)

Creates a grid-based linear interpolator over an N-dimensional rectilinear grid.

public static LinearGridSurface GridLinearInterpolator(
	IReadOnlyList<IReadOnlyList<double>> axes,
	IReadOnlyList<double> values,
	ExtrapolationMode extrapolation = ExtrapolationMode.Throw
)

Visual Basic

Public Shared Function GridLinearInterpolator ( 
	axes As IReadOnlyList(Of IReadOnlyList(Of Double)),
	values As IReadOnlyList(Of Double),
	Optional extrapolation As ExtrapolationMode = ExtrapolationMode.Throw
) As LinearGridSurface

C++/CLI

public:
static LinearGridSurface^ GridLinearInterpolator(
	IReadOnlyList<IReadOnlyList<double>^>^ axes, 
	IReadOnlyList<double>^ values, 
	ExtrapolationMode extrapolation = ExtrapolationMode::Throw
)

static member GridLinearInterpolator : 
        axes : IReadOnlyList<IReadOnlyList<float>> * 
        values : IReadOnlyList<float> * 
        ?extrapolation : ExtrapolationMode 
(* Defaults:
        let _extrapolation = defaultArg extrapolation ExtrapolationMode.Throw
*)
-> LinearGridSurface

Parameters

axes IReadOnlyList<IReadOnlyList<Double>>: The coordinate vectors for each dimension.
values IReadOnlyList<Double>: The grid values in flat, row-major storage.
extrapolation ExtrapolationMode (Optional): The extrapolation mode for out-of-range coordinates.

Return Value

LinearGridSurface
A LinearGridSurface that performs multilinear grid interpolation.

Exceptions

ArgumentNullException	axes or values is null.
ArgumentException	The product of axis lengths does not equal the values length, or an axis has fewer than 2 points.

GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, Matrix<Double>, ExtrapolationMode)

Creates a grid-based linear interpolator over a 2D rectilinear grid.

public static LinearGridSurface GridLinearInterpolator(
	IReadOnlyList<double> xAxis,
	IReadOnlyList<double> yAxis,
	Matrix<double> values,
	ExtrapolationMode extrapolation = ExtrapolationMode.Throw
)

Visual Basic

Public Shared Function GridLinearInterpolator ( 
	xAxis As IReadOnlyList(Of Double),
	yAxis As IReadOnlyList(Of Double),
	values As Matrix(Of Double),
	Optional extrapolation As ExtrapolationMode = ExtrapolationMode.Throw
) As LinearGridSurface

C++/CLI

public:
static LinearGridSurface^ GridLinearInterpolator(
	IReadOnlyList<double>^ xAxis, 
	IReadOnlyList<double>^ yAxis, 
	Matrix<double>^ values, 
	ExtrapolationMode extrapolation = ExtrapolationMode::Throw
)

static member GridLinearInterpolator : 
        xAxis : IReadOnlyList<float> * 
        yAxis : IReadOnlyList<float> * 
        values : Matrix<float> * 
        ?extrapolation : ExtrapolationMode 
(* Defaults:
        let _extrapolation = defaultArg extrapolation ExtrapolationMode.Throw
*)
-> LinearGridSurface

Parameters

xAxis IReadOnlyList<Double>: The x-coordinates of the grid points.
yAxis IReadOnlyList<Double>: The y-coordinates of the grid points.
values Matrix<Double>: The grid values as a matrix (RowCount = xAxis.Count, ColumnCount = yAxis.Count).
extrapolation ExtrapolationMode (Optional): The extrapolation mode for out-of-range coordinates.

Return Value

LinearGridSurface
A LinearGridSurface that performs 2D bilinear interpolation.

Exceptions

ArgumentNullException	xAxis, yAxis, or values is null.
ArgumentException	Matrix dimensions do not match axis lengths, or an axis has fewer than 2 points.

GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, ExtrapolationMode)

Creates a grid-based linear interpolator over a 2D rectilinear grid.

public static LinearGridSurface GridLinearInterpolator(
	IReadOnlyList<double> xAxis,
	IReadOnlyList<double> yAxis,
	IReadOnlyList<double> values,
	ExtrapolationMode extrapolation = ExtrapolationMode.Throw
)

Visual Basic

Public Shared Function GridLinearInterpolator ( 
	xAxis As IReadOnlyList(Of Double),
	yAxis As IReadOnlyList(Of Double),
	values As IReadOnlyList(Of Double),
	Optional extrapolation As ExtrapolationMode = ExtrapolationMode.Throw
) As LinearGridSurface

C++/CLI

public:
static LinearGridSurface^ GridLinearInterpolator(
	IReadOnlyList<double>^ xAxis, 
	IReadOnlyList<double>^ yAxis, 
	IReadOnlyList<double>^ values, 
	ExtrapolationMode extrapolation = ExtrapolationMode::Throw
)

static member GridLinearInterpolator : 
        xAxis : IReadOnlyList<float> * 
        yAxis : IReadOnlyList<float> * 
        values : IReadOnlyList<float> * 
        ?extrapolation : ExtrapolationMode 
(* Defaults:
        let _extrapolation = defaultArg extrapolation ExtrapolationMode.Throw
*)
-> LinearGridSurface

Parameters

xAxis IReadOnlyList<Double>: The x-coordinates of the grid points.
yAxis IReadOnlyList<Double>: The y-coordinates of the grid points.
values IReadOnlyList<Double>: The grid values in flat, row-major storage.
extrapolation ExtrapolationMode (Optional): The extrapolation mode for out-of-range coordinates.

Return Value

LinearGridSurface
A LinearGridSurface that performs 2D bilinear interpolation.

Exceptions

ArgumentNullException	xAxis, yAxis, or values is null.
ArgumentException	The values length does not match the product of axis lengths, or an axis has fewer than 2 points.

GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, Double[,], ExtrapolationMode)

Creates a grid-based linear interpolator over a 2D rectilinear grid.

public static LinearGridSurface GridLinearInterpolator(
	IReadOnlyList<double> xAxis,
	IReadOnlyList<double> yAxis,
	double[,] values,
	ExtrapolationMode extrapolation = ExtrapolationMode.Throw
)

Visual Basic

Public Shared Function GridLinearInterpolator ( 
	xAxis As IReadOnlyList(Of Double),
	yAxis As IReadOnlyList(Of Double),
	values As Double(,),
	Optional extrapolation As ExtrapolationMode = ExtrapolationMode.Throw
) As LinearGridSurface

C++/CLI

public:
static LinearGridSurface^ GridLinearInterpolator(
	IReadOnlyList<double>^ xAxis, 
	IReadOnlyList<double>^ yAxis, 
	array<double,2>^ values, 
	ExtrapolationMode extrapolation = ExtrapolationMode::Throw
)

static member GridLinearInterpolator : 
        xAxis : IReadOnlyList<float> * 
        yAxis : IReadOnlyList<float> * 
        values : float[,] * 
        ?extrapolation : ExtrapolationMode 
(* Defaults:
        let _extrapolation = defaultArg extrapolation ExtrapolationMode.Throw
*)
-> LinearGridSurface

Parameters

xAxis IReadOnlyList<Double>: The x-coordinates of the grid points.
yAxis IReadOnlyList<Double>: The y-coordinates of the grid points.
values Double[2]: The grid values as a 2D array.
extrapolation ExtrapolationMode (Optional): The extrapolation mode for out-of-range coordinates.

Return Value

LinearGridSurface
A LinearGridSurface that performs 2D bilinear interpolation.

Remarks

Array dimension order

For the values array, the dimension order follows the order of the axis arguments.

The array must satisfy:

values.GetLength(0) == xAxis.Count
values.GetLength(1) == yAxis.Count

and values[i, j] = f(xAxis[i], yAxis[j]).

Exceptions

ArgumentNullException	xAxis, yAxis, or values is null.
ArgumentException	Array dimensions do not match axis lengths, or an axis has fewer than 2 points.

GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, ExtrapolationMode)

Creates a grid-based linear interpolator over a 3D rectilinear grid.

public static LinearGridSurface GridLinearInterpolator(
	IReadOnlyList<double> xAxis,
	IReadOnlyList<double> yAxis,
	IReadOnlyList<double> zAxis,
	IReadOnlyList<double> values,
	ExtrapolationMode extrapolation = ExtrapolationMode.Throw
)

Visual Basic

Public Shared Function GridLinearInterpolator ( 
	xAxis As IReadOnlyList(Of Double),
	yAxis As IReadOnlyList(Of Double),
	zAxis As IReadOnlyList(Of Double),
	values As IReadOnlyList(Of Double),
	Optional extrapolation As ExtrapolationMode = ExtrapolationMode.Throw
) As LinearGridSurface

C++/CLI

public:
static LinearGridSurface^ GridLinearInterpolator(
	IReadOnlyList<double>^ xAxis, 
	IReadOnlyList<double>^ yAxis, 
	IReadOnlyList<double>^ zAxis, 
	IReadOnlyList<double>^ values, 
	ExtrapolationMode extrapolation = ExtrapolationMode::Throw
)

static member GridLinearInterpolator : 
        xAxis : IReadOnlyList<float> * 
        yAxis : IReadOnlyList<float> * 
        zAxis : IReadOnlyList<float> * 
        values : IReadOnlyList<float> * 
        ?extrapolation : ExtrapolationMode 
(* Defaults:
        let _extrapolation = defaultArg extrapolation ExtrapolationMode.Throw
*)
-> LinearGridSurface

Parameters

xAxis IReadOnlyList<Double>: The x-coordinates of the grid points.
yAxis IReadOnlyList<Double>: The y-coordinates of the grid points.
zAxis IReadOnlyList<Double>: The z-coordinates of the grid points.
values IReadOnlyList<Double>: The grid values in flat, row-major storage.
extrapolation ExtrapolationMode (Optional): The extrapolation mode for out-of-range coordinates.

Return Value

LinearGridSurface
A LinearGridSurface that performs 3D trilinear interpolation.

Exceptions

ArgumentNullException	xAxis, yAxis, zAxis, or values is null.
ArgumentException	The values length does not match the product of axis lengths, or an axis has fewer than 2 points.

GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, Double[,], ExtrapolationMode)

Creates a grid-based linear interpolator over a 3D rectilinear grid.

public static LinearGridSurface GridLinearInterpolator(
	IReadOnlyList<double> xAxis,
	IReadOnlyList<double> yAxis,
	IReadOnlyList<double> zAxis,
	double[,,] values,
	ExtrapolationMode extrapolation = ExtrapolationMode.Throw
)

Visual Basic

Public Shared Function GridLinearInterpolator ( 
	xAxis As IReadOnlyList(Of Double),
	yAxis As IReadOnlyList(Of Double),
	zAxis As IReadOnlyList(Of Double),
	values As Double(,,),
	Optional extrapolation As ExtrapolationMode = ExtrapolationMode.Throw
) As LinearGridSurface

C++/CLI

public:
static LinearGridSurface^ GridLinearInterpolator(
	IReadOnlyList<double>^ xAxis, 
	IReadOnlyList<double>^ yAxis, 
	IReadOnlyList<double>^ zAxis, 
	array<double,3>^ values, 
	ExtrapolationMode extrapolation = ExtrapolationMode::Throw
)

static member GridLinearInterpolator : 
        xAxis : IReadOnlyList<float> * 
        yAxis : IReadOnlyList<float> * 
        zAxis : IReadOnlyList<float> * 
        values : float[,,] * 
        ?extrapolation : ExtrapolationMode 
(* Defaults:
        let _extrapolation = defaultArg extrapolation ExtrapolationMode.Throw
*)
-> LinearGridSurface

Parameters

xAxis IReadOnlyList<Double>: The x-coordinates of the grid points.
yAxis IReadOnlyList<Double>: The y-coordinates of the grid points.
zAxis IReadOnlyList<Double>: The z-coordinates of the grid points.
values Double[3]: The grid values as a 3D array.
extrapolation ExtrapolationMode (Optional): The extrapolation mode for out-of-range coordinates.

Return Value

LinearGridSurface
A LinearGridSurface that performs 3D trilinear interpolation.

Remarks

Array dimension order

For the values array, the dimension order follows the order of the axis arguments.

The array must satisfy:

values.GetLength(0) == xAxis.Count
values.GetLength(1) == yAxis.Count
values.GetLength(2) == zAxis.Count

and values[i, j, k] = f(xAxis[i], yAxis[j], zAxis[k]).

Exceptions

ArgumentNullException	xAxis, yAxis, zAxis, or values is null.
ArgumentException	Array dimensions do not match axis lengths, or an axis has fewer than 2 points.

Interpolation.GridLinearInterpolator Method

Definition

Overload List

GridLinearInterpolator(IReadOnlyList<IReadOnlyList<Double>>, IReadOnlyList<Double>, ExtrapolationMode)

Parameters

Return Value

Exceptions

GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, Matrix<Double>, ExtrapolationMode)

Parameters

Return Value

Exceptions

GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, ExtrapolationMode)

Parameters

Return Value

Exceptions

GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, Double[,], ExtrapolationMode)

Parameters

Return Value

Remarks

Exceptions

GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, ExtrapolationMode)

Parameters

Return Value

Exceptions

GridLinearInterpolator(IReadOnlyList<Double>, IReadOnlyList<Double>, IReadOnlyList<Double>, Double[,], ExtrapolationMode)

Parameters

Return Value

Remarks

Exceptions

See Also

Reference