ROL
ROL_TypeG_InteriorPointAlgorithm.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_TYPEG_INTERIORPOINTALGORITHM_H
11#define ROL_TYPEG_INTERIORPOINTALGORITHM_H
12
15#include "ROL_Secant.hpp"
16
20
21namespace ROL {
22namespace TypeG {
23
24template<typename Real>
26private:
27 const Ptr<Secant<Real>> secant_;
28
29 Real mumin_;
30 Real mumax_;
31 Real rho_;
33 Real kappaD_;
34 Real gtol_;
35 Real ctol_;
36 Real stol_;
41
42 ROL::ParameterList list_;
44
45 std::string stepname_;
46
47 bool print_;
50
52
53 using TypeG::Algorithm<Real>::status_;
54 using TypeG::Algorithm<Real>::state_;
55 using TypeG::Algorithm<Real>::proj_;
56
58 const Vector<Real> &g,
59 const Vector<Real> &l,
60 const Vector<Real> &c,
64 Vector<Real> &pwa,
65 Vector<Real> &dwa,
66 std::ostream &outStream = std::cout);
67
68 void updateState(const Vector<Real> &x,
69 const Vector<Real> &l,
73 Vector<Real> &pwa,
74 Vector<Real> &dwa,
75 std::ostream &outStream = std::cout);
76public:
77
78 InteriorPointAlgorithm(ParameterList &list, const Ptr<Secant<Real>> &secant_ = nullPtr);
79
80 using TypeG::Algorithm<Real>::run;
81 void run( Vector<Real> &x,
82 const Vector<Real> &g,
83 Objective<Real> &obj,
85 Constraint<Real> &econ,
86 Vector<Real> &emul,
87 const Vector<Real> &eres,
88 std::ostream &outStream = std::cout) override;
89
90 void writeHeader( std::ostream& os ) const override;
91
92 void writeName( std::ostream& os ) const override;
93
94 void writeOutput( std::ostream& os, const bool print_header = false ) const override;
95
96}; // class ROL::TypeG::InteriorPointAlgorithm
97
98} // namespace TypeG
99} // namespace ROL
100
102
103#endif
Provides the interface to apply upper and lower bound constraints.
Defines the general constraint operator interface.
Provides the interface to evaluate objective functions.
Provides interface for and implements limited-memory secant operators.
Provides an interface to run general constrained optimization algorithms.
const Ptr< CombinedStatusTest< Real > > status_
Ptr< PolyhedralProjection< Real > > proj_
const Ptr< AlgorithmState< Real > > state_
InteriorPointAlgorithm(ParameterList &list, const Ptr< Secant< Real > > &secant_=nullPtr)
void updateState(const Vector< Real > &x, const Vector< Real > &l, InteriorPointObjective< Real > &ipobj, BoundConstraint< Real > &bnd, Constraint< Real > &con, Vector< Real > &pwa, Vector< Real > &dwa, std::ostream &outStream=std::cout)
void writeName(std::ostream &os) const override
Print step name.
void writeHeader(std::ostream &os) const override
Print iterate header.
void writeOutput(std::ostream &os, const bool print_header=false) const override
Print iterate status.
void run(Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &econ, Vector< Real > &emul, const Vector< Real > &eres, std::ostream &outStream=std::cout) override
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface.
void initialize(Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &l, const Vector< Real > &c, InteriorPointObjective< Real > &ipobj, BoundConstraint< Real > &bnd, Constraint< Real > &con, Vector< Real > &pwa, Vector< Real > &dwa, std::ostream &outStream=std::cout)
Defines the linear algebra or vector space interface.