ConstrainedOptPack_DirectLineSearch_Strategy.hpp

Go to the documentation of this file.
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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef DIRECT_LINE_SEARCH_STRATEGY_H
00030 #define DIRECT_LINE_SEARCH_STRATEGY_H
00031 
00032 #include <stdexcept>
00033 #include <iosfwd>
00034 
00035 #include "ConstrainedOptPack_Types.hpp"
00036 
00037 namespace ConstrainedOptPack {
00038 
00044 class DirectLineSearch_Strategy {
00045 public:
00046 
00049 
00051   class NotDescentDirection : public std::logic_error
00052   {public: NotDescentDirection(const std::string& what_arg) : std::logic_error(what_arg) {}};
00053 
00055 
00057   virtual ~DirectLineSearch_Strategy() {}
00058 
00060   virtual void set_max_iter(int max_iter) = 0;
00061 
00063   virtual int max_iter() const = 0;
00064 
00066   virtual int num_iterations() const = 0;
00067 
00108   virtual bool do_line_search(
00109     const MeritFuncCalc1D   &phi
00110     ,value_type             phi_k
00111     ,value_type             *alpha_k
00112     ,value_type             *phi_kp1
00113     ,std::ostream           *out      = 0
00114     ) = 0;
00115 
00120   virtual void print_algorithm(std::ostream& out, const std::string& leading_str) const
00121   {}
00122 
00123 };  // end class DirectLineSearch_Strategy
00124 
00125 } // end namespace ConstrainedOptPack
00126 
00127 #endif  // DIRECT_LINE_SEARCH_STRATEGY_H

Generated on Thu Sep 18 12:35:14 2008 for MOOCHO (Single Doxygen Collection) by doxygen 1.3.9.1