Click or drag to resize

TabulatedFunction Class

Class TabulatedFunction is an abstract class representing a function determined by tabulated values.
Inheritance Hierarchy

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.4
Syntax
public abstract class TabulatedFunction : OneVariableFunction

The TabulatedFunction type exposes the following members.

Constructors
  NameDescription
Protected methodTabulatedFunction
Default constructor. Constructs a TabulatedFunction instance with no x and y values.
Protected methodTabulatedFunction(DoubleVector, DoubleVector)
Constructs an instance of TabulatedFunction 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 propertyNumberOfTabulatedValues
Gets the number of tabulated values.
Top
Methods
  NameDescription
Public methodClone
Creates a deep copy of this function.
(Inherited from OneVariableFunction.)
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.)
Public methodGetX
Returns the value of the tabulated independent values at the specified index.
Public methodGetXs
Gets the x, or independent, values represented by this function.
Public methodGetXVector
Gets the x, or independent, values represented by this function.
Public methodGetY
Returns the value of the tabulated dependent values at the specified index.
Public methodGetYs
Gets the y, or dependent, values represented by this function.
Public methodGetYVector
Gets the y, or dependent, values represented by this function.
Public methodIntegrate
Computes the integral of the current function over the specified interval.
(Inherited from OneVariableFunction.)
Protected methodProcessTabulatedValues
ProcessTabulatedValues is called anytime there is a change to the tabulated values.
Public methodSetTabulatedValues(DoubleVector, DoubleVector)
Changes the values of the tabulated function.
Public methodSetTabulatedValues(Int32, Double, Double)
Set the values of the tabulated point at the specified index to the specified value.
Public methodSetTabulatedValues(Range, DoubleVector, DoubleVector)
Sets the the tabulated point values in the specifed range to the specified values.
Public methodSetX(Int32, Double)
Sets the value of the independent tabulated value at the specified index to the specified value.
Public methodSetX(Range, DoubleVector)
Sets the the tabulated independent values in the specifed range to the specified values.
Public methodSetY(Int32, Double)
Sets the value of the dependent tabulated value at the specified index to the specified value.
Public methodSetY(Range, DoubleVector)
Sets the the tabulated dependent values in the specifed range to the specified values.
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.
Protected fieldyi_
Tabulated dependent function values.
Top
Remarks
The TabulatedFunction base class manages the vectors of x and y that specify the tabulated values of the independent and dependent variables, respectively.
Deriving classes must specify a delegate function of type Func<double, double> for the instance variable function_ in the base class OneVariableFunction. This delegate computes and returns values for arbitrary x based on the tabulated values. In addition, deriving classes may override the virtual method ProcessTabulatedValues. This method is invoked by TabulatedFunction instances whenever the tabulated values are changed.
See Also