CubicSpline Constructor

Definition

Namespace: Numerics.NET.Curves
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4

Overload List

CubicSpline(IList<Point>)	Constructs the natural cubic spline through a set of points.
CubicSpline(Double[], Double[])	Constructs the natural cubic spline through a set of points. Obsolete.
CubicSpline(IList<Point>, CubicSplineKind)	Constructs the natural cubic spline through a set of points.
CubicSpline(IList<Point>, IList<Double>)	Constructs the cubic Hermite spline through a set of points.
CubicSpline(IList<Double>, IList<Double>)	Constructs the natural cubic spline through a set of points.
CubicSpline(ReadOnlySpan<Double>, ReadOnlySpan<Double>)	Constructs the natural cubic spline through a set of points.
CubicSpline(Double[], Double[], CubicSplineKind)	Constructs a natural or Akima cubic spline through a set of points.
CubicSpline(Double[], Double[], Double[])	Constructs the cubic Hermite spline through a set of points. Obsolete.
CubicSpline(IList<Point>, Double, IList<Double>)	Constructs a cubic smoothing spline with the specified smoothing parameter.
CubicSpline(IList<Point>, Double, Double)	Constructs a clamped cubic spline through a set of points.
CubicSpline(IList<Double>, IList<Double>, CubicSplineKind)	Constructs the natural cubic spline through a set of points.
CubicSpline(IList<Double>, IList<Double>, IList<Double>)	Constructs the cubic Hermite spline through a set of points.
CubicSpline(ReadOnlySpan<Double>, ReadOnlySpan<Double>, ReadOnlySpan<Double>)	Constructs the cubic Hermite spline through a set of points.
CubicSpline(Double[], Double[], Double, Double)	Constructs a clamped cubic spline through a set of points.
CubicSpline(IList<Double>, IList<Double>, Double, IList<Double>)	Constructs a cubic smoothing spline with the specified smoothing parameter.
CubicSpline(IList<Double>, IList<Double>, Double, Double)	Constructs a clamped cubic spline through a set of points.

CubicSpline(IList<Point>)

Constructs the natural cubic spline through a set of points.

public CubicSpline(
	IList<Point> dataPoints
)

Visual Basic

Public Sub New ( 
	dataPoints As IList(Of Point)
)

C++/CLI

public:
CubicSpline(
	IList<Point>^ dataPoints
)

new : 
        dataPoints : IList<Point> -> CubicSpline

Parameters

dataPoints IList<Point>: An array of Point values containing the data points.

Remarks

This constructor constructs a natural cubic spline. This means that the second derivative of the curve at the end points is zero.

Exceptions

ArgumentNullException

dataPoints is null.

CubicSpline(Double[], Double[])

Note: This API is now obsolete.

Constructs the natural cubic spline through a set of points.

[ObsoleteAttribute("Use the constructor that uses spans instead.")]
public CubicSpline(
	double[] xValues,
	double[] yValues
)

Visual Basic

<ObsoleteAttribute("Use the constructor that uses spans instead.")>
Public Sub New ( 
	xValues As Double(),
	yValues As Double()
)

C++/CLI

public:
[ObsoleteAttribute(L"Use the constructor that uses spans instead.")]
CubicSpline(
	array<double>^ xValues, 
	array<double>^ yValues
)

[<ObsoleteAttribute("Use the constructor that uses spans instead.")>]
new : 
        xValues : float[] * 
        yValues : float[] -> CubicSpline

Parameters

xValues Double[]: A Double array containing the x-values of the data points.
yValues Double[]: A Double array containing the y-values corresponding to the values in xValues.

Remarks

This constructor constructs a natural cubic spline. This means that the second derivative of the curve at the end points is zero.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

DimensionMismatchException

The length of xValues does not equal the length of yValues.

CubicSpline(IList<Point>, CubicSplineKind)

Constructs the natural cubic spline through a set of points.

public CubicSpline(
	IList<Point> dataPoints,
	CubicSplineKind kind
)

Visual Basic

Public Sub New ( 
	dataPoints As IList(Of Point),
	kind As CubicSplineKind
)

C++/CLI

public:
CubicSpline(
	IList<Point>^ dataPoints, 
	CubicSplineKind kind
)

new : 
        dataPoints : IList<Point> * 
        kind : CubicSplineKind -> CubicSpline

Parameters

dataPoints IList<Point>: An array of Point values containing the data points.
kind CubicSplineKind: A CubicSplineKind value that specifies the kind of spline to construct.

Remarks

This constructor constructs either a natural cubic spline or an Akima spline. Any other values for the kind parameter produce an InvalidOperationException.

Exceptions

ArgumentNullException

dataPoints is null.

CubicSpline(IList<Point>, IList<Double>)

Constructs the cubic Hermite spline through a set of points.

public CubicSpline(
	IList<Point> dataPoints,
	IList<double> yPrimeValues
)

Visual Basic

Public Sub New ( 
	dataPoints As IList(Of Point),
	yPrimeValues As IList(Of Double)
)

C++/CLI

public:
CubicSpline(
	IList<Point>^ dataPoints, 
	IList<double>^ yPrimeValues
)

new : 
        dataPoints : IList<Point> * 
        yPrimeValues : IList<float> -> CubicSpline

Parameters

dataPoints IList<Point>: An array of Point values containing the data points.
yPrimeValues IList<Double>: A Double array containing the slopes of the curve corresponding to the values in dataPoints.

Remarks

This constructor constructs a cubic Hermite spline which has the specified first derivatives at the data points.

Exceptions

ArgumentNullException

dataPoints is null.

-or-

yPrimeValues is null.

CubicSpline(IList<Double>, IList<Double>)

Constructs the natural cubic spline through a set of points.

public CubicSpline(
	IList<double> xValues,
	IList<double> yValues
)

Visual Basic

Public Sub New ( 
	xValues As IList(Of Double),
	yValues As IList(Of Double)
)

C++/CLI

public:
CubicSpline(
	IList<double>^ xValues, 
	IList<double>^ yValues
)

new : 
        xValues : IList<float> * 
        yValues : IList<float> -> CubicSpline

Parameters

xValues IList<Double>: A list of doubles containing the x-values of the data points.
yValues IList<Double>: A list of doubles containing the y-values corresponding to the values in xValues.

Remarks

This constructor constructs a natural cubic spline. This means that the second derivative of the curve at the end points is zero.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

DimensionMismatchException

The length of xValues does not equal the length of yValues.

CubicSpline(ReadOnlySpan<Double>, ReadOnlySpan<Double>)

Constructs the natural cubic spline through a set of points.

public CubicSpline(
	ReadOnlySpan<double> xValues,
	ReadOnlySpan<double> yValues
)

Visual Basic

Public Sub New ( 
	xValues As ReadOnlySpan(Of Double),
	yValues As ReadOnlySpan(Of Double)
)

C++/CLI

public:
CubicSpline(
	ReadOnlySpan<double> xValues, 
	ReadOnlySpan<double> yValues
)

new : 
        xValues : ReadOnlySpan<float> * 
        yValues : ReadOnlySpan<float> -> CubicSpline

Parameters

xValues ReadOnlySpan<Double>: A read-only span containing the x-values of the data points.
yValues ReadOnlySpan<Double>: A read-only span containing the y-values corresponding to the values in xValues.

Remarks

This constructor constructs a natural cubic spline. This means that the second derivative of the curve at the end points is zero.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

DimensionMismatchException

The length of xValues does not equal the length of yValues.

CubicSpline(Double[], Double[], CubicSplineKind)

Constructs a natural or Akima cubic spline through a set of points.

public CubicSpline(
	double[] xValues,
	double[] yValues,
	CubicSplineKind kind
)

Visual Basic

Public Sub New ( 
	xValues As Double(),
	yValues As Double(),
	kind As CubicSplineKind
)

C++/CLI

public:
CubicSpline(
	array<double>^ xValues, 
	array<double>^ yValues, 
	CubicSplineKind kind
)

new : 
        xValues : float[] * 
        yValues : float[] * 
        kind : CubicSplineKind -> CubicSpline

Parameters

xValues Double[]: A Double array containing the x-values of the data points.
yValues Double[]: A Double array containing the y-values corresponding to the values in xValues.
kind CubicSplineKind: A CubicSplineKind value that specifies the kind of spline to construct.

