ROL_TypeU_TrustRegionAlgorithm.hpp

Go to the documentation of this file.

// @HEADER
// ************************************************************************
//
//               Rapid Optimization Library (ROL) Package
//                 Copyright (2014) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact lead developers:
//              Drew Kouri   (dpkouri@sandia.gov) and
//              Denis Ridzal (dridzal@sandia.gov)
//
// ************************************************************************
// @HEADER

#ifndef ROL_TYPEU_TRUSTREGIONALGORITHM_H
#define ROL_TYPEU_TRUSTREGIONALGORITHM_H

#include "ROL_TypeU_Algorithm.hpp"
#include "ROL_TrustRegion_U_Types.hpp"
#include "ROL_TrustRegion_U.hpp"
#include "ROL_TrustRegionUtilities.hpp"
#include "ROL_Secant.hpp"

namespace ROL {
namespace TypeU {

template<typename Real>
class TrustRegionAlgorithm : public Algorithm<Real> {
private:
  // TRUST REGION INFORMATION
  Ptr<TrustRegion_U<Real>>      solver_; 
  Ptr<TrustRegionModel_U<Real>> model_;  
  ETrustRegionU                 etr_;    
  Real                          delMax_; 
  Real                          eta0_;   
  Real                          eta1_;   
  Real                          eta2_;   
  Real                          gamma0_; 
  Real                          gamma1_; 
  Real                          gamma2_; 
  Real                          TRsafe_; 
  Real                          eps_;    
  TRUtils::ETRFlag              TRflag_; 
  int                           SPflag_; 
  int                           SPiter_; 

  // NONMONOTONE INFORMATION
  bool useNM_;
  int  NMstorage_;

  // SECANT INFORMATION
  ESecant esec_; 
  bool useSecantPrecond_;
  bool useSecantHessVec_;

  // INEXACT COMPUTATION PARAMETERS
  std::vector<bool> useInexact_; 
  Real              scale0_;     
  Real              scale1_;     
  Real scale_, omega_, force_, forceFactor_;
  int updateIter_;
  Real gtol_;

  // VERBOSITY SETTING
  int verbosity_;    
  bool printHeader_; 

  using Algorithm<Real>::state_;
  using Algorithm<Real>::status_;
  using Algorithm<Real>::initialize;

public:

  TrustRegionAlgorithm( ParameterList &parlist,
    const Ptr<Secant<Real>> &secant = nullPtr );

  using 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;

private:

  void initialize(const Vector<Real> &x, const Vector<Real> &g, Vector<Real> &Bg,
                  Objective<Real> &obj, std::ostream &outStream = std::cout);

  Real computeValue(const Vector<Real> &x, Objective<Real> &obj, Real pRed);

  void computeGradient(const Vector<Real> &x, Objective<Real> &obj, bool accept);

}; // class ROL::TrustRegionAlgorithm
} // namespace TypeU
} // namespace ROL

#include "ROL_TypeU_TrustRegionAlgorithm_Def.hpp"

#endif