Scippy

SCIP

Solving Constraint Integer Programs

expr_log.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_log.h
17  * @ingroup EXPRHDLRS
18  * @brief logarithm expression handler
19  * @author Stefan Vigerske
20  * @author Benjamin Mueller
21  */
22 
23 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
24 
25 #ifndef __SCIP_EXPR_LOG_H__
26 #define __SCIP_EXPR_LOG_H__
27 
28 
29 #include "scip/scip.h"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /**@addtogroup EXPRHDLRS
36  *
37  * @{
38  *
39  * @name Logarithm expression
40  *
41  * This expression handler provides the natural logarithm function, that is,
42  * \f[
43  * x \mapsto \ln(x).
44  * \f]
45  *
46  * @{
47  */
48 
49 /** creates a logarithmic expression */
50 SCIP_EXPORT
52  SCIP* scip, /**< SCIP data structure */
53  SCIP_EXPR** expr, /**< pointer where to store expression */
54  SCIP_EXPR* child, /**< single child */
55  SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), /**< function to call to create ownerdata */
56  void* ownercreatedata /**< data to pass to ownercreate */
57  );
58 
59 /** indicates whether expression is of log-type */
60 SCIP_EXPORT
62  SCIP* scip, /**< SCIP data structure */
63  SCIP_EXPR* expr /**< expression */
64  );
65 
66 /** @}
67  * @}
68  */
69 
70 /** creates the handler for logarithmic expression and includes it into SCIP
71  *
72  * @ingroup ExprhdlrIncludes
73  */
74 SCIP_EXPORT
76  SCIP* scip /**< SCIP data structure */
77  );
78 
79 #ifdef __cplusplus
80 }
81 #endif
82 
83 #endif /* __SCIP_EXPR_LOG_H__ */
SCIP_RETCODE SCIPincludeExprhdlrLog(SCIP *scip)
Definition: expr_log.c:585
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_Bool SCIPisExprLog(SCIP *scip, SCIP_EXPR *expr)
Definition: expr_log.c:638
#define SCIP_Bool
Definition: def.h:84
#define SCIP_DECL_EXPR_OWNERCREATE(x)
Definition: type_expr.h:131
SCIP_RETCODE SCIPcreateExprLog(SCIP *scip, SCIP_EXPR **expr, SCIP_EXPR *child, SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), void *ownercreatedata)
Definition: expr_log.c:620
SCIP callable library.