Remarks

This constructor constructs either a natural cubic spline or an Akima spline. Any other values for the kind parameter produce an InvalidOperationException.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

DimensionMismatchException

The length of xValues does not equal the length of yValues.

CubicSpline(Double[], Double[], Double[])

Note: This API is now obsolete.

Constructs the cubic Hermite spline through a set of points.

[ObsoleteAttribute("Use the constructor that uses spans instead.")]
public CubicSpline(
	double[] xValues,
	double[] yValues,
	double[] yPrimeValues
)

Visual Basic

<ObsoleteAttribute("Use the constructor that uses spans instead.")>
Public Sub New ( 
	xValues As Double(),
	yValues As Double(),
	yPrimeValues As Double()
)

C++/CLI

public:
[ObsoleteAttribute(L"Use the constructor that uses spans instead.")]
CubicSpline(
	array<double>^ xValues, 
	array<double>^ yValues, 
	array<double>^ yPrimeValues
)

[<ObsoleteAttribute("Use the constructor that uses spans instead.")>]
new : 
        xValues : float[] * 
        yValues : float[] * 
        yPrimeValues : float[] -> CubicSpline

Parameters

xValues Double[]: A Double array containing the x-values of the data points.
yValues Double[]: A Double array containing the y-values corresponding to the values in xValues.
yPrimeValues Double[]: A Double array containing the slopes of the curve corresponding to the values in xValues.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

-or-

yPrimeValues is null.

DimensionMismatchException

The length of xValues does not equal the length of yValues.

-or-

The length of xValues does not equal the length of yPrimeValues.

CubicSpline(IList<Point>, Double, IList<Double>)

Constructs a cubic smoothing spline with the specified smoothing parameter.

public CubicSpline(
	IList<Point> dataPoints,
	double smoothingParameter,
	IList<double> weights
)

Visual Basic

Public Sub New ( 
	dataPoints As IList(Of Point),
	smoothingParameter As Double,
	weights As IList(Of Double)
)

C++/CLI

public:
CubicSpline(
	IList<Point>^ dataPoints, 
	double smoothingParameter, 
	IList<double>^ weights
)

new : 
        dataPoints : IList<Point> * 
        smoothingParameter : float * 
        weights : IList<float> -> CubicSpline

Parameters

dataPoints IList<Point>: An array of Point values containing the data points.
smoothingParameter Double: The smoothing parameter.
weights IList<Double>: A vector containing the standard deviations of the y-values.

Remarks

This constructor constructs a natural cubic spline. This means that the second derivative of the curve at the end points is zero.

Exceptions

ArgumentNullException

dataPoints is null.

-or-

weights is null.

DimensionMismatchException

The length of dataPoints does not equal the length of weights.

CubicSpline(IList<Point>, Double, Double)

Constructs a clamped cubic spline through a set of points.

public CubicSpline(
	IList<Point> dataPoints,
	double leftDerivative,
	double rightDerivative
)

Visual Basic

Public Sub New ( 
	dataPoints As IList(Of Point),
	leftDerivative As Double,
	rightDerivative As Double
)

C++/CLI

public:
CubicSpline(
	IList<Point>^ dataPoints, 
	double leftDerivative, 
	double rightDerivative
)

new : 
        dataPoints : IList<Point> * 
        leftDerivative : float * 
        rightDerivative : float -> CubicSpline

Parameters

dataPoints IList<Point>: An array of Point values containing the data points.
leftDerivative Double: The value of the derivative at the leftmost data point.
rightDerivative Double: The value of the derivative at the rightmost data point.

CubicSpline(IList<Double>, IList<Double>, CubicSplineKind)

Constructs the natural cubic spline through a set of points.

public CubicSpline(
	IList<double> xValues,
	IList<double> yValues,
	CubicSplineKind kind
)

Visual Basic

Public Sub New ( 
	xValues As IList(Of Double),
	yValues As IList(Of Double),
	kind As CubicSplineKind
)

C++/CLI

public:
CubicSpline(
	IList<double>^ xValues, 
	IList<double>^ yValues, 
	CubicSplineKind kind
)

new : 
        xValues : IList<float> * 
        yValues : IList<float> * 
        kind : CubicSplineKind -> CubicSpline

