til::DerivativeEstimator< TFunctor > Class Template Reference

First derivative estimator of a monodimensional functional. More...

#include <cathier/minTools.h>

Public Types
typedef TFunctor::argument_type	input_prec
typedef TFunctor::result_type	output_prec

Public Member Functions
	DerivativeEstimator (TFunctor functor)
void	setDelta (input_prec delta)
const input_prec &	delta () const
output_prec	operator() (input_prec x)
	Estimate gradient at position x by computing ( f(x+delta) - f(x-delta) )/ (2*delta) More...

Detailed Description

template<typename TFunctor>
class til::DerivativeEstimator< TFunctor >

First derivative estimator of a monodimensional functional.

NB: Works only for real functions. TODO: could it be elegantly generalized other (e.g. complex) functions?

Definition at line 577 of file minTools.h.

Member Typedef Documentation

input_prec

template<typename TFunctor >

typedef TFunctor::argument_type til::DerivativeEstimator< TFunctor >::input_prec

Definition at line 580 of file minTools.h.

output_prec

template<typename TFunctor >

typedef TFunctor::result_type til::DerivativeEstimator< TFunctor >::output_prec

Definition at line 581 of file minTools.h.

Constructor & Destructor Documentation

DerivativeEstimator()

template<typename TFunctor >

til::DerivativeEstimator< TFunctor >::DerivativeEstimator ( TFunctor  functor )

inline

Definition at line 583 of file minTools.h.

Member Function Documentation

delta()

template<typename TFunctor >

const input_prec& til::DerivativeEstimator< TFunctor >::delta ( ) const

inline

Definition at line 594 of file minTools.h.

operator()()

template<typename TFunctor >

output_prec til::DerivativeEstimator< TFunctor >::operator() ( input_prec  x )

inline

Estimate gradient at position x by computing ( f(x+delta) - f(x-delta) )/ (2*delta)

Definition at line 598 of file minTools.h.

setDelta()

template<typename TFunctor >

void til::DerivativeEstimator< TFunctor >::setDelta ( input_prec  delta )

inline

Definition at line 587 of file minTools.h.

---

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

• cathier/minTools.h