SCIP Doxygen Documentation
Loading...
Searching...
No Matches
expr_abs.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_abs.h
26
* @ingroup EXPRHDLRS
27
* @brief absolute expression handler
28
* @author Stefan Vigerske
29
* @author Benjamin Mueller
30
*/
31
32
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
33
34
#ifndef __SCIP_EXPR_ABS_H__
35
#define __SCIP_EXPR_ABS_H__
36
37
38
#include "
scip/scip.h
"
39
#include "
scip/type_expr.h
"
40
41
#ifdef __cplusplus
42
extern
"C"
{
43
#endif
44
45
/**@addtogroup EXPRHDLRS
46
*
47
* @{
48
*
49
* @name Absolute value expression
50
*
51
* This expression handler provides the absolute-value function, that is,
52
* \f[
53
* x \mapsto |x|.
54
* \f]
55
*
56
* @{
57
*/
58
59
/** creates an absolute value expression */
60
SCIP_EXPORT
61
SCIP_RETCODE
SCIPcreateExprAbs
(
62
SCIP
*
scip
,
/**< SCIP data structure */
63
SCIP_EXPR
** expr,
/**< pointer where to store expression */
64
SCIP_EXPR
* child,
/**< single child */
65
SCIP_DECL_EXPR_OWNERCREATE
((*
ownercreate
)),
/**< function to call to create ownerdata */
66
void
*
ownercreatedata
/**< data to pass to ownercreate */
67
);
68
69
/** indicates whether expression is of abs-type */
70
SCIP_EXPORT
71
SCIP_Bool
SCIPisExprAbs
(
72
SCIP
*
scip
,
/**< SCIP data structure */
73
SCIP_EXPR
* expr
/**< expression */
74
);
75
76
/** @}
77
* @}
78
*/
79
80
/** creates the handler for absolute expression and includes it into SCIP
81
*
82
* @ingroup ExprhdlrIncludes
83
*/
84
SCIP_EXPORT
85
SCIP_RETCODE
SCIPincludeExprhdlrAbs
(
86
SCIP
*
scip
/**< SCIP data structure */
87
);
88
89
#ifdef __cplusplus
90
}
91
#endif
92
93
#endif
/* __SCIP_EXPR_ABS_H__ */
SCIPisExprAbs
SCIP_Bool SCIPisExprAbs(SCIP *scip, SCIP_EXPR *expr)
Definition
expr_abs.c:546
SCIPcreateExprAbs
SCIP_RETCODE SCIPcreateExprAbs(SCIP *scip, SCIP_EXPR **expr, SCIP_EXPR *child, SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), void *ownercreatedata)
Definition
expr_abs.c:528
SCIPincludeExprhdlrAbs
SCIP_RETCODE SCIPincludeExprhdlrAbs(SCIP *scip)
Definition
expr_abs.c:502
i
int i
Definition
heur_rootsoldiving.c:212
scip
Definition
objbenders.h:44
scip.h
SCIP callable library.
SCIP_Expr
Definition
struct_expr.h:105
Scip
Definition
struct_scip.h:69
type_expr.h
type and macro definitions related to algebraic expressions
SCIP_DECL_EXPR_OWNERCREATE
#define SCIP_DECL_EXPR_OWNERCREATE(x)
Definition
type_expr.h:140
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition
type_retcode.h:63
expr_abs.h
© 2002-2023 by Zuse Institute Berlin (ZIB),
Imprint
Generated by
1.10.0