/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* */ /* 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 cons_and.h * @ingroup CONSHDLRS * @brief Constraint handler for AND constraints, \f$r = x_1 \wedge x_2 \wedge \dots \wedge x_n\f$ * @author Tobias Achterberg * @author Stefan Heinz * @author Michael Winkler * */ /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ #ifndef __SCIP_CONS_AND_H__ #define __SCIP_CONS_AND_H__ #include "scip/def.h" #include "scip/type_cons.h" #include "scip/type_retcode.h" #include "scip/type_scip.h" #include "scip/type_var.h" #ifdef __cplusplus extern "C" { #endif /** creates the handler for and constraints and includes it in SCIP * * @ingroup ConshdlrIncludes * */ SCIP_EXPORT SCIP_RETCODE SCIPincludeConshdlrAnd( SCIP* scip /**< SCIP data structure */ ); /**@addtogroup CONSHDLRS * * @{ * * @name AND Constraints * * @{ * * This constraint handler deals with AND-constraints. These are constraint of the form: * * \f[ * r = x_1 \wedge x_2 \wedge \dots \wedge x_n * \f] * * where \f$x_i\f$ is a binary variable for all \f$i\f$. Hence, \f$r\f$ is also of binary type. The variable \f$r\f$ is * called resultant and the \f$x\f$'s operators. */ /** creates and captures an and constraint * * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons() */ SCIP_EXPORT SCIP_RETCODE SCIPcreateConsAnd( SCIP* scip, /**< SCIP data structure */ SCIP_CONS** cons, /**< pointer to hold the created constraint */ const char* name, /**< name of constraint */ SCIP_VAR* resvar, /**< resultant variable of the operation */ int nvars, /**< number of operator variables in the constraint */ SCIP_VAR** vars, /**< array with operator variables of constraint */ SCIP_Bool initial, /**< should the LP relaxation of constraint be in the initial LP? * Usually set to TRUE. Set to FALSE for 'lazy constraints'. */ SCIP_Bool separate, /**< should the constraint be separated during LP processing? * Usually set to TRUE. */ SCIP_Bool enforce, /**< should the constraint be enforced during node processing? * TRUE for model constraints, FALSE for additional, redundant constraints. */ SCIP_Bool check, /**< should the constraint be checked for feasibility? * TRUE for model constraints, FALSE for additional, redundant constraints. */ SCIP_Bool propagate, /**< should the constraint be propagated during node processing? * Usually set to TRUE. */ SCIP_Bool local, /**< is constraint only valid locally? * Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */ SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)? * Usually set to FALSE. In column generation applications, set to TRUE if pricing * adds coefficients to this constraint. */ SCIP_Bool dynamic, /**< is constraint subject to aging? * Usually set to FALSE. Set to TRUE for own cuts which * are separated as constraints. */ SCIP_Bool removable, /**< should the relaxation be removed from the LP due to aging or cleanup? * Usually set to FALSE. Set to TRUE for 'lazy constraints' and 'user cuts'. */ SCIP_Bool stickingatnode /**< should the constraint always be kept at the node where it was added, even * if it may be moved to a more global node? * Usually set to FALSE. Set to TRUE to for constraints that represent node data. */ ); /** creates and captures an and constraint * in its most basic version, i. e., all constraint flags are set to their basic value as explained for the * method SCIPcreateConsAnd(); all flags can be set via SCIPsetConsFLAGNAME-methods in scip.h * * @see SCIPcreateConsAnd() for information about the basic constraint flag configuration * * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons() */ SCIP_EXPORT SCIP_RETCODE SCIPcreateConsBasicAnd( SCIP* scip, /**< SCIP data structure */ SCIP_CONS** cons, /**< pointer to hold the created constraint */ const char* name, /**< name of constraint */ SCIP_VAR* resvar, /**< resultant variable of the operation */ int nvars, /**< number of operator variables in the constraint */ SCIP_VAR** vars /**< array with operator variables of constraint */ ); /** gets number of variables in and constraint */ SCIP_EXPORT int SCIPgetNVarsAnd( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** gets array of variables in and constraint */ SCIP_EXPORT SCIP_VAR** SCIPgetVarsAnd( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** gets the resultant variable in and constraint */ SCIP_EXPORT SCIP_VAR* SCIPgetResultantAnd( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** return if the variables of the AND-constraint are sorted with respect to their indices */ SCIP_EXPORT SCIP_Bool SCIPisAndConsSorted( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** sort the variables of the AND-constraint with respect to their indices */ SCIP_EXPORT SCIP_RETCODE SCIPsortAndCons( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** when 'upgrading' the given AND-constraint, should the check flag for the upgraded constraint be set to TRUE, even if * the check flag of this AND-constraint is set to FALSE? */ SCIP_EXPORT SCIP_RETCODE SCIPchgAndConsCheckFlagWhenUpgr( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons, /**< constraint data */ SCIP_Bool flag /**< should an arising constraint from the given AND-constraint be checked, * even if the check flag of the AND-constraint is set to FALSE */ ); /** when 'upgrading' the given AND-constraint, should the removable flag for the upgraded constraint be set to FALSE, * even if the removable flag of this AND-constraint is set to TRUE? */ SCIP_EXPORT SCIP_RETCODE SCIPchgAndConsRemovableFlagWhenUpgr( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons, /**< constraint data */ SCIP_Bool flag /**< should an arising constraint from the given AND-constraint be not * removable, even if the removable flag of the AND-constraint is set to * TRUE */ ); /** @} */ /** @} */ #ifdef __cplusplus } #endif #endif