ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ConstrainedOptPack_DirectLineSearch_Strategy.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) 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 Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef DIRECT_LINE_SEARCH_STRATEGY_H
43 #define DIRECT_LINE_SEARCH_STRATEGY_H
44 
45 #include <stdexcept>
46 #include <iosfwd>
47 
48 #include "ConstrainedOptPack_Types.hpp"
49 
50 namespace ConstrainedOptPack {
51 
58 public:
59 
62 
64  class NotDescentDirection : public std::logic_error
65  {public: NotDescentDirection(const std::string& what_arg) : std::logic_error(what_arg) {}};
66 
68 
71 
73  virtual void set_max_iter(int max_iter) = 0;
74 
76  virtual int max_iter() const = 0;
77 
79  virtual int num_iterations() const = 0;
80 
121  virtual bool do_line_search(
122  const MeritFuncCalc1D &phi
123  ,value_type phi_k
124  ,value_type *alpha_k
125  ,value_type *phi_kp1
126  ,std::ostream *out = 0
127  ) = 0;
128 
133  virtual void print_algorithm(std::ostream& out, const std::string& leading_str) const
134  {}
135 
136 }; // end class DirectLineSearch_Strategy
137 
138 } // end namespace ConstrainedOptPack
139 
140 #endif // DIRECT_LINE_SEARCH_STRATEGY_H
Abstracts a 1D merit function {abstract}.
virtual bool do_line_search(const MeritFuncCalc1D &phi, value_type phi_k, value_type *alpha_k, value_type *phi_kp1, std::ostream *out=0)=0
Called to perform the linesearch.
virtual int max_iter() const =0
Get the maximum number of iterations.
virtual int num_iterations() const =0
Get the number of iterations performed.
Thrown if the direction vector d_k is not a descent direction for the merit funciton.
virtual void set_max_iter(int max_iter)=0
Set the maximum number of iterations.
Abstract strategy interface for 1D line searches {abstract}.
virtual void print_algorithm(std::ostream &out, const std::string &leading_str) const
Print the direct line search algorithm.