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

Base class for all merit functions for systems of NonLinear Equations (NLE) {abstract}. More...

#include <ConstrainedOptPack_MeritFuncNLE.hpp>

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

Classes

class  InvalidInitialization
 

Public Member Functions

virtual ~MeritFuncNLE ()
 
virtual value_type value (const Vector &c) const =0
 Return the value of the merit function at c(x). This interface requires the client to compute c(x) and pass it to this function to have the value of phi(c) calculated. More...
 
virtual value_type deriv () const =0
 Return the value of the directional derivative of the merit function w.r.t. alpha at alpha = 0. In other words compute return d(phi(c(x)))/d(alpha_k) at alpha_k = 0 where x = x_k + alpha_k * d_k. More...
 
virtual void print_merit_func (std::ostream &out, const std::string &leading_str) const =0
 Print the merit funciton. More...
 

Detailed Description

Base class for all merit functions for systems of NonLinear Equations (NLE) {abstract}.

Definition at line 53 of file ConstrainedOptPack_MeritFuncNLE.hpp.

Constructor & Destructor Documentation

virtual ConstrainedOptPack::MeritFuncNLE::~MeritFuncNLE ( )
inlinevirtual

Definition at line 61 of file ConstrainedOptPack_MeritFuncNLE.hpp.

Member Function Documentation

virtual value_type ConstrainedOptPack::MeritFuncNLE::value ( const Vector &  c) const
pure virtual

Return the value of the merit function at c(x). This interface requires the client to compute c(x) and pass it to this function to have the value of phi(c) calculated.

If the merit function has not been initialized properly then a InvalidInitialization exception will be thrown.

Implemented in ConstrainedOptPack::MeritFuncNLESqrResid.

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

Return the value of the directional derivative of the merit function w.r.t. alpha at alpha = 0. In other words compute return d(phi(c(x)))/d(alpha_k) at alpha_k = 0 where x = x_k + alpha_k * d_k.

If the merit function has not been initialized properly then a InvalidInitialization exception will be thrown.

Implemented in ConstrainedOptPack::MeritFuncNLESqrResid.

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

Print the merit funciton.

Implemented in ConstrainedOptPack::MeritFuncNLESqrResid.


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