Scippy

SCIP

Solving Constraint Integer Programs

pub_misc_nonlinear.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-2021 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file pub_misc_nonlinear.h
17  * @ingroup INTERNALAPI
18  * @brief internal miscellaneous methods for nonlinear constraints
19  * @author Stephen J. Maher
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_MISC_NONLINEAR_H__
25 #define __SCIP_MISC_NONLINEAR_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_retcode.h"
30 #include "scip/type_cons.h"
31 #include "scip/type_var.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 /** returns the right-hand side of an arbitrary SCIP constraint that can be represented as a single nonlinear constraint
38  *
39  * @note The success pointer indicates if the individual contraint handler was able to return the involved values
40  */
42  SCIP* scip, /**< SCIP data structure */
43  SCIP_CONS* cons, /**< constraint for which right-hand side is queried */
44  SCIP_Bool* success /**< pointer to store whether a valid right-hand side was returned */
45  );
46 
47 /** returns the left-hand side of an arbitrary SCIP constraint that can be represented as a single nonlinear constraint
48  *
49  * @note The success pointer indicates if the individual contraint handler was able to return the involved values
50  */
52  SCIP* scip, /**< SCIP data structure */
53  SCIP_CONS* cons, /**< constraint to get left-hand side for */
54  SCIP_Bool* success /**< pointer to store whether a valid left-hand side was returned */
55  );
56 
57 /** adds the given variable to the input constraint. */
59  SCIP* scip, /**< SCIP data structure */
60  SCIP_CONS* cons, /**< constraint for which row is queried */
61  SCIP_VAR* var, /**< variable of the constraint entry */
62  SCIP_Real val /**< the coefficient of the constraint entry */
63  );
64 
65 #ifdef __cplusplus
66 }
67 #endif
68 
69 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPconsNonlinearAddLinearCoef(SCIP *scip, SCIP_CONS *cons, SCIP_VAR *var, SCIP_Real val)
type definitions for problem variables
#define SCIP_Bool
Definition: def.h:70
SCIP_Real SCIPconsNonlinearGetRhs(SCIP *scip, SCIP_CONS *cons, SCIP_Bool *success)
SCIP_Real SCIPconsNonlinearGetLhs(SCIP *scip, SCIP_CONS *cons, SCIP_Bool *success)
#define SCIP_Real
Definition: def.h:163
common defines and data types used in all packages of SCIP
type definitions for constraints and constraint handlers