MOOCHO (Single Doxygen Collection) Version of the Day
ConstrainedOptPack_VariableBoundsTester.cpp
Go to the documentation of this file.
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 #include "ConstrainedOptPack_VariableBoundsTester.hpp"
00043 #include "AbstractLinAlgPack_VectorSpace.hpp"
00044 #include "AbstractLinAlgPack_VectorMutable.hpp"
00045 #include "AbstractLinAlgPack_VectorAuxiliaryOps.hpp"
00046 
00047 namespace ConstrainedOptPack {
00048 
00049 // public
00050 
00051 VariableBoundsTester::VariableBoundsTester(
00052   value_type   warning_tol
00053   ,value_type  error_tol
00054   )
00055   :warning_tol_(warning_tol)
00056   ,error_tol_(error_tol)
00057 {}
00058 
00059 bool VariableBoundsTester::check_in_bounds(
00060   std::ostream* out, bool print_all_warnings, bool print_vectors
00061   ,const Vector& xL, const char xL_name[]
00062   ,const Vector& xU, const char xU_name[]
00063   ,const Vector& x,  const char x_name[]
00064   )
00065 {
00066   using AbstractLinAlgPack::max_near_feas_step;
00067 
00068   if(out)
00069     *out
00070       << "\n*** Checking that variables are in bounds\n";
00071 
00072   VectorSpace::vec_mut_ptr_t zero = x.space().create_member(0.0);
00073   std::pair<value_type,value_type>
00074     u = max_near_feas_step( x, *zero, xL, xU, warning_tol() );
00075   if(u.first < 0.0) {
00076     if(out)
00077       *out << "\nWarning! the variables " << xL_name << " <= " << x_name << " <= " << xU_name
00078         << " are out of bounds by more than warning_tol = " << warning_tol() << "\n";
00079     u = max_near_feas_step( x, *zero, xL, xU, error_tol() );
00080     if(u.first < 0.0) {
00081       if(out)
00082         *out << "\nError! the variables " << xL_name << " <= " << x_name << " <= " << xU_name
00083           << " are out of bounds by more than error_tol = " << error_tol() << "\n";
00084       return false;
00085     }
00086   }
00087   return true;
00088 }
00089 
00090 } // end namespace ConstrainedOptPack
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines