mpqc::math::Optimizer< Real, Params > Class Template Reference
Collaboration diagram for mpqc::math::Optimizer< Real, Params >:

Documentation

template<typename Real, typename Params>
class mpqc::math::Optimizer< Real, Params >

It is itself a Function, namely Function<Params, std::tuple<>>.

Optimizer<Real, Params> seeks stationary points of TaylorExpansionFunction<Real, Params>

Public Types

typedef TaylorExpansionFunction< Real, Params > function_type
 
- Public Types inherited from mpqc::math::Function< Params, std::tuple<> >
typedef Params value_type
 
typedef std::tuple<> parameters_type
 
using Timestampable = ::mpqc::utility::Timestampable< X >
 
- Public Types inherited from mpqc::DescribedClass
typedef std::shared_ptr< DescribedClass >(* keyval_ctor_wrapper_type) (const KeyVal &)
 

Public Member Functions

 Optimizer (const KeyVal &kv)
 
std::shared_ptr< function_typefunction () const
 
double precision () const
 
- Public Member Functions inherited from mpqc::math::Function< Params, std::tuple<> >
 Function ()=default
 
 Function (std::shared_ptr< std::tuple<> > params)
 
virtual ~Function ()
 
std::shared_ptr< const Params > value ()
 
bool must_compute () const
 
std::shared_ptr< const std::tuple<> > params () const
 
virtual void set_params (std::shared_ptr< std::tuple<> > params)
 
- Public Member Functions inherited from mpqc::DescribedClass
 DescribedClass ()=default
 
virtual ~DescribedClass ()
 
std::string class_key () const
 
- Public Member Functions inherited from mpqc::enable_shared_from_this< DescribedClass >
virtual ~enable_shared_from_this ()=default
 
std::shared_ptr< DescribedClassshared_from_this ()
 returns the pointer to this object More...
 
std::shared_ptr< std::add_const_t< DescribedClass > > shared_from_this () const
 returns the pointer to this object More...
 
- Public Member Functions inherited from mpqc::detail::virt_base_of_enable_shared_from_this
virtual ~virt_base_of_enable_shared_from_this ()=default
 
bool shared_from_this_possible () const
 
template<typename Target , typename = std::enable_if_t<!std::is_const_v<Target>>>
std::shared_ptr< Target > cast_shared_from_this_to ()
 returns the pointer to this cast to a particular type More...
 
template<typename Target >
std::shared_ptr< std::add_const_t< Target > > cast_shared_from_this_to () const
 returns the pointer to this cast to a particular type More...
 

Additional Inherited Members

- Static Public Member Functions inherited from mpqc::DescribedClass
static keyval_ctor_wrapper_type type_to_keyval_ctor (const std::string &type_name)
 
template<typename T >
static void register_keyval_ctor ()
 
template<typename T >
static bool is_registered ()
 
template<typename T >
static std::string class_key ()
 
static const keyval_ctor_registry_type & keyval_ctor_registry ()
 returns const ref to the keyval ctor registry More...
 
- Protected Member Functions inherited from mpqc::math::Function< Params, std::tuple<> >
const Timestampable< Params > & get_value () const
 
void set_value (Params v)
 
virtual void compute ()=0
 evaluates value , implemented by the derived class More...
 

Member Typedef Documentation

◆ function_type

template<typename Real , typename Params >
typedef TaylorExpansionFunction<Real, Params> mpqc::math::Optimizer< Real, Params >::function_type

Constructor & Destructor Documentation

◆ Optimizer()

template<typename Real , typename Params >
mpqc::math::Optimizer< Real, Params >::Optimizer ( const KeyVal kv)
inline

Member Function Documentation

◆ function()

template<typename Real , typename Params >
std::shared_ptr<function_type> mpqc::math::Optimizer< Real, Params >::function ( ) const
inline

◆ precision()

template<typename Real , typename Params >
double mpqc::math::Optimizer< Real, Params >::precision ( ) const
inline

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