GlobiPack  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
GlobiPack_LineSearchBase.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_LINE_SEARCH_BASE_HPP
45 #define GLOBIPACK_LINE_SEARCH_BASE_HPP
46 
47 
48 #include "GlobiPack_MeritFunc1DBase.hpp"
49 #include "Teuchos_Describable.hpp"
50 #include "Teuchos_VerboseObject.hpp"
51 #include "Teuchos_ParameterListAcceptor.hpp"
52 
53 
54 namespace GlobiPack {
55 
56 
61 template<typename Scalar>
63  : virtual public Teuchos::Describable,
64  virtual public Teuchos::VerboseObject<LineSearchBase<Scalar> >,
65  virtual public Teuchos::ParameterListAcceptor
66 {
67 public:
68 
72  virtual bool requiresBaseDeriv() const = 0;
73 
77  virtual bool requiresDerivEvals() const = 0;
78 
146  virtual bool doLineSearch(
147  const MeritFunc1DBase<Scalar> &phi,
148  const PointEval1D<Scalar> &point_k,
149  const Ptr<PointEval1D<Scalar> > &point_kp1,
150  const Ptr<int> &numIters
151  ) const = 0;
152 
153 };
154 
155 
156 } // namespace GlobiPack
157 
158 
159 #endif // GLOBIPACK_LINE_SEARCH_BASE_HPP
virtual bool doLineSearch(const MeritFunc1DBase< Scalar > &phi, const PointEval1D< Scalar > &point_k, const Ptr< PointEval1D< Scalar > > &point_kp1, const Ptr< int > &numIters) const =0
Called to perform a linesearch.
virtual bool requiresBaseDeriv() const =0
Determines if the linesearch algorithm requires the base derivative at Dphi(0) or not...
Represents the evaluation point of the merit function phi(alpha) and/or is derivative Dphi(alpha)...
Base class for 1D linearsearch algorithms.
virtual bool requiresDerivEvals() const =0
Determines if the linesearch algorithm requires that Dphi(alpha) can be computed or not...
Base class for 1D merit fucntions used in globalization methods.