ROL_TypeB_InteriorPointAlgorithm.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//               Rapid Optimization Library (ROL) Package
//
// Copyright 2014 NTESS and the ROL contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef ROL_TYPEB_INTERIORPOINTALGORITHM_HPP
#define ROL_TYPEB_INTERIORPOINTALGORITHM_HPP
 
#include "ROL_TypeB_Algorithm.hpp"
#include "ROL_InteriorPointObjective.hpp"
#include "ROL_Secant.hpp"

 
namespace ROL {
namespace TypeB {
 
template<typename Real>
class InteriorPointAlgorithm : public TypeB::Algorithm<Real> {
private:
  const Ptr<Secant<Real>> secant_;
 
  Real mumin_;
  Real mumax_;
  Real rho_;
  bool useLinearDamping_;
  Real kappaD_;
  Real gtol_;
  Real stol_;
  Real gtolrate_;
  Real mingtol_;
 
  ROL::ParameterList list_;
  int subproblemIter_;
 
  std::string stepname_;
 
  bool print_;
  int verbosity_;
  bool writeHeader_;
 
  bool hasPolyProj_;
 
  using TypeB::Algorithm<Real>::status_;
  using TypeB::Algorithm<Real>::state_;
  using TypeB::Algorithm<Real>::proj_;
 
  void initialize(Vector<Real>                 &x,
                  const Vector<Real>           &g,
                  InteriorPointObjective<Real> &ipobj,
                  BoundConstraint<Real>        &bnd,
                  Vector<Real>                 &pwa,
                  std::ostream &outStream = std::cout); 
 
  void updateState(const Vector<Real>           &x,
                   InteriorPointObjective<Real> &ipobj,
                   BoundConstraint<Real>        &bnd,
                   Vector<Real>                 &pwa,
                   std::ostream &outStream = std::cout);
public:
 
  InteriorPointAlgorithm(ParameterList &list, const Ptr<Secant<Real>> &secant = nullPtr);
 
  using TypeB::Algorithm<Real>::run;
  void run( Vector<Real>          &x,
            const Vector<Real>    &g, 
            Objective<Real>       &obj,
            BoundConstraint<Real> &bnd,
            std::ostream          &outStream = std::cout) override;
 
  void writeHeader( std::ostream& os ) const override;
 
  void writeName( std::ostream& os ) const override;
 
  void writeOutput( std::ostream& os, const bool write_header = false ) const override;
 
}; // class ROL::TypeB::InteriorPointAlgorithm
 
} // namespace TypeB
} // namespace ROL
 
#include "ROL_TypeB_InteriorPointAlgorithm_Def.hpp"
 
#endif