GlobiPack Version of the Day
GlobiPack_BrentsLineSearch_decl.hpp
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 //    GlobiPack: Collection of Scalar 1D globalizaton utilities
00006 //                 Copyright (2009) Sandia Corporation
00007 // 
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 // 
00011 // This library is free software; you can redistribute it and/or modify
00012 // it under the terms of the GNU Lesser General Public License as
00013 // published by the Free Software Foundation; either version 2.1 of the
00014 // License, or (at your option) any later version.
00015 // 
00016 // This library is distributed in the hope that it will be useful, but
00017 // WITHOUT ANY WARRANTY; without even the implied warranty of
00018 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019 // Lesser General Public License for more details.
00020 // 
00021 // You should have received a copy of the GNU Lesser General Public
00022 // License along with this library; if not, write to the Free Software
00023 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00024 // USA
00025 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00026 // 
00027 // ***********************************************************************
00028 // @HEADER
00029 */
00030 
00031 #ifndef GLOBIPACK_BRENTS_LINE_SEARCH_DECL_HPP
00032 #define GLOBIPACK_BRENTS_LINE_SEARCH_DECL_HPP
00033 
00034 
00035 #include "GlobiPack_LineSearchBase.hpp"
00036 #include "GlobiPack_GoldenQuadInterpBracket.hpp"
00037 #include "GlobiPack_Brents1DMinimization.hpp"
00038 #include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
00039 
00040 
00041 namespace GlobiPack {
00042 
00043 
00059 template<typename Scalar>
00060 class BrentsLineSearch
00061   : public LineSearchBase<Scalar>,
00062     protected Teuchos::ParameterListAcceptorDefaultBase
00063 {
00064 public:
00065 
00068 
00070   BrentsLineSearch();
00071 
00073   const GoldenQuadInterpBracket<Scalar>& bracket() const;
00074 
00076   const Brents1DMinimization<Scalar>& brentsMin() const;
00077 
00079 
00082 
00084   void setParameterList(RCP<ParameterList> const& paramList);
00086   RCP<const ParameterList> getValidParameters() const;
00087 
00089 
00092 
00094   virtual bool requiresBaseDeriv() const;
00095 
00097   virtual bool requiresDerivEvals() const;
00098 
00100   virtual bool doLineSearch(
00101     const MeritFunc1DBase<Scalar> &phi,
00102     const PointEval1D<Scalar> &point_k,
00103     const Ptr<PointEval1D<Scalar> > &point_kp1,
00104     const Ptr<int> &numIters
00105     ) const;
00106 
00108 
00109 private:
00110 
00111   // //////////////////////
00112   // Private data members
00113 
00114   GoldenQuadInterpBracket<Scalar> bracket_;
00115   Brents1DMinimization<Scalar> brentsMin_;
00116 
00117 };
00118 
00119 
00124 template<typename Scalar>
00125 const RCP<BrentsLineSearch<Scalar> > brentsLineSearch()
00126 {
00127   return Teuchos::rcp(new BrentsLineSearch<Scalar>());
00128 }
00129 
00130 
00131 // Default values are exposed here for unit testing purposes
00132 
00133 
00134 namespace BrentsLineSearchUtils {
00135 
00136 
00137 const std::string bracket_name = "Bracket";
00138 
00139 const std::string minimize_name = "Minimize";
00140 
00141 
00142 } // namespace BrentsLineSearchUtils
00143 
00144 
00145 
00146 } // namespace GlobiPack
00147 
00148 
00149 #endif // GLOBIPACK_BRENTS_LINE_SEARCH_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends