/usr/include/trilinos/ConstrainedOptPack_MeritFuncNLP.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 | // @HEADER
// ***********************************************************************
//
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
// Copyright (2003) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef MERIT_FUNC_NLP_H
#define MERIT_FUNC_NLP_H
#include <iosfwd>
#include "ConstrainedOptPack_Types.hpp"
namespace ConstrainedOptPack {
/** \brief Base class for all merit functions for NonLinear Programs (NLP) {abstract}.
*/
class MeritFuncNLP {
public:
/** \brief . */
class InvalidInitialization : public std::logic_error
{public: InvalidInitialization(const std::string& what_arg) : std::logic_error(what_arg) {}};
/** \brief . */
virtual ~MeritFuncNLP() {}
/** @name To be overridden by subclasses */
//@{
/** \brief Assign the state of one Merit functions.
*
* The default implementation throws an <tt>std::logic_error</tt> exception
* unless it is assignment to self.
*/
virtual MeritFuncNLP& operator=(const MeritFuncNLP&);
/** \brief Return the value of the merit function at f(x), c(x), h(x).
* This interface requires the client to compute f(x)
* c(x) and h(x) and pass it to this function to have
* the value of phi(f,c,h,hl,hu) calculated.
*
* If the merit function has not been initialized properly
* then a <tt>InvalidInitialization</tt> exception will be thrown.
*/
virtual value_type value(
value_type f
,const Vector *c
,const Vector *h
,const Vector *hl
,const Vector *hu
) const = 0;
/** \brief Return the value of the directional derivative of the
* merit function w.r.t. alpha at alpha = 0. In other words
* compute return d( phi(f(x),c(x),h(x)) ) / d(alpha_k) at alpha_k = 0
* where x = x_k + alpha_k * d_k.
*
* If the merit function has not been initialized properly
* then a <tt>InvalidInitialization</tt> exception will be thrown.
*/
virtual value_type deriv() const = 0;
/** \brief Print the merit funciton
*/
virtual void print_merit_func(
std::ostream& out, const std::string& leading_str ) const = 0;
//@}
}; // end class MeritFuncNLP
} // end namespace ConstrainedOptPack
#endif // MERIT_FUNC_NLP_H
|