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_log.h
26   	 * @ingroup EXPRHDLRS
27   	 * @brief  logarithm 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_LOG_H__
35   	#define __SCIP_EXPR_LOG_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 Logarithm expression
49   	 *
50   	 * This expression handler provides the natural logarithm function, that is,
51   	 * \f[
52   	 *   x \mapsto \ln(x).
53   	 * \f]
54   	 *
55   	 * @{
56   	 */
57   	
58   	/** creates a logarithmic expression */
59   	SCIP_EXPORT
60   	SCIP_RETCODE SCIPcreateExprLog(
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 log-type */
69   	SCIP_EXPORT
70   	SCIP_Bool SCIPisExprLog(
71   	   SCIP*                 scip,               /**< SCIP data structure */
72   	   SCIP_EXPR*            expr                /**< expression */
73   	   );
74   	
75   	/** @}
76   	  * @}
77   	  */
78   	
79   	/** creates the handler for logarithmic expression and includes it into SCIP
80   	 *
81   	 * @ingroup ExprhdlrIncludes
82   	 */
83   	SCIP_EXPORT
84   	SCIP_RETCODE SCIPincludeExprhdlrLog(
85   	   SCIP*                 scip                /**< SCIP data structure */
86   	   );
87   	
88   	#ifdef __cplusplus
89   	}
90   	#endif
91   	
92   	#endif /* __SCIP_EXPR_LOG_H__ */
93