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_soc.h
26   	 * @ingroup CONSHDLRS
27   	 * @brief  some API functions of removed constraint handler for second order cone constraints \f$\sqrt{\gamma + \sum_{i=1}^{n} (\alpha_i\, (x_i + \beta_i))^2} \leq \alpha_{n+1}\, (x_{n+1}+\beta_{n+1})\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_SOC_H__
34   	#define __SCIP_CONS_SOC_H__
35   	
36   	#include "scip/def.h"
37   	#include "scip/type_cons.h"
38   	#include "scip/type_nlp.h"
39   	#include "scip/type_retcode.h"
40   	#include "scip/type_scip.h"
41   	#include "scip/type_var.h"
42   	
43   	#ifdef __cplusplus
44   	extern "C" {
45   	#endif
46   	
47   	/**@addtogroup CONSHDLRS
48   	 *
49   	 * @{
50   	 *
51   	 * @name SOC Constraints (deprecated)
52   	 *
53   	 * @{
54   	 */
55   	
56   	/** creates and captures a second order cone nonlinear constraint
57   	 *
58   	 *  @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
59   	 *
60   	 *  @deprecated Use SCIPcreateConsBasicSOCNonlinear() instead
61   	 */
62   	SCIP_EXPORT
63   	SCIP_DEPRECATED
64   	SCIP_RETCODE SCIPcreateConsSOC(
65   	   SCIP*                 scip,               /**< SCIP data structure */
66   	   SCIP_CONS**           cons,               /**< pointer to hold the created constraint */
67   	   const char*           name,               /**< name of constraint */
68   	   int                   nvars,              /**< number of variables on left hand side of constraint (n) */
69   	   SCIP_VAR**            vars,               /**< array with variables on left hand side (x_i) */
70   	   SCIP_Real*            coefs,              /**< array with coefficients of left hand side variables (alpha_i), or NULL if all 1.0 */
71   	   SCIP_Real*            offsets,            /**< array with offsets of variables (beta_i), or NULL if all 0.0 */
72   	   SCIP_Real             constant,           /**< constant on left hand side (gamma) */
73   	   SCIP_VAR*             rhsvar,             /**< variable on right hand side of constraint (x_{n+1}) */
74   	   SCIP_Real             rhscoeff,           /**< coefficient of variable on right hand side (alpha_{n+1}) */
75   	   SCIP_Real             rhsoffset,          /**< offset of variable on right hand side (beta_{n+1}) */
76   	   SCIP_Bool             initial,            /**< should the LP relaxation of constraint be in the initial LP?
77   	                                              *   Usually set to TRUE. Set to FALSE for 'lazy constraints'. */
78   	   SCIP_Bool             separate,           /**< should the constraint be separated during LP processing?
79   	                                              *   Usually set to TRUE. */
80   	   SCIP_Bool             enforce,            /**< should the constraint be enforced during node processing?
81   	                                              *   TRUE for model constraints, FALSE for additional, redundant constraints. */
82   	   SCIP_Bool             check,              /**< should the constraint be checked for feasibility?
83   	                                              *   TRUE for model constraints, FALSE for additional, redundant constraints. */
84   	   SCIP_Bool             propagate,          /**< should the constraint be propagated during node processing?
85   	                                              *   Usually set to TRUE. */
86   	   SCIP_Bool             local,              /**< is constraint only valid locally?
87   	                                              *   Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */
88   	   SCIP_Bool             modifiable,         /**< is constraint modifiable (subject to column generation)?
89   	                                              *   Usually set to FALSE. In column generation applications, set to TRUE if pricing
90   	                                              *   adds coefficients to this constraint. */
91   	   SCIP_Bool             dynamic,            /**< is constraint subject to aging?
92   	                                              *   Usually set to FALSE. Set to TRUE for own cuts which
93   	                                              *   are separated as constraints. */
94   	   SCIP_Bool             removable           /**< should the relaxation be removed from the LP due to aging or cleanup?
95   	                                              *   Usually set to FALSE. Set to TRUE for 'lazy constraints' and 'user cuts'. */
96   	   );
97   	
98   	/** creates and captures a second order cone nonlinear constraint
99   	 *  in its most basic variant, i. e., with all constraint flags set to their default values, which can be set
100  	 *  afterwards using SCIPsetConsFLAGNAME()
101  	 *
102  	 *  @see SCIPcreateConsSOC() for the default constraint flag configuration
103  	 *
104  	 *  @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
105  	 *
106  	 *  @deprecated Use SCIPcreateConsBasicSOCNonlinear() instead
107  	 */
108  	SCIP_EXPORT
109  	SCIP_DEPRECATED
110  	SCIP_RETCODE SCIPcreateConsBasicSOC(
111  	   SCIP*                 scip,               /**< SCIP data structure */
112  	   SCIP_CONS**           cons,               /**< pointer to hold the created constraint */
113  	   const char*           name,               /**< name of constraint */
114  	   int                   nvars,              /**< number of variables on left hand side of constraint (n) */
115  	   SCIP_VAR**            vars,               /**< array with variables on left hand side (x_i) */
116  	   SCIP_Real*            coefs,              /**< array with coefficients of left hand side variables (alpha_i), or NULL if all 1.0 */
117  	   SCIP_Real*            offsets,            /**< array with offsets of variables (beta_i), or NULL if all 0.0 */
118  	   SCIP_Real             constant,           /**< constant on left hand side (gamma) */
119  	   SCIP_VAR*             rhsvar,             /**< variable on right hand side of constraint (x_{n+1}) */
120  	   SCIP_Real             rhscoeff,           /**< coefficient of variable on right hand side (alpha_{n+1}) */
121  	   SCIP_Real             rhsoffset           /**< offset of variable on right hand side (beta_{n+1}) */
122  	   );
123  	
124  	/** Gets the SOC constraint as a nonlinear row representation.
125  	 *
126  	 * @deprecated Use SCIPgetNlRowNonlinear() instead.
127  	 */
128  	SCIP_EXPORT
129  	SCIP_DEPRECATED
130  	SCIP_RETCODE SCIPgetNlRowSOC(
131  	   SCIP*                 scip,               /**< SCIP data structure */
132  	   SCIP_CONS*            cons,               /**< constraint */
133  	   SCIP_NLROW**          nlrow               /**< pointer to store nonlinear row */
134  	   );
135  	
136  	/** @} */
137  	
138  	/** @} */
139  	
140  	#ifdef __cplusplus
141  	}
142  	#endif
143  	
144  	#endif
145