SCIP Doxygen Documentation
Loading...
Searching...
No Matches
expr_exp.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-2024 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_exp.h
26
* @ingroup EXPRHDLRS
27
* @brief exponential 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_EXP_H__
35
#define __SCIP_EXPR_EXP_H__
36
37
38
#include "
scip/scip.h
"
39
40
#ifdef __cplusplus
41
extern
"C"
{
42
#endif
43
44
/**@addtogroup EXPRHDLRS
45
*
46
* @{
47
*
48
* @name Exponential value expression
49
*
50
* This expression handler provides the exponential function, that is,
51
* \f[
52
* x \mapsto \exp(x).
53
* \f]
54
*
55
* @{
56
*/
57
58
/** creates an exponential expression */
59
SCIP_EXPORT
60
SCIP_RETCODE
SCIPcreateExprExp
(
61
SCIP
*
scip
,
/**< SCIP data structure */
62
SCIP_EXPR
** expr,
/**< pointer where to store expression */
63
SCIP_EXPR
* child,
/**< single child */
64
SCIP_DECL_EXPR_OWNERCREATE
((*ownercreate)),
/**< function to call to create ownerdata */
65
void
* ownercreatedata
/**< data to pass to ownercreate */
66
);
67
68
/** indicates whether expression is of exp-type */
69
SCIP_EXPORT
70
SCIP_Bool
SCIPisExprExp
(
71
SCIP
*
scip
,
/**< SCIP data structure */
72
SCIP_EXPR
* expr
/**< expression */
73
);
74
75
/** @}
76
* @}
77
*/
78
79
/** creates the handler for exponential expressions and includes it into SCIP
80
*
81
* @ingroup ExprhdlrIncludes
82
*/
83
SCIP_EXPORT
84
SCIP_RETCODE
SCIPincludeExprhdlrExp
(
85
SCIP
*
scip
/**< SCIP data structure */
86
);
87
88
#ifdef __cplusplus
89
}
90
#endif
91
92
#endif
/* __SCIP_EXPR_EXP_H__ */
SCIPisExprExp
SCIP_Bool SCIPisExprExp(SCIP *scip, SCIP_EXPR *expr)
Definition
expr_exp.c:528
SCIPcreateExprExp
SCIP_RETCODE SCIPcreateExprExp(SCIP *scip, SCIP_EXPR **expr, SCIP_EXPR *child, SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), void *ownercreatedata)
Definition
expr_exp.c:510
SCIPincludeExprhdlrExp
SCIP_RETCODE SCIPincludeExprhdlrExp(SCIP *scip)
Definition
expr_exp.c:484
scip
Definition
objbenders.h:44
scip.h
SCIP callable library.
SCIP_Expr
Definition
struct_expr.h:106
Scip
Definition
struct_scip.h:70
SCIP_DECL_EXPR_OWNERCREATE
#define SCIP_DECL_EXPR_OWNERCREATE(x)
Definition
type_expr.h:143
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition
type_retcode.h:63
expr_exp.h
© 2002-2024 by Zuse Institute Berlin (ZIB),
Imprint
Generated by
1.12.0