GradientCenteredDifference< N, Functor, T > Class Template Reference
[Gradient with the Centered Difference Scheme]

The numerical gradient of a functor. More...

#include <centered_difference.h>

List of all members.

Public Types

typedef Functor function_type
 The function to differentiate.
typedef base_type::argument_type argument_type
 The argument type.
typedef base_type::result_type result_type
 The result type.

Public Member Functions

 GradientCenteredDifference (const function_type &f, const number_type delta=std::pow(std::numeric_limits< T >::epsilon(), 1.0/3.0))
 Construct from the functor.
 GradientCenteredDifference (const GradientCenteredDifference &x)
 Copy constructor.
void operator() (const argument_type x, result_type &deriv) const
 Calculate the gradient of f at x.
result_type operator() (const argument_type x) const
 Return the gradient of f at x.
number_type delta () const
 Return the differencing offset.
void set_delta (const number_type delta)
 Set the differencing offset.

Detailed Description

template<int N, class Functor, typename T = typename Functor::argument_type::value_type>
class GradientCenteredDifference< N, Functor, T >

The numerical gradient of a functor.


The documentation for this class was generated from the following file:
Generated on Thu Jun 30 02:15:00 2016 for Numerical Algorithms Package by  doxygen 1.6.3