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_table.h 26 * @ingroup PUBLICCOREAPI 27 * @brief public methods for displaying statistic tables 28 * @author Tristan Gally 29 */ 30 31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ 32 33 #ifndef __SCIP_PUB_TABLE_H__ 34 #define __SCIP_PUB_TABLE_H__ 35 36 37 #include "scip/def.h" 38 #include "scip/type_set.h" 39 #include "scip/type_table.h" 40 41 #ifdef __cplusplus 42 extern "C" { 43 #endif 44 45 /**@addtogroup PublicTableMethods 46 * 47 * @{ 48 */ 49 50 /** gets user data of statistics table */ 51 SCIP_EXPORT 52 SCIP_TABLEDATA* SCIPtableGetData( 53 SCIP_TABLE* table /**< statistics table */ 54 ); 55 56 /** sets user data of statistics table; user has to free old data in advance! */ 57 SCIP_EXPORT 58 void SCIPtableSetData( 59 SCIP_TABLE* table, /**< statistics table */ 60 SCIP_TABLEDATA* tabledata /**< new statistics table user data */ 61 ); 62 63 /** gets name of statistics table */ 64 SCIP_EXPORT 65 const char* SCIPtableGetName( 66 SCIP_TABLE* table /**< statistics table */ 67 ); 68 69 /** gets description of statistics table */ 70 SCIP_EXPORT 71 const char* SCIPtableGetDesc( 72 SCIP_TABLE* table /**< statistics table */ 73 ); 74 75 /** gets position of statistics table */ 76 SCIP_EXPORT 77 int SCIPtableGetPosition( 78 SCIP_TABLE* table /**< statistics table */ 79 ); 80 81 /** gets earliest stage of statistics table */ 82 SCIP_EXPORT 83 SCIP_STAGE SCIPtableGetEarliestStage( 84 SCIP_TABLE* table /**< statistics table */ 85 ); 86 87 /** is statistics table currently active? */ 88 SCIP_EXPORT 89 SCIP_Bool SCIPtableIsActive( 90 SCIP_TABLE* table /**< statistics table */ 91 ); 92 93 /** is statistics table initialized? */ 94 SCIP_EXPORT 95 SCIP_Bool SCIPtableIsInitialized( 96 SCIP_TABLE* table /**< statistics table */ 97 ); 98 99 /** @} */ 100 101 #ifdef __cplusplus 102 } 103 #endif 104 105 #endif 106