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_entropy.h 26 * @ingroup EXPRHDLRS 27 * @brief handler for -x*log(x) expressions 28 * @author Benjamin Mueller 29 * @author Fabian Wegscheider 30 */ 31 32 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ 33 34 #ifndef __SCIP_EXPR_ENTROPY_H__ 35 #define __SCIP_EXPR_ENTROPY_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 /** creates the handler for entropy expressions and includes it into SCIP 46 * 47 * @ingroup ExprhdlrIncludes 48 */ 49 SCIP_EXPORT 50 SCIP_RETCODE SCIPincludeExprhdlrEntropy( 51 SCIP* scip /**< SCIP data structure */ 52 ); 53 54 /**@addtogroup EXPRHDLRS 55 * 56 * @{ 57 * 58 * @name Entropy value expression 59 * 60 * This expression handler provides the entropy function, that is, 61 * \f[ 62 * x \mapsto \begin{cases} 63 * -x\log(x), & \mathrm{if} x > 0,\\ 64 * 0, & \mathrm{if} x = 0, \\ 65 * \mathrm{undefined}, & \mathrm{else}. 66 * \end{cases} 67 * \f] 68 * 69 * @{ 70 */ 71 72 /** creates an entropy expression */ 73 SCIP_EXPORT 74 SCIP_RETCODE SCIPcreateExprEntropy( 75 SCIP* scip, /**< SCIP data structure */ 76 SCIP_EXPR** expr, /**< pointer where to store expression */ 77 SCIP_EXPR* child, /**< child expression */ 78 SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), /**< function to call to create ownerdata */ 79 void* ownercreatedata /**< data to pass to ownercreate */ 80 ); 81 82 /** indicates whether expression is of entropy-type */ 83 SCIP_EXPORT 84 SCIP_Bool SCIPisExprEntropy( 85 SCIP* scip, /**< SCIP data structure */ 86 SCIP_EXPR* expr /**< expression */ 87 ); 88 89 /** @} 90 * @} 91 */ 92 93 #ifdef __cplusplus 94 } 95 #endif 96 97 #endif /* __SCIP_EXPR_ENTROPY_H__ */ 98