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-2023 Zuse Institute Berlin (ZIB) */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file reader_mst.h
26  * @ingroup FILEREADERS
27  * @brief file reader for partial primal solutions
28  * @author Jakob Witzig
29  *
30  * This reader handles solutions in two formats:
31  *
32  * - <b>SCIP raw format</b>@n
33  * The format is as follows:@n@n
34  * line 1: "solution status: <status>"@n
35  * line 2: "objective value: <value>"@n
36  * line 3+i: <variable name> <value> (obj: <objective coefficient of variable>)
37  * @n@n
38  * Only known values need to be listed.
39  * @par
40  * Example:
41  * @code
42  * solution status: optimal
43  * objective value: 1
44  * x1 1 (obj:1)
45  * x2 1 (obj:0)
46  * @endcode
47  * - <b>XML format</b>@n
48  * This format is used by CPLEX, for example. For reading we require a section of @p
49  * <variables>. Each entry in this section consists of@n
50  * <variable name="<name>" index="<number>" value="<value>"/>
51  * @par
52  * Example:
53  * @code
54  * <?xml version = "1.0" standalone="yes"?>
55  * <variables>
56  * <variable name="x1" index="1" value="1"/>
57  * <variable name="x2" index="2" value="1"/>
58  * </variables>
59  * </xml>
60  * @endcode
61  */
62 
63 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
64 
65 #ifndef __SCIP_READER_MST_H__
66 #define __SCIP_READER_MST_H__
67 
68 #include "scip/def.h"
69 #include "scip/type_retcode.h"
70 #include "scip/type_scip.h"
71 
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75 
76 /** includes the mst file reader into SCIP
77  *
78  * @ingroup FileReaderIncludes
79  */
80 SCIP_EXPORT
82  SCIP* scip /**< SCIP data structure */
83  );
84 
85 #ifdef __cplusplus
86 }
87 #endif
88 
89 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
SCIP_RETCODE SCIPincludeReaderMst(SCIP *scip)
Definition: reader_mst.c:197
common defines and data types used in all packages of SCIP