GlobiPack  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
GlobiPack_Brents1DMinimization_decl.hpp
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // GlobiPack: Collection of Scalar 1D globalizaton utilities
6 // Copyright (2009) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 #ifndef GLOBIPACK_BRENTS_1D_MINIMIZATION_DECL_HPP
45 #define GLOBIPACK_BRENTS_1D_MINIMIZATION_DECL_HPP
46 
47 
48 #include "GlobiPack_MeritFunc1DBase.hpp"
49 #include "Teuchos_Describable.hpp"
50 #include "Teuchos_VerboseObject.hpp"
51 #include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
52 
53 
54 namespace GlobiPack {
55 
56 
62 template<typename Scalar>
64  : public Teuchos::Describable,
65  public Teuchos::VerboseObject<Brents1DMinimization<Scalar> >,
67 {
68 public:
69 
72 
75 
77 
80 
82  void setParameterList(RCP<ParameterList> const& paramList);
85 
87 
90 
124  bool approxMinimize(
125  const MeritFunc1DBase<Scalar> &phi,
126  const PointEval1D<Scalar> &pointLower,
127  const Ptr<PointEval1D<Scalar> > &pointMiddle,
128  const PointEval1D<Scalar> &pointUpper,
129  const Ptr<int> &numIters = Teuchos::null
130  ) const;
131 
133 
134 private:
135 
136  // //////////////////////
137  // Private data members
138 
139  Scalar rel_tol_;
140  Scalar bracket_tol_;
141  int max_iters_;
142 
143 };
144 
145 
150 template<typename Scalar>
151 inline
153 {
155 }
156 
157 
158 // Default values are exposed here for unit testing purposes
159 
160 
161 namespace Brents1DMinimizationUtils {
162 
163 
164 const std::string rel_tol_name = "Relative Tol";
165 const double rel_tol_default = 1.0e-5;
166 
167 const std::string bracket_tol_name = "Bracket Tol";
168 const double bracket_tol_default = 1.0e-5;
169 
170 const std::string max_iters_name = "Max Iterations";
171 const int max_iters_default = 10;
172 
173 
174 } // namespace Brents1DMinimizationUtils
175 
176 
177 
178 } // namespace GlobiPack
179 
180 
181 #endif // GLOBIPACK_BRENTS_1D_MINIMIZATION_DECL_HPP
Simple concrete class that implements a 1D algorithm to mimimize a 1D function.
bool approxMinimize(const MeritFunc1DBase< Scalar > &phi, const PointEval1D< Scalar > &pointLower, const Ptr< PointEval1D< Scalar > > &pointMiddle, const PointEval1D< Scalar > &pointUpper, const Ptr< int > &numIters=Teuchos::null) const
Approximatly mimimize a 1D function.
Brents1DMinimization()
Construct with default parameters.
const RCP< Brents1DMinimization< Scalar > > brents1DMinimization()
Nonmember constructor.
RCP< const ParameterList > getValidParameters() const
Represents the evaluation point of the merit function phi(alpha) and/or is derivative Dphi(alpha)...
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
void setParameterList(RCP< ParameterList > const &paramList)
Base class for 1D merit fucntions used in globalization methods.