Function Class Reference

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

#include <Differentiator.h>

Inheritance diagram for Function:
GradientFunction JacobianFunction ScalarFunction

List of all members.

Public Member Functions

FunctionsetNFunctions (int)
FunctionsetNParameters (int)
FunctionsetEstimatedAccuracy (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

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

Real getEstimatedAccuracy (  )  const
long getNCalls (  )  const
long getNFailures (  )  const
int getNFunctions (  )  const
int getNParameters (  )  const
void resetAllStatistics (  ) 
Function& setEstimatedAccuracy ( Real   ) 
Function& setNFunctions ( int   ) 
Function& setNParameters ( int   ) 

Friends And Related Function Documentation

friend class Differentiator [friend]

Member Data Documentation

FunctionRep* rep [protected]

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

Generated by  doxygen 1.6.2