/usr/include/trilinos/ConstrainedOptPack_VariableBoundsTester.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | // @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 {
/** \brief Tests that a set of variables are within their bounds.
*
\verbatim
xL <= x <= xU
\endverbatim
*
* The relative error for each comparison is
* rel_err(i) = (xL(i)-x(i))/(1+||x||inf)
* or rel_err(i) = (x(i)-xU(i))/(1+||x||inf).
* If rel_err(i) >= error_tol, then the tests will be terminated immediately.
* All of the rel_err(i) >= warning_tol will be printed.
*/
class VariableBoundsTester {
public:
/** \brief . */
STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, warning_tol );
/** \brief . */
STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, error_tol );
/** \brief . */
VariableBoundsTester(
value_type warning_tol = 1e-10
, value_type error_tol = 1e-5
);
/** \brief . */
virtual ~VariableBoundsTester() {}
/** \brief Check that the variables are within bounds.
*
* @param print_all_warnings
* [in] If true, then all errors greater than warning_tol will
* be printed.
* @param xL [in] Sparse lower bound vector (xL.size()==x.size())
* @param xL_name
* [in] The name of the vector xL (null terminated string).
* @param xU [in] Sparse upper bound vector (xU.size()==x.size())
* @param xU_name
* [in] The name of the vector xU (null terminated string).
* @param x [in] Variable to test that it is in bounds.
* @param x_name
* [in] The name of the vector x (null terminated string).
*
* @return \c true if all of the errors are greater than the error tolerances,
* otherwise it returns \c false
*/
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
|