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 pub_compr.h 26 * @ingroup PUBLICCOREAPI 27 * @brief public methods for tree compressions 28 * @author Jakob Witzig 29 */ 30 31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ 32 33 #ifndef __SCIP_PUB_COMPR_H__ 34 #define __SCIP_PUB_COMPR_H__ 35 36 37 #include "scip/def.h" 38 #include "scip/type_misc.h" 39 #include "scip/type_compr.h" 40 41 #ifdef __cplusplus 42 extern "C" { 43 #endif 44 45 /**@addtogroup PublicCompressionMethods 46 * 47 * @{ 48 */ 49 50 /** compares two compressions w. r. to their priority */ 51 SCIP_EXPORT 52 SCIP_DECL_SORTPTRCOMP(SCIPcomprComp); 53 54 /** comparison method for sorting compressions w.r.t. to their name */ 55 SCIP_EXPORT 56 SCIP_DECL_SORTPTRCOMP(SCIPcomprCompName); 57 58 /** gets user data of tree compression */ 59 SCIP_EXPORT 60 SCIP_COMPRDATA* SCIPcomprGetData( 61 SCIP_COMPR* compr /**< tree compression */ 62 ); 63 64 /** sets user data of tree compression; user has to free old data in advance! */ 65 SCIP_EXPORT 66 void SCIPcomprSetData( 67 SCIP_COMPR* compr, /**< tree compression */ 68 SCIP_COMPRDATA* comprdata /**< new tree compression user data */ 69 ); 70 71 /** gets name of tree compression */ 72 SCIP_EXPORT 73 const char* SCIPcomprGetName( 74 SCIP_COMPR* heur /**< tree compression */ 75 ); 76 77 /** gets description of tree compression */ 78 SCIP_EXPORT 79 const char* SCIPcomprGetDesc( 80 SCIP_COMPR* compr /**< tree compression */ 81 ); 82 83 /** gets priority of tree compression */ 84 SCIP_EXPORT 85 int SCIPcomprGetPriority( 86 SCIP_COMPR* compr /**< tree compression */ 87 ); 88 89 /** gets minimal number of nodes for calling tree compression (returns -1, if no node threshold exists) */ 90 SCIP_EXPORT 91 int SCIPcomprGetMinNodes( 92 SCIP_COMPR* compr /**< tree compression */ 93 ); 94 95 /** gets the number of times, the compression was called and tried to find a compression */ 96 SCIP_EXPORT 97 SCIP_Longint SCIPcomprGetNCalls( 98 SCIP_COMPR* compr /**< tree compression */ 99 ); 100 101 /** gets the number of tree compressions found by this compression */ 102 SCIP_EXPORT 103 SCIP_Longint SCIPcomprGetNFound( 104 SCIP_COMPR* compr /**< tree compression */ 105 ); 106 107 /** is tree compression initialized? */ 108 SCIP_EXPORT 109 SCIP_Bool SCIPcomprIsInitialized( 110 SCIP_COMPR* compr /**< tree compression */ 111 ); 112 113 /** gets time in seconds used in this compression for setting up for next stages */ 114 SCIP_EXPORT 115 SCIP_Real SCIPcomprGetSetupTime( 116 SCIP_COMPR* compr /**< tree compression */ 117 ); 118 119 /** gets time in seconds used in this compression */ 120 SCIP_EXPORT 121 SCIP_Real SCIPcomprGetTime( 122 SCIP_COMPR* compr /**< tree compression */ 123 ); 124 125 /** @} */ 126 127 #ifdef __cplusplus 128 } 129 #endif 130 131 #endif 132