NMath Reference Guide

## Tabulated |

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

Inheritance Hierarchy

SystemObject

CenterSpace.NMath.CoreOneVariableFunction

CenterSpace.NMath.CoreTabulatedFunction

CenterSpace.NMath.CoreCubicSpline

CenterSpace.NMath.CoreLinearSpline

CenterSpace.NMath.CoreSmoothCubicSpline

CenterSpace.NMath.CoreOneVariableFunction

CenterSpace.NMath.CoreTabulatedFunction

CenterSpace.NMath.CoreCubicSpline

CenterSpace.NMath.CoreLinearSpline

CenterSpace.NMath.CoreSmoothCubicSpline

Syntax

The TabulatedFunction type exposes the following members.

Constructors

Name | Description | |
---|---|---|

TabulatedFunction | Default constructor. Constructs a TabulatedFunction instance with no x and y values. | |

TabulatedFunction(DoubleVector, DoubleVector) | Constructs an instance of TabulatedFunction for the given paired vectors of x- and y-values. |

Properties

Name | Description | |
---|---|---|

Differentiator |
Gets and sets the differentiation method object associated with this function.
(Inherited from OneVariableFunction) | |

Func |
Gets the function encapsulated by this object.
(Inherited from OneVariableFunction) | |

Integrator |
Gets and sets the integration method object associated with this function.
(Inherited from OneVariableFunction) | |

NumberOfTabulatedValues | Gets the number of tabulated values. |

Methods

Name | Description | |
---|---|---|

Clone |
Creates a deep copy of this function.
(Inherited from OneVariableFunction) | |

Derivative |
Returns the first derivative of this function.
(Inherited from OneVariableFunction) | |

Differentiate |
Computes the numerical derivative of the current function at the given
x-value.
(Inherited from OneVariableFunction) | |

Evaluate(Double) |
Evaluates the current function at the given x-value.
(Inherited from OneVariableFunction) | |

Evaluate(DoubleVector) |
Evaluates the current function at the given set of x-values.
(Inherited from OneVariableFunction) | |

Evaluate(OneVariableFunction) |
Creates a composite function.
(Inherited from OneVariableFunction) | |

GetX | Returns the value of the tabulated independent values at the specified index. | |

GetXs | Gets the x, or independent, values represented by this function. | |

GetXVector | Gets the x, or independent, values represented by this function. | |

GetY | Returns the value of the tabulated dependent values at the specified index. | |

GetYs | Gets the y, or dependent, values represented by this function. | |

GetYVector | Gets the y, or dependent, values represented by this function. | |

Integrate |
Computes the integral of the current function over the specified
interval.
(Inherited from OneVariableFunction) | |

ProcessTabulatedValues | ProcessTabulatedValues is called anytime there is a change to the tabulated values. | |

SetTabulatedValues(DoubleVector, DoubleVector) | Changes the values of the tabulated function. | |

SetTabulatedValues(Int32, Double, Double) | Set the values of the tabulated point at the specified index to the specified value. | |

SetTabulatedValues(Range, DoubleVector, DoubleVector) | Sets the the tabulated point values in the specifed range to the specified values. | |

SetX(Int32, Double) | Sets the value of the independent tabulated value at the specified index to the specified value. | |

SetX(Range, DoubleVector) | Sets the the tabulated independent values in the specifed range to the specified values. | |

SetY(Int32, Double) | Sets the value of the dependent tabulated value at the specified index to the specified value. | |

SetY(Range, DoubleVector) | Sets the the tabulated dependent values in the specifed range to the specified values. |

Fields

Name | Description | |
---|---|---|

differentiator_ | Differentiator (Inherited from OneVariableFunction) | |

function_ | Captured function (Inherited from OneVariableFunction) | |

integrator_ | Integrator (Inherited from OneVariableFunction) | |

xi_ | Tabulated independent function values. | |

yi_ | Tabulated dependent function values. |

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.

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