/usr/include/shark/ObjectiveFunctions/AbstractConstraintHandler.h is in libshark-dev 3.0.1+ds1-2ubuntu1.
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 | //===========================================================================
/*!
*
*
* \brief Base class for constraints.
*
*
* \author O.Krause
* \date 2013
*
*
* \par Copyright 1995-2015 Shark Development Team
*
* <BR><HR>
* This file is part of Shark.
* <http://image.diku.dk/shark/>
*
* Shark 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 3 of the License, or
* (at your option) any later version.
*
* Shark 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 Shark. If not, see <http://www.gnu.org/licenses/>.
*
*/
//===========================================================================
#ifndef SHARK_OBJECTIVEFUNCTIONS_ABSTRACTCONSTRAINTHANDLER_H
#define SHARK_OBJECTIVEFUNCTIONS_ABSTRACTCONSTRAINTHANDLER_H
#include <shark/Core/Exception.h>
#include <shark/Core/Flags.h>
namespace shark{
/// \brief Implements the base class for constraint handling.
///
/// A constraint handler provides information about the feasible region of a constrained optimization problem.
/// In the minimum it checks whether a point is feasible, or what the next fasible point would be.
template<class SearchPointType>
class AbstractConstraintHandler{
public:
enum Feature {
CAN_PROVIDE_CLOSEST_FEASIBLE = 1, ///< The constraint handler can provide a close feasible point to an infeasible one
IS_BOX_CONSTRAINED = 2, ///< The constraint handler is an instance of BoxConstraintHandler
CAN_GENERATE_RANDOM_POINT = 4 ///< The ConstraintHandler can generate a random point inside the feasible region
};
SHARK_FEATURE_INTERFACE;
virtual ~AbstractConstraintHandler(){}
/// \brief Returns whether this function can calculate the closest feasible to an infeasible point.
bool canProvideClosestFeasible()const{
return m_features & CAN_PROVIDE_CLOSEST_FEASIBLE;
}
/// \brief Returns whether this function is an instance of BoxConstraintHandler
bool isBoxConstrained()const{
return m_features &IS_BOX_CONSTRAINED;
}
/// \brief Returns whether this function is an instance of BoxConstraintHandler
bool canGenerateRandomPoint()const{
return m_features & CAN_GENERATE_RANDOM_POINT;
}
/// \brief If supported, generates a random point inside the feasible region.
virtual void generateRandomPoint( SearchPointType & startingPoint )const {
SHARK_FEATURE_EXCEPTION(CAN_GENERATE_RANDOM_POINT);
}
/// \brief Returns true if the point is in the feasible Region.
///
/// This function must be implemented by a ConstraintHandler
virtual bool isFeasible(SearchPointType const&)const = 0;
virtual void closestFeasible(SearchPointType& )const{
SHARK_FEATURE_EXCEPTION(CAN_PROVIDE_CLOSEST_FEASIBLE );
}
};
}
#endif
|