GlobiPack Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
GlobiPack_MeritFunc1DBase.hpp
Go to the documentation of this file.
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_MERIT_FUNC_1D_BASE_HPP
45 #define GLOBIPACK_MERIT_FUNC_1D_BASE_HPP
46 
47 
48 #include "GlobiPack_Types.hpp"
49 #include "Teuchos_Describable.hpp"
50 
51 
52 namespace GlobiPack {
53 
54 
61 template<typename Scalar>
62 class MeritFunc1DBase : virtual public Teuchos::Describable
63 {
64 public:
65 
67  virtual bool supportsDerivEvals() const = 0;
68 
87  virtual void eval( const Scalar &alpha, const Ptr<Scalar> &phi,
88  const Ptr<Scalar> &Dphi ) const = 0;
89 
90 };
91 
92 
97 template<typename Scalar>
99 computeValue(const MeritFunc1DBase<Scalar> &phi, const Scalar &alpha)
100 {
101  Scalar phi_val = ScalarTraits<Scalar>::zero();
102  phi.eval(alpha, Teuchos::outArg(phi_val), Teuchos::null);
103  return phi_val;
104 }
105 
106 
111 template<typename Scalar>
113 computePoint(const MeritFunc1DBase<Scalar> &phi, const Scalar &alpha,
114  const bool compute_phi = true, const bool compute_Dphi = false)
115 {
116  using Teuchos::null;
117  using Teuchos::outArg;
119  p.alpha = alpha;
120  phi.eval( alpha, compute_phi ? outArg(p.phi) : null ,
121  compute_Dphi ? outArg(p.Dphi) : null );
122  return p;
123 }
124 
125 
126 } // namespace GlobiPack
127 
128 
129 #endif // GLOBIPACK_MERIT_FUNC_1D_BASE_HPP
Scalar phi
The value of the merit function phi(alpha).
Scalar Dphi
The value of the derivative of the merit function Dphi(alpha).
virtual bool supportsDerivEvals() const =0
Determine if derivative evaluations are supported or not.
Scalar alpha
The value of the unknown alpha.
Represents the evaluation point of the merit function phi(alpha) and/or is derivative Dphi(alpha)...
PointEval1D< Scalar > computePoint(const MeritFunc1DBase< Scalar > &phi, const Scalar &alpha, const bool compute_phi=true, const bool compute_Dphi=false)
Compute a point as an object.
Base class for 1D merit fucntions used in globalization methods.
ScalarTraits< Scalar >::magnitudeType computeValue(const MeritFunc1DBase< Scalar > &phi, const Scalar &alpha)
Compute the value of the merit function phi(alpha).
virtual void eval(const Scalar &alpha, const Ptr< Scalar > &phi, const Ptr< Scalar > &Dphi) const =0
Evaluate the merit function at alpha.