ROL
ROL_TypeU_LineSearchAlgorithm.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_TYPEU_LINESEARCHALGORITHM_H
45#define ROL_TYPEU_LINESEARCHALGORITHM_H
46
50#include "ROL_LineSearch_U.hpp"
51
96namespace ROL {
97namespace TypeU {
98
99template <class Real>
100class LineSearchAlgorithm : public Algorithm<Real> {
101private:
102
103 Ptr<DescentDirection_U<Real>> desc_;
104 Ptr<LineSearch_U<Real>> lineSearch_;
105
109
111
113
118
120
121 using Algorithm<Real>::state_;
122 using Algorithm<Real>::status_;
123 using Algorithm<Real>::initialize;
124
125public:
137 LineSearchAlgorithm( ParameterList &parlist,
138 const Ptr<DescentDirection_U<Real>> &descent = nullPtr,
139 const Ptr<LineSearch_U<Real>> &lineSearch = nullPtr );
140
141 void initialize(const Vector<Real> &x, const Vector<Real> &g,
142 Objective<Real> &obj, std::ostream &outStream = std::cout);
143
144 void run( Vector<Real> &x,
145 const Vector<Real> &g,
146 Objective<Real> &obj,
147 std::ostream &outStream = std::cout) override;
148
149 void writeHeader( std::ostream& os ) const override;
150
151 void writeName( std::ostream& os ) const override;
152
153 void writeOutput( std::ostream& os, bool print_header = false ) const override;
154
155}; // class ROL::TypeU::LineSearchAlgorithm
156
157} // namespace TypeU
158} // namespace ROL
159
161
162#endif
Provides the interface to compute unconstrained optimization steps for line search.
Provides interface for and implements line searches.
Provides the interface to evaluate objective functions.
Provides an interface to run unconstrained optimization algorithms.
const Ptr< CombinedStatusTest< Real > > status_
const Ptr< AlgorithmState< Real > > state_
Provides an interface to run unconstrained line search algorithms.
Ptr< DescentDirection_U< Real > > desc_
Unglobalized step object.
bool acceptLastAlpha_
For backwards compatibility. When max function evaluations are reached take last step.
void writeHeader(std::ostream &os) const override
Print iterate header.
bool usePreviousAlpha_
If true, use the previously accepted step length (if any) as the new initial step length.
Ptr< LineSearch_U< Real > > lineSearch_
Line-search object.
void writeName(std::ostream &os) const override
Print step name.
EDescentU edesc_
enum determines type of descent direction
void run(Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, std::ostream &outStream=std::cout) override
Run algorithm on unconstrained problems (Type-U). This general interface supports the use of dual opt...
ELineSearchU els_
enum determines type of line search
void writeOutput(std::ostream &os, bool print_header=false) const override
Print iterate status.
void initialize(const Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, std::ostream &outStream=std::cout)
ECurvatureConditionU econd_
enum determines type of curvature condition
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:84