ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization Version of the Day
ConstrainedOptPack_DirectLineSearch_Strategy.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef DIRECT_LINE_SEARCH_STRATEGY_H
00043 #define DIRECT_LINE_SEARCH_STRATEGY_H
00044 
00045 #include <stdexcept>
00046 #include <iosfwd>
00047 
00048 #include "ConstrainedOptPack_Types.hpp"
00049 
00050 namespace ConstrainedOptPack {
00051 
00057 class DirectLineSearch_Strategy {
00058 public:
00059 
00062 
00064   class NotDescentDirection : public std::logic_error
00065   {public: NotDescentDirection(const std::string& what_arg) : std::logic_error(what_arg) {}};
00066 
00068 
00070   virtual ~DirectLineSearch_Strategy() {}
00071 
00073   virtual void set_max_iter(int max_iter) = 0;
00074 
00076   virtual int max_iter() const = 0;
00077 
00079   virtual int num_iterations() const = 0;
00080 
00121   virtual bool do_line_search(
00122     const MeritFuncCalc1D   &phi
00123     ,value_type             phi_k
00124     ,value_type             *alpha_k
00125     ,value_type             *phi_kp1
00126     ,std::ostream           *out      = 0
00127     ) = 0;
00128 
00133   virtual void print_algorithm(std::ostream& out, const std::string& leading_str) const
00134   {}
00135 
00136 };  // end class DirectLineSearch_Strategy
00137 
00138 } // end namespace ConstrainedOptPack
00139 
00140 #endif  // DIRECT_LINE_SEARCH_STRATEGY_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends