Scippy

SCIP

Solving Constraint Integer Programs

scip.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-2019 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 scip.zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file scip.h
17  * @ingroup PUBLICCOREAPI
18  * @brief SCIP callable library
19  * @author Tobias Achterberg
20  * @author Timo Berthold
21  * @author Thorsten Koch
22  * @author Alexander Martin
23  * @author Marc Pfetsch
24  * @author Kati Wolter
25  */
26 
27 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
28 
29 #ifndef __SCIP_SCIP_H__
30 #define __SCIP_SCIP_H__
31 
32 
33 #include <stdio.h>
34 
35 #include "scip/def.h"
36 #include "blockmemshell/memory.h"
37 #include "scip/type_retcode.h"
38 #include "scip/type_result.h"
39 #include "scip/type_clock.h"
40 #include "scip/type_misc.h"
41 #include "scip/type_timing.h"
42 #include "scip/type_paramset.h"
43 #include "scip/type_event.h"
44 #include "scip/type_lp.h"
45 #include "scip/type_nlp.h"
46 #include "scip/type_var.h"
47 #include "scip/type_prob.h"
48 #include "scip/type_tree.h"
49 #include "scip/type_scip.h"
50 
51 #include "scip/type_bandit.h"
52 #include "scip/type_branch.h"
53 #include "scip/type_conflict.h"
54 #include "scip/type_cons.h"
55 #include "scip/type_dialog.h"
56 #include "scip/type_disp.h"
57 #include "scip/type_heur.h"
58 #include "scip/type_compr.h"
59 #include "scip/type_history.h"
60 #include "scip/type_nodesel.h"
61 #include "scip/type_presol.h"
62 #include "scip/type_pricer.h"
63 #include "scip/type_reader.h"
64 #include "scip/type_relax.h"
65 #include "scip/type_reopt.h"
66 #include "scip/type_sepa.h"
67 #include "scip/type_table.h"
68 #include "scip/type_prop.h"
69 #include "nlpi/type_nlpi.h"
70 #include "scip/type_concsolver.h"
71 #include "scip/type_syncstore.h"
72 #include "scip/type_benders.h"
73 #include "scip/type_benderscut.h"
74 
75 /* include public interfaces, s.t. the user only needs to include scip.h */
76 #include "scip/pub_bandit.h"
77 #include "scip/pub_benders.h"
78 #include "scip/pub_benderscut.h"
79 #include "scip/pub_branch.h"
80 #include "scip/pub_conflict.h"
81 #include "scip/pub_cons.h"
82 #include "scip/pub_cutpool.h"
83 #include "scip/pub_dialog.h"
84 #include "scip/pub_disp.h"
85 #include "scip/pub_event.h"
86 #include "scip/pub_fileio.h"
87 #include "scip/pub_heur.h"
88 #include "scip/pub_compr.h"
89 #include "scip/pub_history.h"
90 #include "scip/pub_implics.h"
91 #include "scip/pub_lp.h"
92 #include "scip/pub_nlp.h"
93 #include "scip/pub_matrix.h"
94 #include "scip/pub_message.h"
95 #include "scip/pub_misc.h"
96 #include "scip/pub_nodesel.h"
97 #include "scip/pub_paramset.h"
98 #include "scip/pub_presol.h"
99 #include "scip/pub_pricer.h"
100 #include "scip/pub_reader.h"
101 #include "scip/pub_relax.h"
102 #include "scip/pub_reopt.h"
103 #include "scip/pub_sepa.h"
104 #include "scip/pub_prop.h"
105 #include "scip/pub_sol.h"
106 #include "scip/pub_table.h"
107 #include "scip/pub_tree.h"
108 #include "scip/pub_var.h"
109 #include "lpi/lpi.h"
110 #include "nlpi/pub_expr.h"
111 
112 /* include global presolving, cuts, and heuristics methods */
113 #include "scip/presolve.h"
114 #include "scip/cuts.h"
115 #include "scip/heuristics.h"
116 
117 /* In debug mode, we include the SCIP's structure in scip.c, such that no one can access
118  * this structure except the interface methods in scip.c.
119  * In optimized mode, the structure is included in scip.h, because some of the methods
120  * are implemented as defines for performance reasons (e.g. the numerical comparisons).
121  * Additionally, the internal "set.h" is included, such that the defines in set.h are
122  * available in optimized mode.
123  */
124 #ifdef NDEBUG
125 #include "scip/struct_scip.h"
126 #include "scip/struct_stat.h"
127 #include "scip/set.h"
128 #include "scip/tree.h"
129 #include "scip/misc.h"
130 #include "scip/var.h"
131 #include "scip/cons.h"
132 #include "scip/solve.h"
133 #include "scip/debug.h"
134 #endif
135 
136 #include "scip/scip_bandit.h"
137 #include "scip/scip_benders.h"
138 #include "scip/scip_branch.h"
139 #include "scip/scip_compr.h"
140 #include "scip/scip_concurrent.h"
141 #include "scip/scip_conflict.h"
142 #include "scip/scip_cons.h"
143 #include "scip/scip_copy.h"
144 #include "scip/scip_cut.h"
145 #include "scip/scip_datastructures.h"
146 #include "scip/scip_debug.h"
147 #include "scip/scip_dialog.h"
148 #include "scip/scip_disp.h"
149 #include "scip/scip_event.h"
150 #include "scip/scip_expr.h"
151 #include "scip/scip_general.h"
152 #include "scip/scip_heur.h"
153 #include "scip/scip_lp.h"
154 #include "scip/scip_mem.h"
155 #include "scip/scip_message.h"
156 #include "scip/scip_nlp.h"
157 #include "scip/scip_nodesel.h"
158 #include "scip/scip_nonlinear.h"
159 #include "scip/scip_numerics.h"
160 #include "scip/scip_param.h"
161 #include "scip/scip_presol.h"
162 #include "scip/scip_pricer.h"
163 #include "scip/scip_prob.h"
164 #include "scip/scip_probing.h"
165 #include "scip/scip_prop.h"
166 #include "scip/scip_randnumgen.h"
167 #include "scip/scip_reader.h"
168 #include "scip/scip_relax.h"
169 #include "scip/scip_reopt.h"
170 #include "scip/scip_sepa.h"
171 #include "scip/scip_sol.h"
172 #include "scip/scip_solve.h"
173 #include "scip/scip_solvingstats.h"
174 #include "scip/scip_table.h"
175 #include "scip/scip_timing.h"
176 #include "scip/scip_tree.h"
177 #include "scip/scip_validation.h"
178 #include "scip/scip_var.h"
179 
180 
181 #endif
scip_relax.h
public methods for relaxator plugins
scip_param.h
public methods for SCIP parameter handling
pub_history.h
public methods for branching and inference history structure
pub_tree.h
public methods for branch and bound tree
tree.h
internal methods for branch and bound tree
type_misc.h
type definitions for miscellaneous datastructures
type_timing.h
timing definitions for SCIP
scip_nodesel.h
public methods for node selector plugins
type_nlp.h
type definitions for NLP management
scip_mem.h
public methods for memory management
pub_implics.h
public methods for implications, variable bounds, and cliques
scip_compr.h
public methods for compression plugins
scip_conflict.h
public methods for conflict handler plugins and conflict analysis
scip_solve.h
public solving methods
scip_timing.h
public methods for timing
lpi.h
interface methods for specific LP solvers
scip_presol.h
public methods for presolving plugins
pub_benders.h
public methods for Benders&#39; decomposition
cuts.h
methods for the aggregation rows
heuristics.h
methods commonly used by primal heuristics
pub_disp.h
public methods for displaying runtime statistics
pub_var.h
public methods for problem variables
pub_reopt.h
public methods for reoptimization
scip_validation.h
public methods for validation
type_retcode.h
type definitions for return codes for SCIP methods
pub_branch.h
public methods for branching rules
type_presol.h
type definitions for presolvers
scip_var.h
public methods for SCIP variables
type_reopt.h
type definitions for collecting reoptimization information
scip_sepa.h
public methods for separator plugins
type_branch.h
type definitions for branching rules
scip_numerics.h
public methods for numerical tolerances
pub_expr.h
public methods for expressions, expression trees, expression graphs, and related stuff ...
type_lp.h
type definitions for LP management
scip_solvingstats.h
public methods for querying solving statistics
scip_tree.h
public methods for the branch-and-bound tree
scip_reopt.h
public methods for reoptimization
pub_paramset.h
public methods for handling parameter settings
pub_cons.h
public methods for managing constraints
pub_table.h
public methods for displaying statistic tables
type_pricer.h
type definitions for variable pricers
scip_benders.h
public methods for Benders decomposition
type_heur.h
type definitions for primal heuristics
scip_event.h
public methods for event handler plugins and event handlers
scip_nonlinear.h
public methods for nonlinear functions
type_scip.h
type definitions for SCIP&#39;s main datastructure
scip_expr.h
public methods for expression handlers
misc.h
internal miscellaneous methods
type_bandit.h
type definitions for bandit selection algorithms
scip_copy.h
public methods for problem copies
pub_sol.h
public methods for primal CIP solutions
set.h
internal methods for global SCIP settings
struct_scip.h
SCIP main data structure.
type_var.h
type definitions for problem variables
type_relax.h
type definitions for relaxators
type_conflict.h
type definitions for conflict analysis
type_event.h
type definitions for managing events
scip_heur.h
public methods for primal heuristic plugins and divesets
scip_cons.h
public methods for constraint handler plugins and constraints
pub_nlp.h
public methods for NLP management
pub_nodesel.h
public methods for node selectors
pub_fileio.h
wrapper functions to map file i/o to standard or zlib file i/o
presolve.h
methods commonly used for presolving
var.h
internal methods for problem variables
pub_misc.h
public data structures and miscellaneous methods
pub_cutpool.h
public methods for storing cuts in a cut pool
type_reader.h
type definitions for input file readers
scip_concurrent.h
public methods for concurrent solving mode
scip_table.h
public methods for statistics table plugins
pub_pricer.h
public methods for variable pricers
debug.h
methods for debugging
pub_lp.h
public methods for LP management
scip_cut.h
public methods for cuts and aggregation rows
pub_bandit.h
public methods for bandit algorithms
type_tree.h
type definitions for branch and bound tree
struct_stat.h
datastructures for problem statistics
type_benders.h
type definitions for Benders&#39; decomposition methods
type_clock.h
type definitions for clocks and timing issues
pub_matrix.h
public methods for matrix
type_benderscut.h
type definitions for Benders&#39; decomposition cut
type_prob.h
type definitions for storing and manipulating the main problem
scip_lp.h
public methods for the LP relaxation, rows and columns
scip_pricer.h
public methods for variable pricer plugins
scip_bandit.h
public methods for bandit algorithms
scip_nlp.h
public methods for nonlinear relaxations
pub_benderscut.h
public methods for Benders&#39; decomposition cuts
type_prop.h
type definitions for propagators
scip_branch.h
public methods for branching rule plugins and branching
pub_presol.h
public methods for presolvers
pub_event.h
public methods for managing events
scip_general.h
general public methods
type_syncstore.h
the type definitions for the synchronization store
scip_debug.h
public methods for debugging
scip_sol.h
public methods for solutions
scip_randnumgen.h
public methods for random numbers
solve.h
internal methods for main solving loop and node processing
type_compr.h
type definitions for tree compression
pub_conflict.h
public methods for conflict analysis handlers
scip_probing.h
public methods for the probing mode
pub_compr.h
public methods for tree compressions
type_sepa.h
type definitions for separators
pub_message.h
public methods for message output
type_paramset.h
type definitions for handling parameter settings
type_dialog.h
type definitions for user interface dialog
pub_relax.h
public methods for relaxation handlers
type_result.h
result codes for SCIP callback methods
type_history.h
type definitions for branching and inference history
pub_reader.h
public methods for input file readers
scip_message.h
public methods for message handling
scip_datastructures.h
public methods for data structures
cons.h
internal methods for constraints and constraint handlers
scip_dialog.h
public methods for dialog handler plugins
scip_prop.h
public methods for propagator plugins
pub_sepa.h
public methods for separators
pub_heur.h
public methods for primal heuristics
def.h
common defines and data types used in all packages of SCIP
type_nodesel.h
type definitions for node selectors
scip_reader.h
public methods for reader plugins
scip_prob.h
public methods for global and local (sub)problems
pub_dialog.h
public methods for user interface dialog
type_table.h
type definitions for displaying statistics tables
scip_disp.h
public methods for display handler plugins
type_cons.h
type definitions for constraints and constraint handlers
pub_prop.h
public methods for propagators
type_nlpi.h
type definitions for specific NLP solver interfaces
type_concsolver.h
type definitions for concurrent solvers
type_disp.h
type definitions for displaying runtime statistics
memory.h
memory allocation routines