GlobiPack Version of the Day
GlobiPack_GoldenQuadInterpBracket_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_GOLDEN_BRACKET_QUAD_INTERP_DECL_HPP
00045 #define GLOBIPACK_GOLDEN_BRACKET_QUAD_INTERP_DECL_HPP
00046 
00047 
00048 #include "GlobiPack_MeritFunc1DBase.hpp"
00049 #include "Teuchos_Describable.hpp"
00050 #include "Teuchos_VerboseObject.hpp"
00051 #include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
00052 
00053 
00054 namespace GlobiPack {
00055 
00056 
00062 template<typename Scalar>
00063 class GoldenQuadInterpBracket
00064   : public Teuchos::Describable,
00065     public Teuchos::VerboseObject<GoldenQuadInterpBracket<Scalar> >,
00066     public Teuchos::ParameterListAcceptorDefaultBase
00067 {
00068 public:
00069 
00072 
00074   GoldenQuadInterpBracket();
00075 
00077 
00080 
00082   void setParameterList(RCP<ParameterList> const& paramList);
00084   RCP<const ParameterList> getValidParameters() const;
00085 
00087 
00090 
00133   bool bracketMinimum(
00134     const MeritFunc1DBase<Scalar> &phi,
00135     const Ptr<PointEval1D<Scalar> > &pointLower,
00136     const Ptr<PointEval1D<Scalar> > &pointMiddle,
00137     const Ptr<PointEval1D<Scalar> > &pointUpper,
00138     const Ptr<int> &numIters = Teuchos::null
00139     ) const;
00140 
00142 
00143 private:
00144 
00145   // //////////////////////
00146   // Private data members
00147 
00148 };
00149 
00150 
00155 template<typename Scalar>
00156 inline
00157 const RCP<GoldenQuadInterpBracket<Scalar> > goldenQuadInterpBracket()
00158 {
00159   return Teuchos::rcp(new GoldenQuadInterpBracket<Scalar>());
00160 }
00161 
00162 
00163 // Default values are exposed here for unit testing purposes
00164 
00165 
00166 namespace GoldenQuadInterpBracketUtils {
00167 
00168 
00169 const std::string eta_name = "Armijo Slope Fraction";
00170 const double eta_default = 1.0e-4;
00171 
00172 
00173 } // namespace GoldenQuadInterpBracketUtils
00174 
00175 
00176 
00177 } // namespace GlobiPack
00178 
00179 
00180 #endif // GLOBIPACK_GOLDEN_BRACKET_QUAD_INTERP_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends