Scippy

SCIP

Solving Constraint Integer Programs

pub_relax.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-2014 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 email to scip@zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file pub_relax.h
17  * @ingroup PUBLICMETHODS
18  * @brief public methods for relaxation 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_RELAX_H__
25 #define __SCIP_PUB_RELAX_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_misc.h"
30 #include "scip/type_relax.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** compares two relaxation handlers w. r. to their priority */
37 extern
38 SCIP_DECL_SORTPTRCOMP(SCIPrelaxComp);
39 
40 /** comparison method for sorting relaxators w.r.t. to their name */
41 extern
42 SCIP_DECL_SORTPTRCOMP(SCIPrelaxCompName);
43 
44 /** gets user data of relaxation handler */
45 extern
47  SCIP_RELAX* relax /**< relaxation handler */
48  );
49 
50 /** sets user data of relaxation handler; user has to free old data in advance! */
51 extern
52 void SCIPrelaxSetData(
53  SCIP_RELAX* relax, /**< relaxation handler */
54  SCIP_RELAXDATA* relaxdata /**< new relaxation handler user data */
55  );
56 
57 /** gets name of relaxation handler */
58 extern
59 const char* SCIPrelaxGetName(
60  SCIP_RELAX* relax /**< relaxation handler */
61  );
62 
63 /** gets description of relaxation handler */
64 extern
65 const char* SCIPrelaxGetDesc(
66  SCIP_RELAX* relax /**< relaxation handler */
67  );
68 
69 /** gets priority of relaxation handler */
70 extern
72  SCIP_RELAX* relax /**< relaxation handler */
73  );
74 
75 /** gets frequency of relaxation handler */
76 extern
78  SCIP_RELAX* relax /**< relaxation handler */
79  );
80 
81 /** gets time in seconds used in this relaxator for setting up for next stages */
82 extern
84  SCIP_RELAX* relax /**< relaxator */
85  );
86 
87 /** gets time in seconds used in this relaxation handler */
88 extern
90  SCIP_RELAX* relax /**< relaxation handler */
91  );
92 
93 /** gets the total number of times, the relaxation handler was called */
94 extern
96  SCIP_RELAX* relax /**< relaxation handler */
97  );
98 
99 /** is relaxation handler initialized? */
100 extern
102  SCIP_RELAX* relax /**< relaxation handler */
103  );
104 
105 /** marks the current relaxation unsolved, s.t. the relaxation handler is called again in the next solving round */
106 extern
108  SCIP_RELAX* relax /**< relaxation handler */
109  );
110 
111 #ifdef __cplusplus
112 }
113 #endif
114 
115 #endif
116