ROL
ROL_TypeE_FletcherAlgorithm.hpp
Go to the documentation of this file.
1// @HEADER
2// *****************************************************************************
3// Rapid Optimization Library (ROL) Package
4//
5// Copyright 2014 NTESS and the ROL contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef ROL_TYPEE_FLETCHERALGORITHM_H
11#define ROL_TYPEE_FLETCHERALGORITHM_H
12
15#include "ROL_Secant.hpp"
16
22namespace ROL {
23namespace TypeE {
24
25template<typename Real>
26class FletcherAlgorithm : public TypeE::Algorithm<Real> {
27private:
28
29 const Ptr<Secant<Real>> secant_;
30 ParameterList list_;
31 std::string subStep_;
32 // Penalty function data
39 // Verbosity flag
42
43 using TypeE::Algorithm<Real>::state_;
44 using TypeE::Algorithm<Real>::status_;
45
46public:
47
48 FletcherAlgorithm(ParameterList &list, const Ptr<Secant<Real>> &secant = nullPtr);
49
50 void initialize( Vector<Real> &x,
51 const Vector<Real> &g,
52 const Vector<Real> &l,
53 const Vector<Real> &c,
56 std::ostream &outStream);
57
58 using TypeE::Algorithm<Real>::run;
59 virtual void run( Vector<Real> &x,
60 const Vector<Real> &g,
61 Objective<Real> &obj,
62 Constraint<Real> &econ,
63 Vector<Real> &emul,
64 const Vector<Real> &eres,
65 std::ostream &outStream = std::cout) override;
66
67 virtual void writeHeader( std::ostream& os ) const override;
68
69 virtual void writeName( std::ostream& os ) const override;
70
71 virtual void writeOutput( std::ostream& os, const bool print_header = false ) const override;
72
73}; // class ROL::TypeE::FletcherAlgorithm
74
75} // namespace TypeE
76} // namespace ROL
77
79
80#endif
Defines the general constraint operator interface.
Provides the interface to evaluate objective functions.
Provides interface for and implements limited-memory secant operators.
const Ptr< AlgorithmState< Real > > state_
const Ptr< CombinedStatusTest< Real > > status_
Provides an interface to run equality constrained optimization algorithms using Fletcher's exact pena...
virtual void writeName(std::ostream &os) const override
Print step name.
virtual void writeHeader(std::ostream &os) const override
Print iterate header.
virtual void run(Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, const Vector< Real > &eres, std::ostream &outStream=std::cout) override
Run algorithm on equality constrained problems (Type-E). This general interface supports the use of d...
virtual void writeOutput(std::ostream &os, const bool print_header=false) const override
Print iterate status.
void initialize(Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &l, const Vector< Real > &c, FletcherObjectiveE< Real > &fobj, Constraint< Real > &con, std::ostream &outStream)
Defines the linear algebra or vector space interface.