Differentiator::GradientFunction Class Reference
#include <Differentiator.h>
Inheritance diagram for Differentiator::GradientFunction:
Detailed Description
Derive a concrete class from this one if you have a scalar function of multiple variables that you want to differentiate.This is the typical form for an optimization objective function, for example.
Public Types | |
| typedef int(* | FuncWrapper )(const GradientFunction &, const Vector &, Real &) |
Public Member Functions | |
| virtual int | f (const Vector &y, Real &fy) const =0 |
Protected Member Functions | |
| GradientFunction (int ny=-1, Real acc=-1) | |
| virtual | ~GradientFunction () |
Member Typedef Documentation
| typedef int(* FuncWrapper)(const GradientFunction &, const Vector &, Real &) |
Constructor & Destructor Documentation
| GradientFunction | ( | int | ny = -1, |
|
| Real | acc = -1 | |||
| ) | [inline, explicit, protected] |
| virtual ~GradientFunction | ( | ) | [inline, protected, virtual] |
Member Function Documentation
| virtual int f | ( | const Vector & | y, | |
| Real & | fy | |||
| ) | const [pure virtual] |
The documentation for this class was generated from the following file:
