MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ConstrainedOptPack_MeritFuncCalcNLP.cpp
Go to the documentation of this file.
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 
44 
45 namespace ConstrainedOptPack {
46 
47 MeritFuncCalcNLP::MeritFuncCalcNLP( const MeritFuncNLP* phi, const NLP* nlp )
48  : phi_(phi), nlp_(nlp)
49 {}
50 
52 {
53  const size_type
54  m = nlp().m(),
55  ns = nlp().ns();
56  nlp().calc_f(x);
57  if(m) nlp().calc_c(x,false);
58  return phi().value(
59  nlp().f()
60  ,m ? &nlp().c() : NULL
61  ,NULL // h
62  ,NULL // hl
63  ,NULL // hu
64  );
65 /* RAB: 20020112: ToDo: Get this working
66  if(m) nlp().calc_c_breve(x,false);
67  if(ns) nlp().calc_h_breve(x,false);
68  return phi().value(
69  nlp().f()
70  ,m ? &nlp().c_breve() : NULL
71  ,ns ? &nlp().h_breve() : NULL
72  ,ns ? &nlp().hl_breve() : NULL
73  ,ns ? &nlp().hu_breve() : NULL
74  );
75 */
76 }
77 
79  return phi().deriv();
80 }
81 
83  std::ostream& out, const std::string& L
84  ) const
85 {
86  out << L << "*** MeritFuncCalcNLP\n"
87  << L << "f = f(x), c = c_breve(x_breve), h = h_breve(x_breve)\n";
88  phi().print_merit_func(out,L);
89 }
90 
91 } // end namespace ConstrainedOptPack
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...
AbstractLinAlgPack::size_type size_type
void f()
Base class for all merit functions for NonLinear Programs (NLP) {abstract}.
value_type deriv() const
Calls phi().deriv() on phi.
std::ostream * out
AbstractLinAlgPack::value_type value_type
MeritFuncCalcNLP(const MeritFuncNLP *phi=0, const NLP *nlp=0)
<<std aggr>="">> stereotype members for phi.
void print_merit_func(std::ostream &out, const std::string &leading_str) const
Calls phi().print_merit_func().