Scippy

SCIP

Solving Constraint Integer Programs

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