/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* */ /* 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_knapsack.h * @ingroup CONSHDLRS * @brief Constraint handler for knapsack constraints of the form \f$a^T x \le b\f$, x binary and \f$a \ge 0\f$. * @author Tobias Achterberg * @author Kati Wolter * @author Michael Winkler * */ /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ #ifndef __SCIP_CONS_KNAPSACK_H__ #define __SCIP_CONS_KNAPSACK_H__ #include "scip/def.h" #include "scip/type_cons.h" #include "scip/type_lp.h" #include "scip/type_retcode.h" #include "scip/type_scip.h" #include "scip/type_sepa.h" #include "scip/type_sol.h" #include "scip/type_var.h" #ifdef __cplusplus extern "C" { #endif /** creates the handler for knapsack constraints and includes it in SCIP * * @ingroup ConshdlrIncludes * */ SCIP_EXPORT SCIP_RETCODE SCIPincludeConshdlrKnapsack( SCIP* scip /**< SCIP data structure */ ); /**@addtogroup CONSHDLRS * * @{ * * @name Knapsack Constraints * * @{ * * This constraint handler handles a special type of linear constraints, namely knapsack constraints. * A knapsack constraint has the form * \f[ * \sum_{i=1}^n a_i x_i \leq b * \f] * with non-negative integer coefficients \f$a_i\f$, integer right-hand side \f$b\f$, and binary variables \f$x_i\f$. */ /** creates and captures a knapsack constraint * * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons() */ SCIP_EXPORT SCIP_RETCODE SCIPcreateConsKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS** cons, /**< pointer to hold the created constraint */ const char* name, /**< name of constraint */ int nvars, /**< number of items in the knapsack */ SCIP_VAR** vars, /**< array with item variables */ SCIP_Longint* weights, /**< array with item weights */ SCIP_Longint capacity, /**< capacity of knapsack (right hand side of inequality) */ 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 a knapsack constraint * in its most basic version, i. e., all constraint flags are set to their basic value as explained for the * method SCIPcreateConsKnapsack(); all flags can be set via SCIPsetConsFLAGNAME-methods in scip.h * * @see SCIPcreateConsKnapsack() 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 SCIPcreateConsBasicKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS** cons, /**< pointer to hold the created constraint */ const char* name, /**< name of constraint */ int nvars, /**< number of items in the knapsack */ SCIP_VAR** vars, /**< array with item variables */ SCIP_Longint* weights, /**< array with item weights */ SCIP_Longint capacity /**< capacity of knapsack */ ); /** adds new item to knapsack constraint */ SCIP_EXPORT SCIP_RETCODE SCIPaddCoefKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons, /**< constraint data */ SCIP_VAR* var, /**< item variable */ SCIP_Longint weight /**< item weight */ ); /** gets the capacity of the knapsack constraint */ SCIP_EXPORT SCIP_Longint SCIPgetCapacityKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** changes capacity of the knapsack constraint * * @note This method can only be called during problem creation stage (SCIP_STAGE_PROBLEM) */ SCIP_EXPORT SCIP_RETCODE SCIPchgCapacityKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons, /**< constraint data */ SCIP_Longint capacity /**< new capacity of knapsack */ ); /** gets the number of items in the knapsack constraint */ SCIP_EXPORT int SCIPgetNVarsKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** gets the array of variables in the knapsack constraint; the user must not modify this array! */ SCIP_EXPORT SCIP_VAR** SCIPgetVarsKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** gets the array of weights in the knapsack constraint; the user must not modify this array! */ SCIP_EXPORT SCIP_Longint* SCIPgetWeightsKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** gets the dual solution of the knapsack constraint in the current LP */ SCIP_EXPORT SCIP_Real SCIPgetDualsolKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** gets the dual Farkas value of the knapsack constraint in the current infeasible LP */ SCIP_EXPORT SCIP_Real SCIPgetDualfarkasKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** returns the linear relaxation of the given knapsack constraint; may return NULL if no LP row was yet created; * the user must not modify the row! */ SCIP_EXPORT SCIP_ROW* SCIPgetRowKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons /**< constraint data */ ); /** solves knapsack problem in maximization form exactly using dynamic programming; * if needed, one can provide arrays to store all selected items and all not selected items * * @note in case you provide the solitems or nonsolitems array you also have to provide the counter part, as well * * @note the algorithm will first compute a greedy solution and terminate * if the greedy solution is proven to be optimal. * The dynamic programming algorithm runs with a time and space complexity * of O(nitems * capacity). */ SCIP_EXPORT SCIP_RETCODE SCIPsolveKnapsackExactly( SCIP* scip, /**< SCIP data structure */ int nitems, /**< number of available items */ SCIP_Longint* weights, /**< item weights */ SCIP_Real* profits, /**< item profits */ SCIP_Longint capacity, /**< capacity of knapsack */ int* items, /**< item numbers */ int* solitems, /**< array to store items in solution, or NULL */ int* nonsolitems, /**< array to store items not in solution, or NULL */ int* nsolitems, /**< pointer to store number of items in solution, or NULL */ int* nnonsolitems, /**< pointer to store number of items not in solution, or NULL */ SCIP_Real* solval, /**< pointer to store optimal solution value, or NULL */ SCIP_Bool* success /**< pointer to store if an error occured during solving * (normally a memory problem) */ ); /** solves knapsack problem in maximization form approximately by solving the LP-relaxation of the problem using Dantzig's * method and rounding down the solution; if needed, one can provide arrays to store all selected items and all not * selected items */ SCIP_EXPORT SCIP_RETCODE SCIPsolveKnapsackApproximately( SCIP* scip, /**< SCIP data structure */ int nitems, /**< number of available items */ SCIP_Longint* weights, /**< item weights */ SCIP_Real* profits, /**< item profits */ SCIP_Longint capacity, /**< capacity of knapsack */ int* items, /**< item numbers */ int* solitems, /**< array to store items in solution, or NULL */ int* nonsolitems, /**< array to store items not in solution, or NULL */ int* nsolitems, /**< pointer to store number of items in solution, or NULL */ int* nnonsolitems, /**< pointer to store number of items not in solution, or NULL */ SCIP_Real* solval /**< pointer to store optimal solution value, or NULL */ ); /** separates different classes of valid inequalities for the 0-1 knapsack problem */ SCIP_EXPORT SCIP_RETCODE SCIPseparateKnapsackCuts( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons, /**< originating constraint of the knapsack problem, or NULL */ SCIP_SEPA* sepa, /**< originating separator of the knapsack problem, or NULL */ SCIP_VAR** vars, /**< variables in knapsack constraint */ int nvars, /**< number of variables in knapsack constraint */ SCIP_Longint* weights, /**< weights of variables in knapsack constraint */ SCIP_Longint capacity, /**< capacity of knapsack */ SCIP_SOL* sol, /**< primal SCIP solution to separate, NULL for current LP solution */ SCIP_Bool usegubs, /**< should GUB information be used for separation? */ SCIP_Bool* cutoff, /**< pointer to store whether a cutoff has been detected */ int* ncuts /**< pointer to add up the number of found cuts */ ); /* relaxes given general linear constraint into a knapsack constraint and separates lifted knapsack cover inequalities */ SCIP_EXPORT SCIP_RETCODE SCIPseparateRelaxedKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_CONS* cons, /**< originating constraint of the knapsack problem, or NULL */ SCIP_SEPA* sepa, /**< originating separator of the knapsack problem, or NULL */ int nknapvars, /**< number of variables in the continuous knapsack constraint */ SCIP_VAR** knapvars, /**< variables in the continuous knapsack constraint */ SCIP_Real* knapvals, /**< coefficients of the variables in the continuous knapsack constraint */ SCIP_Real valscale, /**< -1.0 if lhs of row is used as rhs of c. k. constraint, +1.0 otherwise */ SCIP_Real rhs, /**< right hand side of the continuous knapsack constraint */ SCIP_SOL* sol, /**< primal CIP solution, NULL for current LP solution */ SCIP_Bool* cutoff, /**< pointer to store whether a cutoff was found */ int* ncuts /**< pointer to add up the number of found cuts */ ); /** cleans up (multi-)aggregations and fixings from knapsack constraints */ SCIP_EXPORT SCIP_RETCODE SCIPcleanupConssKnapsack( SCIP* scip, /**< SCIP data structure */ SCIP_Bool onlychecked, /**< should only checked constraints be cleaned up? */ SCIP_Bool* infeasible /**< pointer to return whether the problem was detected to be infeasible */ ); /** @} */ /** @} */ #ifdef __cplusplus } #endif #endif