Scippy

SCIP

Solving Constraint Integer Programs

expr_value.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_value.h
17  * @ingroup EXPRHDLRS
18  * @brief constant value expression handler
19  * @author Stefan Vigerske
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_EXPR_VALUE_H__
25 #define __SCIP_EXPR_VALUE_H__
26 
27 #include "scip/scip.h"
28 #include "scip/type_expr.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /** creates the handler for constant value expression and includes it into SCIP
35  *
36  * @ingroup ExprhdlrIncludes
37  */
38 SCIP_EXPORT
40  SCIP* scip /**< SCIP data structure */
41  );
42 
43 /**@addtogroup EXPRHDLRS
44  *
45  * @{
46  *
47  * @name Constant value expression
48  *
49  * This expression handler handles a constant value. It cannot have children.
50  * @{
51  */
52 
53 /** creates constant value expression */
54 SCIP_EXPORT
56  SCIP* scip, /**< SCIP data structure */
57  SCIP_EXPR** expr, /**< pointer where to store expression */
58  SCIP_Real value, /**< value to be stored */
59  SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), /**< function to call to create ownerdata */
60  void* ownercreatedata /**< data to pass to ownercreate */
61  );
62 
63 /** @}
64  * @}
65  */
66 
67 #ifdef __cplusplus
68 }
69 #endif
70 
71 #endif /* __SCIPEXPR_VALUE_H__ */
SCIP_RETCODE SCIPincludeExprhdlrValue(SCIP *scip)
Definition: expr_value.c:236
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_RETCODE SCIPcreateExprValue(SCIP *scip, SCIP_EXPR **expr, SCIP_Real value, SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), void *ownercreatedata)
Definition: expr_value.c:261
#define SCIP_DECL_EXPR_OWNERCREATE(x)
Definition: type_expr.h:131
type and macro definitions related to algebraic expressions
#define SCIP_Real
Definition: def.h:177
SCIP callable library.