SimTK::Differentiator::Function Class Reference

This abstract class defines a function to be differentiated (repeatedly) by a Differentiator object. More...

#include <Differentiator.h>

Inheritance diagram for SimTK::Differentiator::Function:

List of all members.

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

SimTK::Differentiator::Function::Function

(

)

[protected]

SimTK::Differentiator::Function::~Function

(

)

[protected]

---

Member Function Documentation

Function& SimTK::Differentiator::Function::setNumFunctions

(

int

)

Function& SimTK::Differentiator::Function::setNumParameters

(

int

)

Function& SimTK::Differentiator::Function::setEstimatedAccuracy

(

Real

)

int SimTK::Differentiator::Function::getNumFunctions

(

)

const

int SimTK::Differentiator::Function::getNumParameters

(

)

const

Real SimTK::Differentiator::Function::getEstimatedAccuracy

(

)

const

void SimTK::Differentiator::Function::resetAllStatistics

(

)

int SimTK::Differentiator::Function::getNumCalls

(

)

const

int SimTK::Differentiator::Function::getNumFailures

(

)

const

---

Friends And Related Function Documentation

friend class Differentiator [friend]

---

Member Data Documentation

FunctionRep* SimTK::Differentiator::Function::rep [protected]

---

The documentation for this class was generated from the following file:

• Differentiator.h