ROL_TypeU_LineSearchAlgorithm.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_TYPEU_LINESEARCHALGORITHM_H
#define ROL_TYPEU_LINESEARCHALGORITHM_H
 
#include "ROL_TypeU_Algorithm.hpp"
#include "ROL_LineSearch_U_Types.hpp"
#include "ROL_DescentDirection_U.hpp"
#include "ROL_LineSearch_U.hpp"
#include "ROL_Secant.hpp"
 
namespace ROL {
namespace TypeU {
 
template <class Real>
class LineSearchAlgorithm : public Algorithm<Real> {
private:
 
  Ptr<DescentDirection_U<Real>> desc_;       
  Ptr<LineSearch_U<Real>>       lineSearch_; 
 
  EDescentU            edesc_; 
  ELineSearchU         els_;   
  ECurvatureConditionU econd_; 
 
  bool acceptLastAlpha_;  
 
  bool usePreviousAlpha_; 
 
  int verbosity_;
  bool printHeader_;
  int ls_nfval_, ls_ngrad_;
  int SPflag_, SPiter_;
 
  std::string lineSearchName_, descentName_;
 
  using Algorithm<Real>::state_;
  using Algorithm<Real>::status_;
  using Algorithm<Real>::initialize;
 
public:
  LineSearchAlgorithm( ParameterList &parlist,
                       const Ptr<Secant<Real>> &secant = nullPtr,
                       const Ptr<DescentDirection_U<Real>> &descent = nullPtr,
                       const Ptr<LineSearch_U<Real>> &lineSearch = nullPtr );
 
  void initialize(const Vector<Real> &x, const Vector<Real> &g,
                  Objective<Real> &obj, std::ostream &outStream = std::cout);
 
  using TypeU::Algorithm<Real>::run;
  void run( Vector<Real>       &x,
            const Vector<Real> &g, 
            Objective<Real>    &obj,
            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 print_header = false ) const override;
 
}; // class ROL::TypeU::LineSearchAlgorithm
 
} // namespace TypeU
} // namespace ROL
 
#include "ROL_TypeU_LineSearchAlgorithm_Def.hpp"
 
#endif