Scippy

SCIP

Solving Constraint Integer Programs

cons_abspower.h
Go to the documentation of this file.
1/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2/* */
3/* This file is part of the program and library */
4/* SCIP --- Solving Constraint Integer Programs */
5/* */
6/* Copyright (c) 2002-2024 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.h
26 * @ingroup CONSHDLRS
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#ifndef __SCIP_CONS_ABSPOWER_H__
34#define __SCIP_CONS_ABSPOWER_H__
35
36#include "scip/def.h"
37#include "scip/type_cons.h"
38#include "scip/type_retcode.h"
39#include "scip/type_scip.h"
40#include "scip/type_var.h"
41#include "scip/type_nlp.h"
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
47/**@addtogroup CONSHDLRS
48 *
49 * @{
50 *
51 * @name Abspower Constraints (deprecated)
52 *
53 * @{
54 *
55 */
56
57/** creates and captures an absolute power nonlinear constraint
58 *
59 * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
60 *
61 * @deprecated Use SCIPcreateConsNonlinear() instead.
62 */
63SCIP_EXPORT
65 SCIP* scip, /**< SCIP data structure */
66 SCIP_CONS** cons, /**< pointer to hold the created constraint */
67 const char* name, /**< name of constraint */
68 SCIP_VAR* x, /**< nonlinear variable x in constraint */
69 SCIP_VAR* z, /**< linear variable z in constraint */
70 SCIP_Real exponent, /**< exponent n of |x+offset|^n term in constraint */
71 SCIP_Real xoffset, /**< offset in |x+offset|^n term in constraint */
72 SCIP_Real zcoef, /**< coefficient of z in constraint */
73 SCIP_Real lhs, /**< left hand side of constraint */
74 SCIP_Real rhs, /**< right hand side of constraint */
75 SCIP_Bool initial, /**< should the LP relaxation of constraint be in the initial LP?
76 * Usually set to TRUE. Set to FALSE for 'lazy constraints'. */
77 SCIP_Bool separate, /**< should the constraint be separated during LP processing?
78 * Usually set to TRUE. */
79 SCIP_Bool enforce, /**< should the constraint be enforced during node processing?
80 * TRUE for model constraints, FALSE for additional, redundant constraints. */
81 SCIP_Bool check, /**< should the constraint be checked for feasibility?
82 * TRUE for model constraints, FALSE for additional, redundant constraints. */
83 SCIP_Bool propagate, /**< should the constraint be propagated during node processing?
84 * Usually set to TRUE. */
85 SCIP_Bool local, /**< is constraint only valid locally?
86 * Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */
87 SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)?
88 * Usually set to FALSE. In column generation applications, set to TRUE if pricing
89 * adds coefficients to this constraint. */
90 SCIP_Bool dynamic, /**< is constraint subject to aging?
91 * Usually set to FALSE. Set to TRUE for own cuts which
92 * are separated as constraints. */
93 SCIP_Bool removable, /**< should the relaxation be removed from the LP due to aging or cleanup?
94 * Usually set to FALSE. Set to TRUE for 'lazy constraints' and 'user cuts'. */
95 SCIP_Bool stickingatnode /**< should the constraint always be kept at the node where it was added, even
96 * if it may be moved to a more global node?
97 * Usually set to FALSE. Set to TRUE to for constraints that represent node data. */
98 );
99
100/** creates and captures an absolute power nonlinear constraint
101 * in its most basic version, i.e., all constraint flags are set to their basic value
102 *
103 * All flags can be set via SCIPconsSetFLAGNAME-methods.
104 *
105 * @see SCIPcreateConsAbspower() for information about the basic constraint flag configuration
106 *
107 * @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
108 *
109 * @deprecated Use SCIPcreateConsBasicNonlinear() instead.
110 */
111SCIP_EXPORT
113 SCIP* scip, /**< SCIP data structure */
114 SCIP_CONS** cons, /**< pointer to hold the created constraint */
115 const char* name, /**< name of constraint */
116 SCIP_VAR* x, /**< nonlinear variable x in constraint */
117 SCIP_VAR* z, /**< linear variable z in constraint */
118 SCIP_Real exponent, /**< exponent n of |x+offset|^n term in constraint */
119 SCIP_Real xoffset, /**< offset in |x+offset|^n term in constraint */
120 SCIP_Real zcoef, /**< coefficient of z in constraint */
121 SCIP_Real lhs, /**< left hand side of constraint */
122 SCIP_Real rhs /**< right hand side of constraint */
123 );
124
125/** gets the absolute power constraint as a nonlinear row representation
126 *
127 * @deprecated Use SCIPgetNlRowNonlinear() instead.
128 */
129SCIP_EXPORT
131 SCIP* scip, /**< SCIP data structure */
132 SCIP_CONS* cons, /**< constraint */
133 SCIP_NLROW** nlrow /**< a buffer where to store pointer to nonlinear row */
134 );
135
136/** @} */
137
138/** @} */
139
140#ifdef __cplusplus
141}
142#endif
143
144#endif
SCIP_VAR ** x
Definition: circlepacking.c:63
common defines and data types used in all packages of SCIP
#define SCIP_Bool
Definition: def.h:91
#define SCIP_Real
Definition: def.h:173
SCIP_RETCODE SCIPcreateConsBasicAbspower(SCIP *scip, SCIP_CONS **cons, const char *name, SCIP_VAR *x, SCIP_VAR *z, SCIP_Real exponent, SCIP_Real xoffset, SCIP_Real zcoef, SCIP_Real lhs, SCIP_Real rhs)
SCIP_RETCODE SCIPcreateConsAbspower(SCIP *scip, SCIP_CONS **cons, const char *name, SCIP_VAR *x, SCIP_VAR *z, SCIP_Real exponent, SCIP_Real xoffset, SCIP_Real zcoef, SCIP_Real lhs, SCIP_Real rhs, SCIP_Bool initial, SCIP_Bool separate, SCIP_Bool enforce, SCIP_Bool check, SCIP_Bool propagate, SCIP_Bool local, SCIP_Bool modifiable, SCIP_Bool dynamic, SCIP_Bool removable, SCIP_Bool stickingatnode)
Definition: cons_abspower.c:43
SCIP_RETCODE SCIPgetNlRowAbspower(SCIP *scip, SCIP_CONS *cons, SCIP_NLROW **nlrow)
type definitions for constraints and constraint handlers
type definitions for NLP management
type definitions for return codes for SCIP methods
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for SCIP's main datastructure
type definitions for problem variables