Scippy

SCIP

Solving Constraint Integer Programs

expr_var.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-2022 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 email to scip@zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file expr_var.h
17  * @ingroup EXPRHDLRS
18  * @brief variable expression handler
19  * @author Stefan Vigerske
20  * @author Benjamin Mueller
21  * @author Felipe Serrano
22  */
23 
24 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
25 
26 #ifndef __SCIP_EXPR_VAR_H__
27 #define __SCIP_EXPR_VAR_H__
28 
29 #include "scip/scip.h"
30 #include "scip/type_expr.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** creates the handler for variable expression and includes it into SCIP
37  *
38  * @ingroup ExprhdlrIncludes
39  */
40 SCIP_EXPORT
42  SCIP* scip /**< SCIP data structure */
43  );
44 
45 /**@addtogroup EXPRHDLRS
46  *
47  * @{
48  *
49  * @name SCIP variable expression
50  *
51  * This expression handler handles a SCIP variables. It cannot have children.
52  * @{
53  */
54 
55 /** creates a variable expression */
56 SCIP_EXPORT
58  SCIP* scip, /**< SCIP data structure */
59  SCIP_EXPR** expr, /**< pointer where to store expression */
60  SCIP_VAR* var, /**< variable to be stored */
61  SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), /**< function to call to create ownerdata */
62  void* ownercreatedata /**< data to pass to ownercreate */
63  );
64 
65 /** @}
66  * @}
67  */
68 
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif /* __SCIP_EXPR_VAR_H__ */
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_RETCODE SCIPcreateExprVar(SCIP *scip, SCIP_EXPR **expr, SCIP_VAR *var, SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), void *ownercreatedata)
Definition: expr_var.c:381
#define SCIP_DECL_EXPR_OWNERCREATE(x)
Definition: type_expr.h:131
SCIP_RETCODE SCIPincludeExprhdlrVar(SCIP *scip)
Definition: expr_var.c:356
type and macro definitions related to algebraic expressions
SCIP callable library.