Scippy

SCIP

Solving Constraint Integer Programs

pub_conflict.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-2020 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 visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file pub_conflict.h
17  * @ingroup PUBLICCOREAPI
18  * @brief public methods for conflict analysis handlers
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_CONFLICT_H__
25 #define __SCIP_PUB_CONFLICT_H__
26 
27 
28 
29 #include "scip/def.h"
30 #include "scip/type_misc.h"
31 #include "scip/type_conflict.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 /**@addtogroup PublicConflictMethods
38  *
39  * @{
40  */
41 
42 /** compares two conflict handlers w. r. to their priority */
44 SCIP_DECL_SORTPTRCOMP(SCIPconflicthdlrComp);
45 
46 /** comparison method for sorting conflict handler w.r.t. to their name */
48 SCIP_DECL_SORTPTRCOMP(SCIPconflicthdlrCompName);
49 
50 /** gets user data of conflict handler */
53  SCIP_CONFLICTHDLR* conflicthdlr /**< conflict handler */
54  );
55 
56 /** sets user data of conflict handler; user has to free old data in advance! */
59  SCIP_CONFLICTHDLR* conflicthdlr, /**< conflict handler */
60  SCIP_CONFLICTHDLRDATA* conflicthdlrdata /**< new conflict handler user data */
61  );
62 
63 /** gets name of conflict handler */
65 const char* SCIPconflicthdlrGetName(
66  SCIP_CONFLICTHDLR* conflicthdlr /**< conflict handler */
67  );
68 
69 /** gets description of conflict handler */
71 const char* SCIPconflicthdlrGetDesc(
72  SCIP_CONFLICTHDLR* conflicthdlr /**< conflict handler */
73  );
74 
75 /** gets priority of conflict handler */
78  SCIP_CONFLICTHDLR* conflicthdlr /**< conflict handler */
79  );
80 
81 /** is conflict handler initialized? */
84  SCIP_CONFLICTHDLR* conflicthdlr /**< conflict handler */
85  );
86 
87 /** gets time in seconds used in this conflict handler for setting up for next stages */
90  SCIP_CONFLICTHDLR* conflicthdlr /**< conflict handler */
91  );
92 
93 /** gets time in seconds used in this conflict handler */
96  SCIP_CONFLICTHDLR* conflicthdlr /**< conflict handler */
97  );
98 
99 /** @} */
100 
101 #ifdef __cplusplus
102 }
103 #endif
104 
105 #endif
type definitions for miscellaneous datastructures
#define SCIP_EXPORT
Definition: def.h:100
SCIP_EXPORT const char * SCIPconflicthdlrGetDesc(SCIP_CONFLICTHDLR *conflicthdlr)
Definition: conflict.c:773
SCIP_EXPORT SCIP_Real SCIPconflicthdlrGetSetupTime(SCIP_CONFLICTHDLR *conflicthdlr)
Definition: conflict.c:829
SCIP_EXPORT int SCIPconflicthdlrGetPriority(SCIP_CONFLICTHDLR *conflicthdlr)
Definition: conflict.c:783
SCIP_EXPORT void SCIPconflicthdlrSetData(SCIP_CONFLICTHDLR *conflicthdlr, SCIP_CONFLICTHDLRDATA *conflicthdlrdata)
Definition: conflict.c:686
SCIP_EXPORT SCIP_Bool SCIPconflicthdlrIsInitialized(SCIP_CONFLICTHDLR *conflicthdlr)
Definition: conflict.c:807
struct SCIP_ConflicthdlrData SCIP_CONFLICTHDLRDATA
Definition: type_conflict.h:40
type definitions for conflict analysis
SCIP_EXPORT SCIP_DECL_SORTPTRCOMP(SCIPconflicthdlrComp)
Definition: conflict.c:353
#define SCIP_Bool
Definition: def.h:70
SCIP_EXPORT const char * SCIPconflicthdlrGetName(SCIP_CONFLICTHDLR *conflicthdlr)
Definition: conflict.c:763
SCIP_EXPORT SCIP_Real SCIPconflicthdlrGetTime(SCIP_CONFLICTHDLR *conflicthdlr)
Definition: conflict.c:839
#define SCIP_Real
Definition: def.h:163
common defines and data types used in all packages of SCIP
SCIP_EXPORT SCIP_CONFLICTHDLRDATA * SCIPconflicthdlrGetData(SCIP_CONFLICTHDLR *conflicthdlr)
Definition: conflict.c:676