Interpolation.Nearest Method

Performs nearest-neighbor interpolation at a single point.

Definition

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

public static double Nearest(
	double[] xValues,
	double[] yValues,
	double x,
	OutOfRangeMode outOfRangeMode = OutOfRangeMode.Throw,
	double fillValue = NaN
)

Visual Basic

Public Shared Function Nearest ( 
	xValues As Double(),
	yValues As Double(),
	x As Double,
	Optional outOfRangeMode As OutOfRangeMode = OutOfRangeMode.Throw,
	Optional fillValue As Double = NaN
) As Double

C++/CLI

public:
static double Nearest(
	array<double>^ xValues, 
	array<double>^ yValues, 
	double x, 
	OutOfRangeMode outOfRangeMode = OutOfRangeMode::Throw, 
	double fillValue = NaN
)

static member Nearest : 
        xValues : float[] * 
        yValues : float[] * 
        x : float * 
        ?outOfRangeMode : OutOfRangeMode * 
        ?fillValue : float 
(* Defaults:
        let _outOfRangeMode = defaultArg outOfRangeMode OutOfRangeMode.Throw
        let _fillValue = defaultArg fillValue NaN
*)
-> float

Parameters

xValues Double[]: The x-coordinates of the data points. Must be strictly increasing.
yValues Double[]: The y-coordinates of the data points.
x Double: The x-coordinate at which to interpolate.
outOfRangeMode OutOfRangeMode (Optional): Specifies how to handle x-values outside the interpolation range.
fillValue Double (Optional): The value to return when outOfRangeMode is Fill and x is out of range.

Return Value

Double
The y-value of the nearest data point to x.

Remarks

This method returns the y-value of the data point whose x-coordinate is closest to x. In case of a tie, the point with the smaller index is selected.

This method performs no allocations and is suitable for single-point evaluation.

Exceptions

ArgumentNullException	xValues or yValues is null.
DimensionMismatchException	The lengths of xValues and yValues do not match.
ArgumentException	xValues does not have at least 1 element, or the values in xValues are not strictly increasing.
ArgumentOutOfRangeException	x is outside the interpolation range and outOfRangeMode is Throw.