aimstil  5.0.5
Public Types | Public Member Functions | List of all members
til::GradientEstimator< TFunctor > Class Template Reference

Gradient estimator of a multidimensional functional. More...

#include <cathier/minTools.h>

Public Types

typedef TFunctor::argument_type input_type
 
typedef value_type_of< input_type >::type input_prec
 
typedef TFunctor::result_type output_prec
 

Public Member Functions

 GradientEstimator (TFunctor functor, input_prec delta)
 
void setDelta (input_prec delta)
 
const input_prec & delta () const
 
void operator() (input_type p, input_type &grad)
 

Detailed Description

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

Gradient estimator of a multidimensional functional.

Definition at line 617 of file minTools.h.

Member Typedef Documentation

◆ input_prec

template<typename TFunctor >
typedef value_type_of<input_type>::type til::GradientEstimator< TFunctor >::input_prec

Definition at line 622 of file minTools.h.

◆ input_type

template<typename TFunctor >
typedef TFunctor::argument_type til::GradientEstimator< TFunctor >::input_type

Definition at line 621 of file minTools.h.

◆ output_prec

template<typename TFunctor >
typedef TFunctor::result_type til::GradientEstimator< TFunctor >::output_prec

Definition at line 623 of file minTools.h.

Constructor & Destructor Documentation

◆ GradientEstimator()

template<typename TFunctor >
til::GradientEstimator< TFunctor >::GradientEstimator ( TFunctor  functor,
input_prec  delta 
)
inline

Definition at line 628 of file minTools.h.

Member Function Documentation

◆ delta()

template<typename TFunctor >
const input_prec& til::GradientEstimator< TFunctor >::delta ( ) const
inline

Definition at line 644 of file minTools.h.

◆ operator()()

template<typename TFunctor >
void til::GradientEstimator< TFunctor >::operator() ( input_type  p,
input_type &  grad 
)
inline

Definition at line 648 of file minTools.h.

◆ setDelta()

template<typename TFunctor >
void til::GradientEstimator< TFunctor >::setDelta ( input_prec  delta)
inline

Definition at line 637 of file minTools.h.

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