afl::Derivator_2 Class Reference

#include <derivator_2.h>

Inheritance diagram for afl::Derivator_2:

List of all members.

Public Member Functions
	Derivator_2 (const Field *field, const Parameters &params)
	Derivator_2 (const Field *field, const Point &delta)
virtual Derivative	derivative (const Point &x) const
virtual void	toXML (std::ostream &doc) const
virtual Derivator *	clone ()
virtual const std::string &	getMethod () const
Static Protected Attributes
static const std::string	_method

---

Detailed Description

class Derivator_2 Approximates the derivative of a field

---

Constructor & Destructor Documentation

afl::Derivator_2::Derivator_2 (  const Field *  field, const Parameters &  params )

constructor Parameters: field  the field to act approximate derivatives on params  parameters that this derivator accepts in name-value pairs. This object accepts "delta-x", "delta-y" and floating point numbers that tell how far from the point p to poll the field to find the derivatives Exceptions: ddf::InvalidArgumentException  if delta is 0 along a required axis

afl::Derivator_2::Derivator_2 (  const Field *  field, const Point &  delta )

constructor Parameters: field  the field to act approximate derivatives on delta  a small distance along the axis to sample the field and use in approximation Exceptions: ddf::InvalidArgumentException  if delta is 0 along a required axis

---

Member Function Documentation

virtual Derivator* afl::Derivator_2::clone (   )  [virtual]

Returns: a true copy of the object. The object becomes the responsibility of the calling function Implements afl::Derivator.

virtual Derivative afl::Derivator_2::derivative (  const Point &  x  )  const [virtual]

Parameters: x  the location to approximate a derivative at Returns: the derivative at x Implements afl::Derivator.

virtual const std::string& afl::Derivator_2::getMethod (   )  const [virtual]

Returns: the name of the method this derivator implements Implements afl::Derivator.

virtual void afl::Derivator_2::toXML (  std::ostream &  doc  )  const [virtual]

represents the derivator for an FRL document Parameters: doc  the output stream that the xml will be appended to Implements afl::Derivator.

---

Member Data Documentation

const std::string afl::Derivator_2::_method [static, protected]

Attributes:

---

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

• derivator_2.h

---