Parameters

xValues IList<Double>: A list of Double values that contain the x-values of the data points.
yValues IList<Double>: A list of Double values that contain the y-values corresponding to the values in xValues.
kind CubicSplineKind: A CubicSplineKind value that specifies the kind of spline to construct.

Remarks

This constructor constructs either a natural cubic spline or an Akima spline. Any other values for the kind parameter produce an InvalidOperationException.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

DimensionMismatchException

The length of xValues does not equal the length of yValues.

CubicSpline(IList<Double>, IList<Double>, IList<Double>)

Constructs the cubic Hermite spline through a set of points.

public CubicSpline(
	IList<double> xValues,
	IList<double> yValues,
	IList<double> yPrimeValues
)

Visual Basic

Public Sub New ( 
	xValues As IList(Of Double),
	yValues As IList(Of Double),
	yPrimeValues As IList(Of Double)
)

C++/CLI

public:
CubicSpline(
	IList<double>^ xValues, 
	IList<double>^ yValues, 
	IList<double>^ yPrimeValues
)

new : 
        xValues : IList<float> * 
        yValues : IList<float> * 
        yPrimeValues : IList<float> -> CubicSpline

Parameters

xValues IList<Double>: A list of Double values that contains the x-values of the data points.
yValues IList<Double>: A list of Double values that contains the y-values corresponding to the values in xValues.
yPrimeValues IList<Double>: A vector containing the slopes of the curve corresponding to the values in xValues.

Remarks

This constructor constructs a cubic Hermite spline which has the specified first derivatives at the data points.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

DimensionMismatchException

The length of xValues does not equal the length of yValues.

-or-

The length of xValues does not equal the length of yPrimeValues.

CubicSpline(ReadOnlySpan<Double>, ReadOnlySpan<Double>, ReadOnlySpan<Double>)

Constructs the cubic Hermite spline through a set of points.

public CubicSpline(
	ReadOnlySpan<double> xValues,
	ReadOnlySpan<double> yValues,
	ReadOnlySpan<double> yPrimeValues
)

Visual Basic

Public Sub New ( 
	xValues As ReadOnlySpan(Of Double),
	yValues As ReadOnlySpan(Of Double),
	yPrimeValues As ReadOnlySpan(Of Double)
)

C++/CLI

public:
CubicSpline(
	ReadOnlySpan<double> xValues, 
	ReadOnlySpan<double> yValues, 
	ReadOnlySpan<double> yPrimeValues
)

new : 
        xValues : ReadOnlySpan<float> * 
        yValues : ReadOnlySpan<float> * 
        yPrimeValues : ReadOnlySpan<float> -> CubicSpline

Parameters

xValues ReadOnlySpan<Double>: A Double array containing the x-values of the data points.
yValues ReadOnlySpan<Double>: A Double array containing the y-values corresponding to the values in xValues.
yPrimeValues ReadOnlySpan<Double>: A Double array containing the slopes of the curve corresponding to the values in xValues.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

-or-

yPrimeValues is null.

DimensionMismatchException

The length of xValues does not equal the length of yValues.

-or-

The length of xValues does not equal the length of yPrimeValues.

CubicSpline(Double[], Double[], Double, Double)

Constructs a clamped cubic spline through a set of points.

public CubicSpline(
	double[] xValues,
	double[] yValues,
	double leftDerivative,
	double rightDerivative
)

Visual Basic

Public Sub New ( 
	xValues As Double(),
	yValues As Double(),
	leftDerivative As Double,
	rightDerivative As Double
)

C++/CLI

public:
CubicSpline(
	array<double>^ xValues, 
	array<double>^ yValues, 
	double leftDerivative, 
	double rightDerivative
)

new : 
        xValues : float[] * 
        yValues : float[] * 
        leftDerivative : float * 
        rightDerivative : float -> CubicSpline

Parameters

xValues Double[]: A Double array containing the x-values of the data points.
yValues Double[]: A Double array containing the y-values corresponding to the values in xValues.
leftDerivative Double: The value of the derivative at the leftmost data point.
rightDerivative Double: The value of the derivative at the rightmost data point.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

DimensionMismatchException

