/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* */ /* This file is part of the program and library */ /* SCIP --- Solving Constraint Integer Programs */ /* */ /* Copyright 2002-2022 Zuse Institute Berlin */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ /* You may obtain a copy of the License at */ /* */ /* http://www.apache.org/licenses/LICENSE-2.0 */ /* */ /* Unless required by applicable law or agreed to in writing, software */ /* distributed under the License is distributed on an "AS IS" BASIS, */ /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */ /* See the License for the specific language governing permissions and */ /* limitations under the License. */ /* */ /* You should have received a copy of the Apache-2.0 license */ /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */ /* */ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /**@file scip_sepa.h * @ingroup PUBLICCOREAPI * @brief public methods for separator plugins * @author Tobias Achterberg * @author Timo Berthold * @author Thorsten Koch * @author Alexander Martin * @author Marc Pfetsch * @author Kati Wolter * @author Gregor Hendel * @author Leona Gottwald */ /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ #ifndef __SCIP_SCIP_SEPA_H__ #define __SCIP_SCIP_SEPA_H__ #include "scip/def.h" #include "scip/type_result.h" #include "scip/type_retcode.h" #include "scip/type_scip.h" #include "scip/type_sepa.h" #include "scip/type_sol.h" /* In debug mode, we include the SCIP's structure in scip.c, such that no one can access * this structure except the interface methods in scip.c. * In optimized mode, the structure is included in scip.h, because some of the methods * are implemented as defines for performance reasons (e.g. the numerical comparisons). * Additionally, the internal "set.h" is included, such that the defines in set.h are * available in optimized mode. */ #ifdef NDEBUG #include "scip/struct_scip.h" #include "scip/struct_set.h" #include "scip/tree.h" #endif #ifdef __cplusplus extern "C" { #endif /**@addtogroup PublicSeparatorMethods * * @{ */ /** creates a separator and includes it in SCIP. * * @note method has all separator callbacks as arguments and is thus changed every time a new * callback is added * in future releases; consider using SCIPincludeSepaBasic() and setter functions * if you seek for a method which is less likely to change in future releases */ SCIP_EXPORT SCIP_RETCODE SCIPincludeSepa( SCIP* scip, /**< SCIP data structure */ const char* name, /**< name of separator */ const char* desc, /**< description of separator */ int priority, /**< priority of separator (>= 0: before, < 0: after constraint handlers) */ int freq, /**< frequency for calling separator */ SCIP_Real maxbounddist, /**< maximal relative distance from current node's dual bound to primal bound compared * to best node's dual bound for applying separation */ SCIP_Bool usessubscip, /**< does the separator use a secondary SCIP instance? */ SCIP_Bool delay, /**< should separator be delayed, if other separators found cuts? */ SCIP_DECL_SEPACOPY ((*sepacopy)), /**< copy method of separator or NULL if you don't want to copy your plugin into sub-SCIPs */ SCIP_DECL_SEPAFREE ((*sepafree)), /**< destructor of separator */ SCIP_DECL_SEPAINIT ((*sepainit)), /**< initialize separator */ SCIP_DECL_SEPAEXIT ((*sepaexit)), /**< deinitialize separator */ SCIP_DECL_SEPAINITSOL ((*sepainitsol)), /**< solving process initialization method of separator */ SCIP_DECL_SEPAEXITSOL ((*sepaexitsol)), /**< solving process deinitialization method of separator */ SCIP_DECL_SEPAEXECLP ((*sepaexeclp)), /**< LP solution separation method of separator */ SCIP_DECL_SEPAEXECSOL ((*sepaexecsol)), /**< arbitrary primal solution separation method of separator */ SCIP_SEPADATA* sepadata /**< separator data */ ); /** creates a separator and includes it in SCIP with its most fundamental callbacks. All non-fundamental * (or optional) callbacks as, e.g., init and exit callbacks, will be set to NULL. * Optional callbacks can be set via specific setter functions, see SCIPsetSepaInit(), SCIPsetSepaFree(), * SCIPsetSepaInitsol(), SCIPsetSepaExitsol(), SCIPsetSepaCopy(), SCIPsetExit(). * * @note if you want to set all callbacks with a single method call, consider using SCIPincludeSepa() instead */ SCIP_EXPORT SCIP_RETCODE SCIPincludeSepaBasic( SCIP* scip, /**< SCIP data structure */ SCIP_SEPA** sepa, /**< reference to a separator, or NULL */ const char* name, /**< name of separator */ const char* desc, /**< description of separator */ int priority, /**< priority of separator (>= 0: before, < 0: after constraint handlers) */ int freq, /**< frequency for calling separator */ SCIP_Real maxbounddist, /**< maximal relative distance from current node's dual bound to primal bound compared * to best node's dual bound for applying separation */ SCIP_Bool usessubscip, /**< does the separator use a secondary SCIP instance? */ SCIP_Bool delay, /**< should separator be delayed, if other separators found cuts? */ SCIP_DECL_SEPAEXECLP ((*sepaexeclp)), /**< LP solution separation method of separator */ SCIP_DECL_SEPAEXECSOL ((*sepaexecsol)), /**< arbitrary primal solution separation method of separator */ SCIP_SEPADATA* sepadata /**< separator data */ ); /** sets copy method of separator */ SCIP_EXPORT SCIP_RETCODE SCIPsetSepaCopy( SCIP* scip, /**< SCIP data structure */ SCIP_SEPA* sepa, /**< separator */ SCIP_DECL_SEPACOPY ((*sepacopy)) /**< copy method of separator or NULL if you don't want to copy your plugin into sub-SCIPs */ ); /** sets destructor method of separator */ SCIP_EXPORT SCIP_RETCODE SCIPsetSepaFree( SCIP* scip, /**< SCIP data structure */ SCIP_SEPA* sepa, /**< separator */ SCIP_DECL_SEPAFREE ((*sepafree)) /**< destructor of separator */ ); /** sets initialization method of separator */ SCIP_EXPORT SCIP_RETCODE SCIPsetSepaInit( SCIP* scip, /**< SCIP data structure */ SCIP_SEPA* sepa, /**< separator */ SCIP_DECL_SEPAINIT ((*sepainit)) /**< initialize separator */ ); /** sets deinitialization method of separator */ SCIP_EXPORT SCIP_RETCODE SCIPsetSepaExit( SCIP* scip, /**< SCIP data structure */ SCIP_SEPA* sepa, /**< separator */ SCIP_DECL_SEPAEXIT ((*sepaexit)) /**< deinitialize separator */ ); /** sets solving process initialization method of separator */ SCIP_EXPORT SCIP_RETCODE SCIPsetSepaInitsol( SCIP* scip, /**< SCIP data structure */ SCIP_SEPA* sepa, /**< separator */ SCIP_DECL_SEPAINITSOL ((*sepainitsol)) /**< solving process initialization method of separator */ ); /** sets solving process deinitialization method of separator */ SCIP_EXPORT SCIP_RETCODE SCIPsetSepaExitsol( SCIP* scip, /**< SCIP data structure */ SCIP_SEPA* sepa, /**< separator */ SCIP_DECL_SEPAEXITSOL ((*sepaexitsol)) /**< solving process deinitialization method of separator */ ); /** returns the separator of the given name, or NULL if not existing */ SCIP_EXPORT SCIP_SEPA* SCIPfindSepa( SCIP* scip, /**< SCIP data structure */ const char* name /**< name of separator */ ); /** returns the array of currently available separators */ SCIP_EXPORT SCIP_SEPA** SCIPgetSepas( SCIP* scip /**< SCIP data structure */ ); /** returns the number of currently available separators */ SCIP_EXPORT int SCIPgetNSepas( SCIP* scip /**< SCIP data structure */ ); /** sets the priority of a separator */ SCIP_EXPORT SCIP_RETCODE SCIPsetSepaPriority( SCIP* scip, /**< SCIP data structure */ SCIP_SEPA* sepa, /**< separator */ int priority /**< new priority of the separator */ ); /** declares separator to be a parent separator * * Parent separators generate cuts of several types. To distinguish these cuts, they create child separators, which are * only needed to detect which cuts are applied. */ SCIP_EXPORT void SCIPsetSepaIsParentsepa( SCIP* scip, /**< SCIP data structure */ SCIP_SEPA* sepa /**< separator */ ); /** sets the parent separator * * Informs SCIP that the separator @p sepa depends on the parent separator @p parentsepa. */ SCIP_EXPORT void SCIPsetSepaParentsepa( SCIP* scip, /**< SCIP data structure */ SCIP_SEPA* sepa, /**< separator */ SCIP_SEPA* parentsepa /**< parent separator */ ); /** gets value of minimal efficacy for a cut to enter the LP * * @pre This method can be called if @p scip is in one of the following stages: * - \ref SCIP_STAGE_SOLVING * * @return value of "separating/minefficacyroot" if at root node, otherwise value of "separating/minefficacy" */ SCIP_EXPORT SCIP_Real SCIPgetSepaMinEfficacy( SCIP* scip /**< SCIP data structure */ ); #ifdef NDEBUG #define SCIPgetSepaMinEfficacy(scip) (SCIPtreeGetCurrentDepth((scip)->tree) == 0 ? (scip)->set->sepa_minefficacyroot : (scip)->set->sepa_minefficacy) #endif /** @} */ #ifdef __cplusplus } #endif #endif