Scippy

GCG

Branch-and-Price & Column Generation for Everyone

reader_ref.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program */
4 /* GCG --- Generic Column Generation */
5 /* a Dantzig-Wolfe decomposition based extension */
6 /* of the branch-cut-and-price framework */
7 /* SCIP --- Solving Constraint Integer Programs */
8 /* */
9 /* Copyright (C) 2010-2021 Operations Research, RWTH Aachen University */
10 /* Zuse Institute Berlin (ZIB) */
11 /* */
12 /* This program is free software; you can redistribute it and/or */
13 /* modify it under the terms of the GNU Lesser General Public License */
14 /* as published by the Free Software Foundation; either version 3 */
15 /* of the License, or (at your option) any later version. */
16 /* */
17 /* This program is distributed in the hope that it will be useful, */
18 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
19 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
20 /* GNU Lesser General Public License for more details. */
21 /* */
22 /* You should have received a copy of the GNU Lesser General Public License */
23 /* along with this program; if not, write to the Free Software */
24 /* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.*/
25 /* */
26 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
27 
28 /**@file reader_ref.h
29  * @brief REF file reader for structure information
30  * @ingroup FILEREADERS
31  * @author Gerald Gamrath
32  * @author Christian Puchert
33  * @author Martin Bergner
34  *
35  * This reader reads and writes a ref-file that defines the structur to be used for the decomposition.
36  * The structure is defined constraint-wise, i.e., the number of blocks and the constraints belonging to each
37  * block are defined. The constraints are numbered by the appearance in the problem.
38  *
39  * Constraints not mentioned in one of the blocks will remain in the master problem
40  *
41  * The format is the following
42  * - first line: \#nblocks \#ncons_block_1 ... \#n_cons_block_n
43  * - one line for each block with the indices of constraints to be put into that block separated by a comma
44  *
45  */
46 
47 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
48 
49 #ifndef GCG_READER_REF_H__
50 #define GCG_READER_REF_H__
51 
52 
53 #include "scip/type_scip.h"
54 #include "scip/type_reader.h"
55 #include "scip/type_result.h"
56 #include "type_decomp.h"
57 
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61 
62 /** includes the ref file reader into SCIP */
63 extern
64 SCIP_RETCODE SCIPincludeReaderRef(
65  SCIP* scip /**< SCIP data structure */
66  );
67 
68 /* reads problem from file */
69 extern
70 SCIP_RETCODE SCIPreadRef(
71  SCIP* scip, /**< SCIP data structure */
72  SCIP_READER* reader, /**< the file reader itself */
73  const char* filename, /**< full path and name of file to read, or NULL if stdin should be used */
74  SCIP_RESULT* result /**< pointer to store the result of the file reading call */
75  );
76 
77 #ifdef __cplusplus
78 }
79 #endif
80 
81 #endif
SCIP_RETCODE SCIPreadRef(SCIP *scip, SCIP_READER *reader, const char *filename, SCIP_RESULT *result)
Definition: reader_ref.c:778
type definitions for decomposition information in GCG projects
SCIP_RETCODE SCIPincludeReaderRef(SCIP *scip)
Definition: reader_ref.c:764