The length of xValues does not equal the length of yValues.

CubicSpline(IList<Double>, IList<Double>, Double, IList<Double>)

Constructs a cubic smoothing spline with the specified smoothing parameter.

public CubicSpline(
	IList<double> xValues,
	IList<double> yValues,
	double smoothingParameter,
	IList<double> weights
)

Visual Basic

Public Sub New ( 
	xValues As IList(Of Double),
	yValues As IList(Of Double),
	smoothingParameter As Double,
	weights As IList(Of Double)
)

C++/CLI

public:
CubicSpline(
	IList<double>^ xValues, 
	IList<double>^ yValues, 
	double smoothingParameter, 
	IList<double>^ weights
)

new : 
        xValues : IList<float> * 
        yValues : IList<float> * 
        smoothingParameter : float * 
        weights : IList<float> -> CubicSpline

Parameters

xValues IList<Double>: A list of Double values that contains the x-values of the data points.
yValues IList<Double>: A list of Double values that contains the y-values corresponding to the values in xValues.
smoothingParameter Double: The smoothing parameter.
weights IList<Double>: A vector containing the weights for the data points.

Remarks

This constructor constructs a natural cubic spline. This means that the second derivative of the curve at the end points is zero.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

-or-

weights is null.

DimensionMismatchException

The length of xValues does not equal the length of yValues.

-or-

The length of xValues does not equal the length of weights.

CubicSpline(IList<Double>, IList<Double>, Double, Double)

Constructs a clamped cubic spline through a set of points.

public CubicSpline(
	IList<double> xValues,
	IList<double> yValues,
	double leftDerivative,
	double rightDerivative
)

Visual Basic

Public Sub New ( 
	xValues As IList(Of Double),
	yValues As IList(Of Double),
	leftDerivative As Double,
	rightDerivative As Double
)

C++/CLI

public:
CubicSpline(
	IList<double>^ xValues, 
	IList<double>^ yValues, 
	double leftDerivative, 
	double rightDerivative
)

new : 
        xValues : IList<float> * 
        yValues : IList<float> * 
        leftDerivative : float * 
        rightDerivative : float -> CubicSpline

Parameters

xValues IList<Double>: A list of Double values that contains the x-values of the data points.
yValues IList<Double>: A list of Double values that contains the y-values corresponding to the values in xValues.
leftDerivative Double: The value of the derivative at the leftmost data point.
rightDerivative Double: The value of the derivative at the rightmost data point.

Exceptions

ArgumentNullException

xValues is null.

-or-

yValues is null.

CubicSpline Constructor

Definition

Overload List

CubicSpline(IList<Point>)

Parameters

Remarks

Exceptions

CubicSpline(Double[], Double[])

Parameters

Remarks

Exceptions

CubicSpline(IList<Point>, CubicSplineKind)

Parameters

Remarks

Exceptions

CubicSpline(IList<Point>, IList<Double>)

Parameters

Remarks

Exceptions

CubicSpline(IList<Double>, IList<Double>)

Parameters

Remarks

Exceptions

CubicSpline(ReadOnlySpan<Double>, ReadOnlySpan<Double>)

Parameters

Remarks

Exceptions

CubicSpline(Double[], Double[], CubicSplineKind)

Parameters

Remarks

Exceptions

CubicSpline(Double[], Double[], Double[])

Parameters

Exceptions

CubicSpline(IList<Point>, Double, IList<Double>)

Parameters

Remarks

Exceptions

CubicSpline(IList<Point>, Double, Double)

Parameters

CubicSpline(IList<Double>, IList<Double>, CubicSplineKind)

Parameters

Remarks

Exceptions

CubicSpline(IList<Double>, IList<Double>, IList<Double>)

Parameters

Remarks

Exceptions

CubicSpline(ReadOnlySpan<Double>, ReadOnlySpan<Double>, ReadOnlySpan<Double>)

Parameters

Exceptions

CubicSpline(Double[], Double[], Double, Double)

Parameters

Exceptions

CubicSpline(IList<Double>, IList<Double>, Double, IList<Double>)

Parameters

Remarks

Exceptions

CubicSpline(IList<Double>, IList<Double>, Double, Double)

Parameters

Exceptions

See Also

Reference