1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the program and library */
/* SCIP --- Solving Constraint Integer Programs */
/* */
/* Copyright 2002-2022 Zuse Institute Berlin */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* */
/* You should have received a copy of the Apache-2.0 license */
/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file expr_varidx.h
* @ingroup EXPRHDLRS
* @brief handler for variable index expressions
* @author Benjamin Mueller
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_EXPR_VARIDX_H__
#define __SCIP_EXPR_VARIDX_H__
#include "scip/type_scip.h"
#include "scip/type_expr.h"
#ifdef __cplusplus
extern "C" {
#endif
/** creates the handler for variable index expressions and includes it into SCIP
*
* @ingroup ExprhdlrIncludes
*/
SCIP_EXPORT
SCIP_RETCODE SCIPincludeExprhdlrVaridx(
SCIP* scip /**< SCIP data structure */
);
/**@addtogroup EXPRHDLRS
*
* @{
*
* @name Index variable expression
*
* This expression handler handles a variable that is given by a variable index. It cannot have children.
*
* This expression handler is used for expressions that are passed to a NLP solver via the NLPI.
* @{
*/
/** creates a variable index expression */
SCIP_EXPORT
SCIP_RETCODE SCIPcreateExprVaridx(
SCIP* scip, /**< SCIP data structure */
SCIP_EXPR** expr, /**< pointer where to store expression */
int varidx, /**< variable index to represent */
SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), /**< function to call to create ownerdata */
void* ownercreatedata /**< data to pass to ownercreate */
);
/** indicates whether expression is varidx expression */
SCIP_EXPORT
SCIP_Bool SCIPisExprVaridx(
SCIP* scip, /**< SCIP data structure */
SCIP_EXPR* expr /**< expression */
);
/** gives the index stored in a varidx expression */
SCIP_EXPORT
int SCIPgetIndexExprVaridx(
SCIP_EXPR* expr /**< varindex expression */
);
/** sets the index stored in a varidx expression */
SCIP_EXPORT
void SCIPsetIndexExprVaridx(
SCIP_EXPR* expr, /**< varindex expression */
int newindex /**< new index */
);
/** @}
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* __SCIP_EXPR_VARIDX_H__ */