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_MeritFuncCalcNLE.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_NLE_H
43 #define MERIT_FUNC_CALC_NLE_H
44 
45 #include "ConstrainedOptPack_MeritFuncCalc.hpp"
46 #include "ConstrainedOptPack_MeritFuncNLE.hpp"
47 #include "StandardAggregationMacros.hpp"
48 
49 namespace ConstrainedOptPack {
50 
56 public:
57 
60 
61 
63 
64 
65  MeritFuncCalcNLE( const MeritFuncNLE* phi = 0, const NLP* nlp = 0 );
66 
67  // ////////////////////////////////////////////
68  // Overridden from MeritFuncCalc
69 
73  value_type operator()(const Vector& x) const;
74 
76  value_type deriv() const;
77 
79  void print_merit_func(std::ostream& out
80  , const std::string& leading_str) const;
81 
82 }; // end class MeritFuncCalcNLE
83 
84 } // end namespace ConstrainedOptPack
85 
86 #endif // MERIT_FUNC_CALC_NLE_H
Base class for all merit functions for systems of NonLinear Equations (NLE) {abstract}.
Abstract iterface for n-D merit functions {abstract}.
value_type operator()(const Vector &x) const
Return the value of the merit function at x. Here phi(x) is calculated directly using the nlp...
#define STANDARD_CONST_AGGREGATION_MEMBERS(TYPE, NAME)
Adds the ability to compute phi(c(x)) at x directly instead of having to compute c first...
MeritFuncCalcNLE(const MeritFuncNLE *phi=0, const NLP *nlp=0)
<<std aggr>="">> stereotype members for phi.
value_type deriv() const
Calls phi().deriv() on phi.
void print_merit_func(std::ostream &out, const std::string &leading_str) const
Calls phi().print_merit_func(....).