ROL
ROL_NonlinearCG_U.hpp
Go to the documentation of this file.
1// @HEADER
2// ************************************************************************
3//
4// Rapid Optimization Library (ROL) Package
5// Copyright (2014) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact lead developers:
38// Drew Kouri (dpkouri@sandia.gov) and
39// Denis Ridzal (dridzal@sandia.gov)
40//
41// ************************************************************************
42// @HEADER
43
44#ifndef ROL_NONLINEARCG_U_H
45#define ROL_NONLINEARCG_U_H
46
48#include "ROL_Types.hpp"
49#include "ROL_NonlinearCG.hpp"
50
58
59namespace ROL {
60
61template<typename Real>
62class NonlinearCG_U : public DescentDirection_U<Real> {
63private:
64
65 Ptr<NonlinearCG<Real>> nlcg_;
67 std::string ncgName_;
68
69public:
70
80 NonlinearCG_U( ParameterList &parlist,
81 const Ptr<NonlinearCG<Real>> &nlcg = nullPtr)
83 // Initialize secant object
84 ParameterList& Llist = parlist.sublist("Step").sublist("Line Search");
85 if ( nlcg == nullPtr ) {
86 ncgName_ = Llist.sublist("Descent Method").get("Nonlinear CG Type","Oren-Luenberger");
87 enlcg_
89 nlcg_ = ROL::makePtr<NonlinearCG<Real>>(enlcg_);
90 }
91 else {
92 ncgName_ = Llist.sublist("Descent Method").get("User Defined Nonlinear CG Name",
93 "Unspecified User Define Nonlinear CG Method");
94 }
95 }
96
97 void compute( Vector<Real> &s, Real &snorm, Real &sdotg, int &iter, int &flag,
98 const Vector<Real> &x, const Vector<Real> &g, Objective<Real> &obj) override {
99 nlcg_->run(s,g,x,obj);
100 //sdotg = -s.dot(g.dual());
101 sdotg = -s.apply(g);
102 if (sdotg >= static_cast<Real>(0)) {
103 s.set(g.dual());
104 //sdotg = -s.dot(g.dual());
105 sdotg = -s.apply(g);
106 }
107 s.scale(static_cast<Real>(-1));
108 snorm = s.norm();
109 iter = 0;
110 flag = 0;
111 }
112
113 std::string printName(void) const override {
114 std::stringstream name;
115 name << ncgName_ << " Nonlinear CG";
116 return name.str();
117 }
118}; // class ROL::NonlinearCG_U
119
120} // namespace ROL
121
122#endif
Contains definitions of custom data types in ROL.
Provides the interface to compute unconstrained optimization steps for line search.
Provides the interface to compute optimization steps with nonlinear CG.
NonlinearCG_U(ParameterList &parlist, const Ptr< NonlinearCG< Real > > &nlcg=nullPtr)
Constructor.
Ptr< NonlinearCG< Real > > nlcg_
NonlinearCG object (used for quasi-Newton)
void compute(Vector< Real > &s, Real &snorm, Real &sdotg, int &iter, int &flag, const Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj) override
std::string printName(void) const override
Provides the interface to evaluate objective functions.
Defines the linear algebra or vector space interface.
virtual Real apply(const Vector< Real > &x) const
Apply to a dual vector. This is equivalent to the call .
virtual Real norm() const =0
Returns where .
virtual void set(const Vector &x)
Set where .
virtual void scale(const Real alpha)=0
Compute where .
virtual const Vector & dual() const
Return dual representation of , for example, the result of applying a Riesz map, or change of basis,...
ENonlinearCG
@ NONLINEARCG_USERDEFINED
ENonlinearCG StringToENonlinearCG(std::string s)