SimTK::Differentiator::GradientFunction Class Reference

Derive a concrete class from this one if you have a scalar function of multiple variables that you want to differentiate. More...

#include <Differentiator.h>

Inheritance diagram for SimTK::Differentiator::GradientFunction:

List of all members.

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 ()

---

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.

---

Constructor & Destructor Documentation

SimTK::Differentiator::GradientFunction::GradientFunction	(	int	ny = -1,
		Real	acc = -1
	)		[explicit, protected]

virtual SimTK::Differentiator::GradientFunction::~GradientFunction

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual int SimTK::Differentiator::GradientFunction::f	(	const Vector &	y,
		Real &	fy
	)		const [pure virtual]

Implemented in SimTK::SysObjectiveFunc.

---

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

• Differentiator.h