ConstrainedOptPack_VariableBoundsTester.hpp

// @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 VARIABLE_BOUNDS_TESTER_H
#define VARIABLE_BOUNDS_TESTER_H

#include "ConstrainedOptPack_Types.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace ConstrainedOptPack {

class VariableBoundsTester {
public:

  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, warning_tol );

  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, error_tol );

  VariableBoundsTester(
      value_type  warning_tol   = 1e-10
    , value_type  error_tol   = 1e-5
    );

  virtual ~VariableBoundsTester() {}

  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[]
    );

};  // end class VariableBoundsTester

} // end namespace ConstrainedOptimizationPackTypes

#endif  // VARIABLE_BOUNDS_TESTER_H