NLPInterfacePack: C++ Interfaces and Implementation for Non-Linear Programs  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
NLPInterfacePack_NLPTester.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 NLP_INTERFACE_PACK_NLP_TESTER_H
43 #define NLP_INTERFACE_PACK_NLP_TESTER_H
44 
45 #include <iosfwd>
46 
47 #include "NLPInterfacePack_Types.hpp"
49 
50 namespace NLPInterfacePack {
51 
60 class NLPTester {
61 public:
62 
64  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, print_all );
65 #ifdef DOXYGEN_COMPILE
66  ;
67 #endif
68  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, throw_exception );
70 #ifdef DOXYGEN_COMPILE
71  ;
72 #endif
73  NLPTester(
75  bool print_all = false
76  ,bool throw_exception = true
77  );
78 
112  bool test_interface(
113  NLP *nlp
114  ,const Vector &xo
115  ,bool print_all_warnings
116  ,std::ostream *out
117  );
118 
119 }; // end class NLPTester
120 
121 } // end namespace NLPInterfacePack
122 
123 #endif // NLP_INTERFACE_PACK_NLP_TESTER_H
bool test_interface(NLP *nlp, const Vector &xo, bool print_all_warnings, std::ostream *out)
Test the NLP interface as the given base point xo.
Testing class for base NLP interface.
NLP interface class {abstract}.
NLPTester(bool print_all=false, bool throw_exception=true)
Constructor (default options)
STANDARD_MEMBER_COMPOSITION_MEMBERS(bool, print_all)
Members for option print_all() (see Teuchos_StandardMemberCompositionMacros.hpp). ...