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