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_VariableBoundsTester.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 VARIABLE_BOUNDS_TESTER_H
43 #define VARIABLE_BOUNDS_TESTER_H
44 
45 #include "ConstrainedOptPack_Types.hpp"
47 
48 namespace ConstrainedOptPack {
49 
63 public:
64 
66  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, warning_tol );
67 
69  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, error_tol );
70 
73  value_type warning_tol = 1e-10
74  , value_type error_tol = 1e-5
75  );
76 
78  virtual ~VariableBoundsTester() {}
79 
98  virtual bool check_in_bounds(
99  std::ostream* out, bool print_all_warnings, bool print_vectors
100  ,const Vector& xL, const char xL_name[]
101  ,const Vector& xU, const char xU_name[]
102  ,const Vector& x, const char x_name[]
103  );
104 
105 }; // end class VariableBoundsTester
106 
107 } // end namespace ConstrainedOptimizationPackTypes
108 
109 #endif // VARIABLE_BOUNDS_TESTER_H
VariableBoundsTester(value_type warning_tol=1e-10, value_type error_tol=1e-5)
STANDARD_MEMBER_COMPOSITION_MEMBERS(value_type, warning_tol)
Tests that a set of variables are within their bounds.
virtual bool check_in_bounds(std::ostream *out, bool print_all_warnings, bool print_vectors, const Vector &xL, const char xL_name[], const Vector &xU, const char xU_name[], const Vector &x, const char x_name[])
Check that the variables are within bounds.