1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 2 /* */ 3 /* This file is part of the program and library */ 4 /* SCIP --- Solving Constraint Integer Programs */ 5 /* */ 6 /* Copyright (c) 2002-2023 Zuse Institute Berlin (ZIB) */ 7 /* */ 8 /* Licensed under the Apache License, Version 2.0 (the "License"); */ 9 /* you may not use this file except in compliance with the License. */ 10 /* You may obtain a copy of the License at */ 11 /* */ 12 /* http://www.apache.org/licenses/LICENSE-2.0 */ 13 /* */ 14 /* Unless required by applicable law or agreed to in writing, software */ 15 /* distributed under the License is distributed on an "AS IS" BASIS, */ 16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */ 17 /* See the License for the specific language governing permissions and */ 18 /* limitations under the License. */ 19 /* */ 20 /* You should have received a copy of the Apache-2.0 license */ 21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */ 22 /* */ 23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 24 25 /**@file cons_abspower.c 26 * @ingroup DEFPLUGINS_CONS 27 * @brief some API functions of removed constraint handler for absolute power constraints \f$\textrm{lhs} \leq \textrm{sign}(x+a) |x+a|^n + c z \leq \textrm{rhs}\f$ 28 * @author Stefan Vigerske 29 */ 30 31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ 32 33 #include "scip/cons_abspower.h" 34 #include "scip/cons_nonlinear.h" 35 36 37 /** creates and captures an absolute power nonlinear constraint 38 * 39 * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons() 40 * 41 * @deprecated Use SCIPcreateConsNonlinear() instead. 42 */ 43 SCIP_DEPRECATED 44 SCIP_RETCODE SCIPcreateConsAbspower( 45 SCIP* scip, /**< SCIP data structure */ 46 SCIP_CONS** cons, /**< pointer to hold the created constraint */ 47 const char* name, /**< name of constraint */ 48 SCIP_VAR* x, /**< nonlinear variable x in constraint */ 49 SCIP_VAR* z, /**< linear variable z in constraint */ 50 SCIP_Real exponent, /**< exponent n of |x+offset|^n term in constraint */ 51 SCIP_Real xoffset, /**< offset in |x+offset|^n term in constraint */ 52 SCIP_Real zcoef, /**< coefficient of z in constraint */ 53 SCIP_Real lhs, /**< left hand side of constraint */ 54 SCIP_Real rhs, /**< right hand side of constraint */ 55 SCIP_Bool initial, /**< should the LP relaxation of constraint be in the initial LP? 56 * Usually set to TRUE. Set to FALSE for 'lazy constraints'. */ 57 SCIP_Bool separate, /**< should the constraint be separated during LP processing? 58 * Usually set to TRUE. */ 59 SCIP_Bool enforce, /**< should the constraint be enforced during node processing? 60 * TRUE for model constraints, FALSE for additional, redundant constraints. */ 61 SCIP_Bool check, /**< should the constraint be checked for feasibility? 62 * TRUE for model constraints, FALSE for additional, redundant constraints. */ 63 SCIP_Bool propagate, /**< should the constraint be propagated during node processing? 64 * Usually set to TRUE. */ 65 SCIP_Bool local, /**< is constraint only valid locally? 66 * Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */ 67 SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)? 68 * Usually set to FALSE. In column generation applications, set to TRUE if pricing 69 * adds coefficients to this constraint. */ 70 SCIP_Bool dynamic, /**< is constraint subject to aging? 71 * Usually set to FALSE. Set to TRUE for own cuts which 72 * are separated as constraints. */ 73 SCIP_Bool removable, /**< should the relaxation be removed from the LP due to aging or cleanup? 74 * Usually set to FALSE. Set to TRUE for 'lazy constraints' and 'user cuts'. */ 75 SCIP_Bool stickingatnode /**< should the constraint always be kept at the node where it was added, even 76 * if it may be moved to a more global node? 77 * Usually set to FALSE. Set to TRUE to for constraints that represent node data. */ 78 ) 79 { 80 SCIP_CALL( SCIPcreateConsBasicSignpowerNonlinear(scip, cons, name, x, z, exponent, xoffset, zcoef, lhs, rhs) ); 81 82 SCIP_CALL( SCIPsetConsInitial(scip, *cons, initial) ); 83 SCIP_CALL( SCIPsetConsSeparated(scip, *cons, separate) ); 84 SCIP_CALL( SCIPsetConsEnforced(scip, *cons, enforce) ); 85 SCIP_CALL( SCIPsetConsChecked(scip, *cons, check) ); 86 SCIP_CALL( SCIPsetConsPropagated(scip, *cons, propagate) ); 87 SCIP_CALL( SCIPsetConsLocal(scip, *cons, local) ); 88 SCIP_CALL( SCIPsetConsModifiable(scip, *cons, modifiable) ); 89 SCIP_CALL( SCIPsetConsDynamic(scip, *cons, dynamic) ); 90 SCIP_CALL( SCIPsetConsRemovable(scip, *cons, removable) ); 91 SCIP_CALL( SCIPsetConsStickingAtNode(scip, *cons, stickingatnode) ); 92 93 return SCIP_OKAY; 94 } 95 96 /** creates and captures an absolute power nonlinear constraint 97 * in its most basic version, i.e., all constraint flags are set to their basic value 98 * 99 * All flags can be set via SCIPconsSetFLAGNAME-methods. 100 * 101 * @see SCIPcreateConsAbspower() for information about the basic constraint flag configuration 102 * 103 * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons() 104 * 105 * @deprecated Use SCIPcreateConsBasicNonlinear() instead. 106 */ 107 SCIP_DEPRECATED 108 SCIP_RETCODE SCIPcreateConsBasicAbspower( 109 SCIP* scip, /**< SCIP data structure */ 110 SCIP_CONS** cons, /**< pointer to hold the created constraint */ 111 const char* name, /**< name of constraint */ 112 SCIP_VAR* x, /**< nonlinear variable x in constraint */ 113 SCIP_VAR* z, /**< linear variable z in constraint */ 114 SCIP_Real exponent, /**< exponent n of |x+offset|^n term in constraint */ 115 SCIP_Real xoffset, /**< offset in |x+offset|^n term in constraint */ 116 SCIP_Real zcoef, /**< coefficient of z in constraint */ 117 SCIP_Real lhs, /**< left hand side of constraint */ 118 SCIP_Real rhs /**< right hand side of constraint */ 119 ) 120 { 121 SCIP_CALL( SCIPcreateConsBasicSignpowerNonlinear(scip, cons, name, x, z, exponent, xoffset, zcoef, lhs, rhs) ); 122 123 return SCIP_OKAY; 124 } 125 126 /** gets the absolute power constraint as a nonlinear row representation 127 * 128 * @deprecated Use SCIPgetNlRowNonlinear)_ instead. 129 */ 130 SCIP_DEPRECATED 131 SCIP_RETCODE SCIPgetNlRowAbspower( 132 SCIP* scip, /**< SCIP data structure */ 133 SCIP_CONS* cons, /**< constraint */ 134 SCIP_NLROW** nlrow /**< a buffer where to store pointer to nonlinear row */ 135 ) 136 { 137 assert(cons != NULL); 138 assert(strcmp(SCIPconshdlrGetName(SCIPconsGetHdlr(cons)), "nonlinear") == 0); 139 140 SCIP_CALL( SCIPgetNlRowNonlinear(scip, cons, nlrow) ); 141 142 return SCIP_OKAY; 143 } 144