GlobiPack  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
GlobiPack_ArmijoPolyInterpLineSearch_decl.hpp
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // GlobiPack: Collection of Scalar 1D globalizaton utilities
6 // Copyright (2009) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 #ifndef GLOBIPACK_POLY_INTERP_LINE_SEARCH_DECL_HPP
45 #define GLOBIPACK_POLY_INTERP_LINE_SEARCH_DECL_HPP
46 
47 
48 #include "GlobiPack_LineSearchBase.hpp"
49 #include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
50 
51 
52 namespace GlobiPack {
53 
54 
63 template<typename Scalar>
65  : public LineSearchBase<Scalar>,
67 {
68 public:
69 
72 
75 
77  Scalar eta() const;
79  Scalar minFrac() const;
81  Scalar maxFrac() const;
83  int minIters() const;
85  int maxIters() const;
87  bool doMaxIters() const;
88 
90 
93 
95  void setParameterList(RCP<ParameterList> const& paramList);
98 
100 
103 
105  virtual bool requiresBaseDeriv() const;
106 
108  virtual bool requiresDerivEvals() const;
109 
111  virtual bool doLineSearch(
112  const MeritFunc1DBase<Scalar> &phi,
113  const PointEval1D<Scalar> &point_k,
114  const Ptr<PointEval1D<Scalar> > &point_kp1,
115  const Ptr<int> &numIters
116  ) const;
117 
119 
120 private:
121 
122  // //////////////////////
123  // Private data members
124 
125  Scalar eta_;
126  Scalar minFrac_;
127  Scalar maxFrac_;
128  int minIters_;
129  int maxIters_;
130  bool doMaxIters_;
131 
132 };
133 
134 
139 template<typename Scalar>
141 {
143 }
144 
145 
146 // Default values are exposed here for unit testing purposes
147 
148 
149 namespace ArmijoPolyInterpLineSearchUtils {
150 
151 
152 const std::string eta_name = "Armijo Slope Fraction";
153 const double eta_default = 1.0e-4;
154 
155 const std::string minFrac_name = "Min Backtrack Fraction";
156 const double minFrac_default = 0.1;
157 
158 const std::string maxFrac_name = "Max Backtrack Fraction";
159 const double maxFrac_default = 0.5;
160 
161 const std::string minIters_name = "Min Num Iterations";
162 const int minIters_default = 0;
163 
164 const std::string maxIters_name = "Max Num Iterations";
165 const int maxIters_default = 20;
166 
167 const std::string doMaxIters_name = "Do Max Iterations";
168 const bool doMaxIters_default = false;
169 
170 
171 } // namespace ArmijoPolyInterpLineSearchUtils
172 
173 
174 
175 } // namespace GlobiPack
176 
177 
178 #endif // GLOBIPACK_POLY_INTERP_LINE_SEARCH_DECL_HPP
Linesearch subclass implementing a backtracking-only line search using an Armijo cord test condition ...
virtual bool doLineSearch(const MeritFunc1DBase< Scalar > &phi, const PointEval1D< Scalar > &point_k, const Ptr< PointEval1D< Scalar > > &point_kp1, const Ptr< int > &numIters) const
Represents the evaluation point of the merit function phi(alpha) and/or is derivative Dphi(alpha)...
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Base class for 1D linearsearch algorithms.
void setParameterList(RCP< ParameterList > const &paramList)
ArmijoPolyInterpLineSearch()
Construct with default parameters.
Base class for 1D merit fucntions used in globalization methods.
const RCP< ArmijoPolyInterpLineSearch< Scalar > > armijoQuadraticLineSearch()
Nonmember constructor.