/usr/include/trilinos/NLPInterfacePack_NLPTester.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 98 99 100 101 102 103 104 105 106 107 108 109 110 | // @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 NLP_INTERFACE_PACK_NLP_TESTER_H
#define NLP_INTERFACE_PACK_NLP_TESTER_H
#include <iosfwd>
#include "NLPInterfacePack_Types.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"
namespace NLPInterfacePack {
/** \brief Testing class for base NLP interface.
*
* This class is little more than a unit tester for the
* <tt>NLP</tt> base interface. This class will call all
* of the <tt>%NLP</tt> methods and print out quanities if asked to.
* This class simply validates the pre and post conditions
* for all of the methods. In that this class is useful.
*/
class NLPTester {
public:
/// Members for option \c print_all() (see Teuchos_StandardMemberCompositionMacros.hpp).
STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, print_all );
#ifdef DOXYGEN_COMPILE
;
#endif
/// Members for option \c throw_exception() (see Teuchos_StandardMemberCompositionMacros.hpp).
STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, throw_exception );
#ifdef DOXYGEN_COMPILE
;
#endif
/// Constructor (default options)
NLPTester(
bool print_all = false
,bool throw_exception = true
);
/** \brief Test the NLP interface as the given base point xo.
*
* @param nlp [in/out] The <tt>NLP</tt> object being tested. The pointers returned by
* <tt>nlp->get_f()</tt>, <tt>nlp->get_c()</tt> and <tt>nlp->get_h()</tt> will
* be preserved on output and will not be modified by this function.. The
* %NLP must be initialized before input.
* @param xo [in] Base point for the unknown variables to test the calcuation methods at.
* @param print_all_warnings
* [in] Determines if warnings for all of the comparison tests are printed or not.
* Warning: may cause as much as <i>O(</i><tt>this->n()<tt><i>)</i> output.
* @param out [in/out] If <tt>out != NULL</tt> any and all output will be sent here. If
* <tt>out == NULL</tt> then no output will be produced.
*
* @return Returns \c true if all of the tests checked out and no unexpected exceptions were
* thrown.
*
* The behavior of this method depends on the options \c print_all() and
* \c throw_exception() and the input arguments \c print_all_warnings and
* \c out.
* <ul>
* <li> <b><tt>throw_exception(bool)</tt></b>:
* If <tt>throw_exception()</tt> == true</tt>, then if any of the objects within
* this function throw exceptions, these exceptions will be be thrown clean
* out of this function for the caller to handle. If <tt>throw_exception()</tt> == false</tt>,
* then if any object throws an exception, the exception is caught and this this function will
* return <tt>false</tt>. In any case an error message will be printed
* to <tt>*out</tt> (if <tt>out != NULL</tt) before leaving the function (by \c return or \c throw).
* <li> <b><tt>print_all(bool)</tt></b>:
* If <tt>print_all() == true</tt> then all of the computed quantities will but dumped to \c out.
* Note that this is a useful option for initial debugging of small NLPs but not a good idea for
* larger NLPs as it will result in an excessive amount of output.
* </ul>
*/
bool test_interface(
NLP *nlp
,const Vector &xo
,bool print_all_warnings
,std::ostream *out
);
}; // end class NLPTester
} // end namespace NLPInterfacePack
#endif // NLP_INTERFACE_PACK_NLP_TESTER_H
|