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