Differentiator::Function Class Reference
#include <Differentiator.h>
Inheritance diagram for Differentiator::Function:
Detailed Description
This abstract class defines a function to be differentiated (repeatedly) by a Differentiator object.Users should not access this class directly; instead, use one of the specialized function classes ScalarFunction, GradientFunction, or JacobianFunction depending on the type of function you want to differentiate.
The Differentiator class will assume the function is calculated to about machine accuracy unless told otherwise. But if f is the result of some approximate calculation (for example, it came from another Differentiator approximation, or from numerical integration), we will need to know that in order to have a reasonable crack at calculating df.
Public Member Functions | |
| Function & | setNFunctions (int) |
| Function & | setNParameters (int) |
| Function & | setEstimatedAccuracy (Real) |
| int | getNFunctions () const |
| int | getNParameters () const |
| Real | getEstimatedAccuracy () const |
| void | resetAllStatistics () |
| long | getNCalls () const |
| long | getNFailures () const |
Protected Member Functions | |
| Function () | |
| ~Function () | |
Protected Attributes | |
| Differentiator::FunctionRep * | rep |
Friends | |
| class | Differentiator |
| class | Differentiator::FunctionRep |
Constructor & Destructor Documentation
| Function | ( | ) | [protected] |
| ~Function | ( | ) | [protected] |
Member Function Documentation
| Function& setNFunctions | ( | int | ) |
| Function& setNParameters | ( | int | ) |
| int getNFunctions | ( | ) | const |
Referenced by main().
| int getNParameters | ( | ) | const |
Referenced by main().
| Real getEstimatedAccuracy | ( | ) | const |
Referenced by main().
| void resetAllStatistics | ( | ) |
Referenced by main().
| long getNCalls | ( | ) | const |
Referenced by main().
| long getNFailures | ( | ) | const |
Referenced by main().
Friends And Related Function Documentation
friend class Differentiator [friend] |
friend class Differentiator::FunctionRep [friend] |
Member Data Documentation
Differentiator::FunctionRep* rep [protected] |
The documentation for this class was generated from the following file:
