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

Abstract interface for a strategy object that will compute a step that will improve feasibility (at least descent) {abstract}. More...

#include <MoochoPack_FeasibilityStep_Strategy.hpp>

Inheritance diagram for MoochoPack::FeasibilityStep_Strategy:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~FeasibilityStep_Strategy ()
 
virtual bool compute_feasibility_step (std::ostream &out, EJournalOutputLevel olevel, NLPAlgo *algo, NLPAlgoState *s, const Vector &xo, const Vector &c_xo, VectorMutable *w)=0
 Compute a step that improves feasibility (at least locally).
virtual void print_step (std::ostream &out, const std::string &leading_str) const =0
 This function will print a description of the computations and logic used.

Detailed Description

Abstract interface for a strategy object that will compute a step that will improve feasibility (at least descent) {abstract}.

Definition at line 52 of file MoochoPack_FeasibilityStep_Strategy.hpp.


Constructor & Destructor Documentation

virtual MoochoPack::FeasibilityStep_Strategy::~FeasibilityStep_Strategy ( ) [inline, virtual]

Definition at line 56 of file MoochoPack_FeasibilityStep_Strategy.hpp.


Member Function Documentation

virtual bool MoochoPack::FeasibilityStep_Strategy::compute_feasibility_step ( std::ostream &  out,
EJournalOutputLevel  olevel,
NLPAlgo algo,
NLPAlgoState s,
const Vector xo,
const Vector c_xo,
VectorMutable *  w 
) [pure virtual]

Compute a step that improves feasibility (at least locally).

This function will compute a step w that satisfies:

d_bounds_k.l <= xo + w - x_k <= d_bounds_k.u

and gives descent for ||c(xo + beta*w)|| for at least small beta > 0. This norm ||.|| could be any valid norm and the implementation is free to define what descent means any way it would like. Any information being used in the algorithm can be used to compute this step.

Parameters:
out[out] Output stream journal data is written to.
olevel[in] Output level for printing to #out#
algo[in/out] The NLPAlgo object. This object can be queryed for information.
s[in/out] NLPAlgoState object. May be queried or modified if needed.
xo[in] Base point vector (size n) xo.
c_xo[in] c(xo).
w[out] Computed step vector (size n) w. Must not be NULL.
Returns:
Returns true if a step that reduces feasibility subject to the bounds could be found and false otherwise.

Implemented in MoochoPack::FeasibilityStepReducedStd_Strategy.

virtual void MoochoPack::FeasibilityStep_Strategy::print_step ( std::ostream &  out,
const std::string &  leading_str 
) const [pure virtual]

This function will print a description of the computations and logic used.

Implemented in MoochoPack::FeasibilityStepReducedStd_Strategy.


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