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 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00039 // 
00040 // ***********************************************************************
00041 // @HEADER
00042 */
00043 
00044 #ifndef GLOBIPACK_BRENTS_LINE_SEARCH_DECL_HPP
00045 #define GLOBIPACK_BRENTS_LINE_SEARCH_DECL_HPP
00046 
00047 
00048 #include "GlobiPack_LineSearchBase.hpp"
00049 #include "GlobiPack_GoldenQuadInterpBracket.hpp"
00050 #include "GlobiPack_Brents1DMinimization.hpp"
00051 #include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
00052 
00053 
00054 namespace GlobiPack {
00055 
00056 
00072 template<typename Scalar>
00073 class BrentsLineSearch
00074   : public LineSearchBase<Scalar>,
00075     protected Teuchos::ParameterListAcceptorDefaultBase
00076 {
00077 public:
00078 
00081 
00083   BrentsLineSearch();
00084 
00086   const GoldenQuadInterpBracket<Scalar>& bracket() const;
00087 
00089   const Brents1DMinimization<Scalar>& brentsMin() const;
00090 
00092 
00095 
00097   void setParameterList(RCP<ParameterList> const& paramList);
00099   RCP<const ParameterList> getValidParameters() const;
00100 
00102 
00105 
00107   virtual bool requiresBaseDeriv() const;
00108 
00110   virtual bool requiresDerivEvals() const;
00111 
00113   virtual bool doLineSearch(
00114     const MeritFunc1DBase<Scalar> &phi,
00115     const PointEval1D<Scalar> &point_k,
00116     const Ptr<PointEval1D<Scalar> > &point_kp1,
00117     const Ptr<int> &numIters
00118     ) const;
00119 
00121 
00122 private:
00123 
00124   // //////////////////////
00125   // Private data members
00126 
00127   GoldenQuadInterpBracket<Scalar> bracket_;
00128   Brents1DMinimization<Scalar> brentsMin_;
00129 
00130 };
00131 
00132 
00137 template<typename Scalar>
00138 const RCP<BrentsLineSearch<Scalar> > brentsLineSearch()
00139 {
00140   return Teuchos::rcp(new BrentsLineSearch<Scalar>());
00141 }
00142 
00143 
00144 // Default values are exposed here for unit testing purposes
00145 
00146 
00147 namespace BrentsLineSearchUtils {
00148 
00149 
00150 const std::string bracket_name = "Bracket";
00151 
00152 const std::string minimize_name = "Minimize";
00153 
00154 
00155 } // namespace BrentsLineSearchUtils
00156 
00157 
00158 
00159 } // namespace GlobiPack
00160 
00161 
00162 #endif // GLOBIPACK_BRENTS_LINE_SEARCH_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends