Scippy

SCIP

Solving Constraint Integer Programs

reader_mst.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-2021 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 reader_mst.h
17  * @ingroup FILEREADERS
18  * @brief file reader for partial primal solutions
19  * @author Jakob Witzig
20  *
21  * This reader handles solutions in two formats:
22  *
23  * - <b>SCIP raw format</b>@n
24  * The format is as follows:@n@n
25  * line 1: "solution status: <status>"@n
26  * line 2: "objective value: <value>"@n
27  * line 3+i: <variable name> <value> (obj: <objective coefficient of variable>)
28  * @n@n
29  * Only known values need to be listed.
30  * @par
31  * Example:
32  * @code
33  * solution status: optimal
34  * objective value: 1
35  * x1 1 (obj:1)
36  * x2 1 (obj:0)
37  * @endcode
38  * - <b>XML format</b>@n
39  * This format is used by CPLEX, for example. For reading we require a section of @p
40  * <variables>. Each entry in this section consists of@n
41  * <variable name="<name>" index="<number>" value="<value>"/>
42  * @par
43  * Example:
44  * @code
45  * <?xml version = "1.0" standalone="yes"?>
46  * <variables>
47  * <variable name="x1" index="1" value="1"/>
48  * <variable name="x2" index="2" value="1"/>
49  * </variables>
50  * </xml>
51  * @endcode
52  */
53 
54 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
55 
56 #ifndef __SCIP_READER_MST_H__
57 #define __SCIP_READER_MST_H__
58 
59 #include "scip/def.h"
60 #include "scip/type_retcode.h"
61 #include "scip/type_scip.h"
62 
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66 
67 /** includes the mst file reader into SCIP
68  *
69  * @ingroup FileReaderIncludes
70  */
73  SCIP* scip /**< SCIP data structure */
74  );
75 
76 #ifdef __cplusplus
77 }
78 #endif
79 
80 #endif
#define SCIP_EXPORT
Definition: def.h:100
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
SCIP_EXPORT SCIP_RETCODE SCIPincludeReaderMst(SCIP *scip)
Definition: reader_mst.c:188
common defines and data types used in all packages of SCIP