This abstract class defines a function to be differentiated (repeatedly) by a Differentiator object. More...
Inheritance diagram for SimTK::Differentiator::Function:
Public Member Functions | |
| Function & | setNumFunctions (int) |
| Function & | setNumParameters (int) |
| Function & | setEstimatedAccuracy (Real) |
| int | getNumFunctions () const |
| int | getNumParameters () const |
| Real | getEstimatedAccuracy () const |
| void | resetAllStatistics () |
| int | getNumCalls () const |
| int | getNumFailures () const |
Protected Member Functions | |
| Function () | |
| ~Function () | |
Protected Attributes | |
| FunctionRep * | rep |
Friends | |
| class | Differentiator |
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.
Constructor & Destructor Documentation
◆ Function()
|
protected |
◆ ~Function()
|
protected |
Member Function Documentation
◆ setNumFunctions()
| Function& SimTK::Differentiator::Function::setNumFunctions | ( | int | ) |
◆ setNumParameters()
| Function& SimTK::Differentiator::Function::setNumParameters | ( | int | ) |
◆ setEstimatedAccuracy()
◆ getNumFunctions()
| int SimTK::Differentiator::Function::getNumFunctions | ( | ) | const |
◆ getNumParameters()
| int SimTK::Differentiator::Function::getNumParameters | ( | ) | const |
◆ getEstimatedAccuracy()
| Real SimTK::Differentiator::Function::getEstimatedAccuracy | ( | ) | const |
◆ resetAllStatistics()
| void SimTK::Differentiator::Function::resetAllStatistics | ( | ) |
◆ getNumCalls()
| int SimTK::Differentiator::Function::getNumCalls | ( | ) | const |
◆ getNumFailures()
| int SimTK::Differentiator::Function::getNumFailures | ( | ) | const |
Friends And Related Function Documentation
◆ Differentiator
|
friend |
Member Data Documentation
◆ rep
|
protected |
The documentation for this class was generated from the following file:
