ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ConstrainedOptPack_MeritFuncCalc1DQuadratic.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef MERIT_FUNC_CALC_1D_QUADRATIC_H
43 #define MERIT_FUNC_CALC_1D_QUADRATIC_H
44 
45 #include "ConstrainedOptPack_MeritFuncCalc1D.hpp"
46 #include "ConstrainedOptPack_MeritFuncCalc.hpp"
47 
48 namespace ConstrainedOptPack {
49 
56 public:
57 
59  typedef const Vector* const_VectorWithOp_ptr;
60 
63 
82  const MeritFuncCalc& phi
83  ,size_type p
85  ,VectorMutable* x
86  );
87 
89 
92 
94  value_type operator()(value_type alpha) const;
95 
97  value_type deriv() const;
98 
100  void print_merit_func(
101  std::ostream& out, const std::string& leading_str ) const;
102 
104 
105 private:
106  const MeritFuncCalc& phi_;
107  size_type p_;
109  VectorMutable *x_;
110 
111  // not defined and not to be called
114 
115 }; // end class MeritFuncCalc1DQuadratic
116 
117 } // end namespace ConstrainedOptPack
118 
119 #endif // MERIT_FUNC_CALC_1D_QUADRATIC_H
value_type operator()(value_type alpha) const
Returns phi( x = sum( alpha^k * d[k], k = 0...p-1 ) ).
Abstracts a 1D merit function {abstract}.
Adds the ability to compute phi(alpha) at alpha of a given set of vectors.
size_t size_type
void print_merit_func(std::ostream &out, const std::string &leading_str) const
Calls phi->print_merit_func().
Abstract iterface for n-D merit functions {abstract}.