aimstil  5.0.5
til::GradientDescent< TFunctor, TGradFunctor, TLineMin > Class Template Reference

Gradient descent minimization. More...

#include <cathier/minTools.h>

Inheritance diagram for til::GradientDescent< TFunctor, TGradFunctor, TLineMin >:
Collaboration diagram for til::GradientDescent< TFunctor, TGradFunctor, TLineMin >:

Public Types

typedef detail::IterativeGradMininizationAlgorithm_basis< TFunctor, TGradFunctor > Basis
 
typedef Basis::input_type input_type
 
typedef Basis::input_prec input_prec
 
typedef Basis::output_prec output_prec
 
- Public Types inherited from til::detail::IterativeGradMininizationAlgorithm_basis< TFunctor, TGradFunctor >
typedef IterativeMininizationAlgorithm_basis< TFunctor > Basis
 
typedef Basis::input_type input_type
 
typedef Basis::input_prec input_prec
 
typedef Basis::output_prec output_prec
 
- Public Types inherited from til::detail::IterativeMininizationAlgorithm_basis< TFunctor >
typedef TFunctor::argument_type input_type
 
typedef value_type_of< input_type >::type input_prec
 
typedef TFunctor::result_type output_prec
 

Public Member Functions

 GradientDescent (TFunctor functor, TGradFunctor gradfunctor, TLineMin linemin)
 
input_type operator() (input_type p)
 
- Public Member Functions inherited from til::detail::IterativeGradMininizationAlgorithm_basis< TFunctor, TGradFunctor >
 IterativeGradMininizationAlgorithm_basis (TFunctor functor, TGradFunctor dfunctor)
 
TGradFunctor & dfunctor ()
 
TGradFunctor const & dfunctor () const
 
- Public Member Functions inherited from til::detail::IterativeMininizationAlgorithm_basis< TFunctor >
 IterativeMininizationAlgorithm_basis (TFunctor functor)
 
output_precftol ()
 
output_prec const & ftol () const
 
unsigned int & maxIter ()
 
unsigned int const & maxIter () const
 
unsigned int & nIter ()
 
unsigned int const & nIter () const
 
TFunctor & functor ()
 
TFunctor const & functor () const
 
input_precmin_step ()
 
input_prec const & min_step () const
 

Detailed Description

template<typename TFunctor, typename TGradFunctor, typename TLineMin = LineMin<TFunctor>>
class til::GradientDescent< TFunctor, TGradFunctor, TLineMin >

Gradient descent minimization.

Definition at line 686 of file minTools.h.

Member Typedef Documentation

◆ Basis

template<typename TFunctor , typename TGradFunctor , typename TLineMin = LineMin<TFunctor>>
typedef detail::IterativeGradMininizationAlgorithm_basis<TFunctor, TGradFunctor> til::GradientDescent< TFunctor, TGradFunctor, TLineMin >::Basis

Definition at line 691 of file minTools.h.

◆ input_prec

template<typename TFunctor , typename TGradFunctor , typename TLineMin = LineMin<TFunctor>>
typedef Basis::input_prec til::GradientDescent< TFunctor, TGradFunctor, TLineMin >::input_prec

Definition at line 693 of file minTools.h.

◆ input_type

template<typename TFunctor , typename TGradFunctor , typename TLineMin = LineMin<TFunctor>>
typedef Basis::input_type til::GradientDescent< TFunctor, TGradFunctor, TLineMin >::input_type

Definition at line 692 of file minTools.h.

◆ output_prec

template<typename TFunctor , typename TGradFunctor , typename TLineMin = LineMin<TFunctor>>
typedef Basis::output_prec til::GradientDescent< TFunctor, TGradFunctor, TLineMin >::output_prec

Definition at line 694 of file minTools.h.

Constructor & Destructor Documentation

◆ GradientDescent()

template<typename TFunctor , typename TGradFunctor , typename TLineMin = LineMin<TFunctor>>
til::GradientDescent< TFunctor, TGradFunctor, TLineMin >::GradientDescent ( TFunctor  functor,
TGradFunctor  gradfunctor,
TLineMin  linemin 
)

Member Function Documentation

◆ operator()()

template<typename TFunctor , typename TGradFunctor , typename TLineMin = LineMin<TFunctor>>
input_type til::GradientDescent< TFunctor, TGradFunctor, TLineMin >::operator() ( input_type  p)

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