MOOCHO (Single Doxygen Collection) Version of the Day
Public Member Functions
ConstrainedOptPack::MeritFuncCalc Class Reference

Abstract iterface for n-D merit functions {abstract}. More...

#include <ConstrainedOptPack_MeritFuncCalc.hpp>

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

List of all members.

Public Member Functions

virtual ~MeritFuncCalc ()
 
virtual value_type operator() (const Vector &x) const =0
 Return the value of the merit function at x.
virtual value_type deriv () const =0
 Calls value(d_k) on aggregate merit_func.
virtual void print_merit_func (std::ostream &out, const std::string &leading_str) const =0
 Print what this merit function is.

Detailed Description

Abstract iterface for n-D merit functions {abstract}.

Used to compute the value of the merit at a point x (phi(x)) and to retrieve the derivative (phi.deriv()) along some direction d from some base point xo.

Definition at line 55 of file ConstrainedOptPack_MeritFuncCalc.hpp.


Constructor & Destructor Documentation

virtual ConstrainedOptPack::MeritFuncCalc::~MeritFuncCalc ( ) [inline, virtual]

Definition at line 59 of file ConstrainedOptPack_MeritFuncCalc.hpp.


Member Function Documentation

virtual value_type ConstrainedOptPack::MeritFuncCalc::operator() ( const Vector x) const [pure virtual]

Return the value of the merit function at x.

Implemented in ConstrainedOptPack::MeritFuncCalcNLE, and ConstrainedOptPack::MeritFuncCalcNLP.

virtual value_type ConstrainedOptPack::MeritFuncCalc::deriv ( ) const [pure virtual]

Calls value(d_k) on aggregate merit_func.

Implemented in ConstrainedOptPack::MeritFuncCalcNLE, and ConstrainedOptPack::MeritFuncCalcNLP.

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

Print what this merit function is.

Implemented in ConstrainedOptPack::MeritFuncCalcNLE, and ConstrainedOptPack::MeritFuncCalcNLP.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines