Click or drag to resize

ClampedCubicSpline Class

Class ClampedCubicSpline represents a function determined by tabulated values. Function values are calculated using clamped cubic spline interpolation.
Inheritance Hierarchy

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.4
Syntax
public class ClampedCubicSpline : CubicSpline

The ClampedCubicSpline type exposes the following members.

Constructors
  NameDescription
Public methodClampedCubicSpline
Default constructor.
Public methodClampedCubicSpline(DoubleVector, DoubleVector, Double, Double)
Constructs an instance of NaturalCubicSpline for the given paired vectors of x- and y-values.
Top
Properties
  NameDescription
Public propertyDifferentiator
Gets and sets the differentiation method object associated with this function.
(Inherited from OneVariableFunction.)
Public propertyFunc
Gets the function encapsulated by this object.
(Inherited from OneVariableFunction.)
Public propertyIntegrator
Gets and sets the integration method object associated with this function.
(Inherited from OneVariableFunction.)
Public propertyLeftEndSlope
Gets and sets the desired value of the slope at the left endpoint.
Public propertyNumberOfTabulatedValues
Gets the number of tabulated values.
(Inherited from TabulatedFunction.)
Public propertyRightEndSlope
Gets and sets the desired value of the slope at the right endpoint.
Public propertySecondDerivativeAtControlPoints
The second derivative at each control point of the cubic spline.
(Inherited from CubicSpline.)
Public propertyYDoublePrime
Returns the second derivative.
Top
Methods
  NameDescription
Public methodClone
Creates a deep copy of this clamped cubic spline.
(Overrides OneVariableFunctionClone.)
Protected methodCoreEvaluate
(Inherited from CubicSpline.)
Public methodDerivative
Returns the first derivative of this function.
(Inherited from OneVariableFunction.)
Public methodDifferentiate
Computes the numerical derivative of the current function at the given x-value.
(Inherited from OneVariableFunction.)
Public methodEvaluate(Double)
Evaluates the current function at the given x-value.
(Inherited from OneVariableFunction.)
Public methodEvaluate(DoubleVector)
Evaluates the current function at the given set of x-values.
(Inherited from OneVariableFunction.)
Public methodEvaluate(OneVariableFunction)
Creates a composite function.
(Inherited from OneVariableFunction.)
Protected methodEvaluateWithCubicSpline
(Inherited from CubicSpline.)
Public methodGetX
Returns the value of the tabulated independent values at the specified index.
(Inherited from TabulatedFunction.)
Public methodGetXs
Gets the x, or independent, values represented by this function.
(Inherited from TabulatedFunction.)
Public methodGetXVector
Gets the x, or independent, values represented by this function.
(Inherited from TabulatedFunction.)
Public methodGetY
Returns the value of the tabulated dependent values at the specified index.
(Inherited from TabulatedFunction.)
Public methodGetYs
Gets the y, or dependent, values represented by this function.
(Inherited from TabulatedFunction.)
Public methodGetYVector
Gets the y, or dependent, values represented by this function.
(Inherited from TabulatedFunction.)
Public methodIntegrate
Computes the integral of the current function over the specified interval.
(Inherited from OneVariableFunction.)
Protected methodLinearInterpolation
Handles the case when there are exactly two tabulated points.
(Overrides CubicSplineLinearInterpolation(Double).)
Public methodOnDeserialized
processing following deserialization
Protected methodParabolicInterpolation
Handles the case when there are exactly three tabulated points.
(Overrides CubicSplineParabolicInterpolation(Double).)
Protected methodProcessTabulatedValues
Calculates the values for the second derivatives. From "Numerical Recipes" section 3.3
(Overrides TabulatedFunctionProcessTabulatedValues.)
Public methodSetEndSlopes
Specifies the required slopes at the left and right endpoints.
Public methodSetTabulatedValues(DoubleVector, DoubleVector)
Changes the values of the tabulated function.
(Inherited from TabulatedFunction.)
Public methodSetTabulatedValues(Int32, Double, Double)
Set the values of the tabulated point at the specified index to the specified value.
(Inherited from TabulatedFunction.)
Public methodSetTabulatedValues(Range, DoubleVector, DoubleVector)
Sets the the tabulated point values in the specifed range to the specified values.
(Inherited from TabulatedFunction.)
Public methodSetX(Int32, Double)
Sets the value of the independent tabulated value at the specified index to the specified value.
(Inherited from TabulatedFunction.)
Public methodSetX(Range, DoubleVector)
Sets the the tabulated independent values in the specifed range to the specified values.
(Inherited from TabulatedFunction.)
Public methodSetY(Int32, Double)
Sets the value of the dependent tabulated value at the specified index to the specified value.
(Inherited from TabulatedFunction.)
Public methodSetY(Range, DoubleVector)
Sets the the tabulated dependent values in the specifed range to the specified values.
(Inherited from TabulatedFunction.)
Top
Fields
  NameDescription
Protected fielddifferentiator_
Differentiator
(Inherited from OneVariableFunction.)
Protected fieldfunction_
Captured function
(Inherited from OneVariableFunction.)
Protected fieldintegrator_
Integrator
(Inherited from OneVariableFunction.)
Protected fieldxi_
Tabulated independent function values.
(Inherited from TabulatedFunction.)
Protected fieldyDoublePrime_
(Inherited from CubicSpline.)
Protected fieldyi_
Tabulated dependent function values.
(Inherited from TabulatedFunction.)
Top
Remarks
The clamped cubic spline is a cubic spline where the derivative of the interpolating function is specified at the left and right endpoints.
Evaluating x-values outside the range of tabulated values uses the last fitted cubic, or a linear extrapolation in the case of only 2 or 3 tabulated values.
See Also