MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
ConstrainedOptPack::MeritFuncCalc1D Class Referenceabstract

Abstracts a 1D merit function {abstract}. More...

#include <ConstrainedOptPack_MeritFuncCalc1D.hpp>

Inheritance diagram for ConstrainedOptPack::MeritFuncCalc1D:
Inheritance graph
[legend]

Public Member Functions

virtual ~MeritFuncCalc1D ()
 
virtual value_type operator() (value_type alpha) const =0
 Return the value of the merit function at alpha. More...
 
virtual value_type deriv () const =0
 Return the derivative of the merit function at alpha = 0. More...
 
virtual void print_merit_func (std::ostream &out, const std::string &leading_str) const =0
 Print the particular merit function. More...
 

Detailed Description

Abstracts a 1D merit function {abstract}.

This is the interface that line search algorithms use to compute the value of the merit function at alpha (phi(alpha)) and to retrieve the initial descent derivative of the merit function (using deriv()).

Definition at line 56 of file ConstrainedOptPack_MeritFuncCalc1D.hpp.

Constructor & Destructor Documentation

virtual ConstrainedOptPack::MeritFuncCalc1D::~MeritFuncCalc1D ( )
inlinevirtual

Definition at line 60 of file ConstrainedOptPack_MeritFuncCalc1D.hpp.

Member Function Documentation

virtual value_type ConstrainedOptPack::MeritFuncCalc1D::operator() ( value_type  alpha) const
pure virtual

Return the value of the merit function at alpha.

Implemented in ConstrainedOptPack::MeritFuncCalc1DQuadratic.

virtual value_type ConstrainedOptPack::MeritFuncCalc1D::deriv ( ) const
pure virtual

Return the derivative of the merit function at alpha = 0.

Implemented in ConstrainedOptPack::MeritFuncCalc1DQuadratic.

virtual void ConstrainedOptPack::MeritFuncCalc1D::print_merit_func ( std::ostream &  out,
const std::string &  leading_str 
) const
pure virtual

Print the particular merit function.

Implemented in ConstrainedOptPack::MeritFuncCalc1DQuadratic.


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