ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization Version of the Day
ConstrainedOptPack_VariableBoundsTester.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef VARIABLE_BOUNDS_TESTER_H
00043 #define VARIABLE_BOUNDS_TESTER_H
00044 
00045 #include "ConstrainedOptPack_Types.hpp"
00046 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00047 
00048 namespace ConstrainedOptPack {
00049 
00062 class VariableBoundsTester {
00063 public:
00064 
00066   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, warning_tol );
00067 
00069   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, error_tol );
00070 
00072   VariableBoundsTester(
00073       value_type  warning_tol   = 1e-10
00074     , value_type  error_tol   = 1e-5
00075     );
00076 
00078   virtual ~VariableBoundsTester() {}
00079 
00098   virtual bool check_in_bounds(
00099     std::ostream* out, bool print_all_warnings, bool print_vectors
00100     ,const Vector& xL, const char xL_name[]
00101     ,const Vector& xU, const char xU_name[]
00102     ,const Vector& x,  const char x_name[]
00103     );
00104 
00105 };  // end class VariableBoundsTester
00106 
00107 } // end namespace ConstrainedOptimizationPackTypes
00108 
00109 #endif  // VARIABLE_BOUNDS_TESTER_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends