Scippy

SCIP

Solving Constraint Integer Programs

reader_fzn.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 2002-2022 Zuse Institute Berlin */
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_fzn.h
26  * @ingroup FILEREADERS
27  * @brief FlatZinc file reader
28  * @author Timo Berthold
29  * @author Stefan Heinz
30  *
31  * FlatZinc is a low-level solver input language that is the target language for MiniZinc. It is designed to be easy to
32  * translate into the form required by a solver. For more details see https://www.minizinc.org/ .
33  */
34 
35 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
36 
37 #ifndef __READER_FZN_H__
38 #define __READER_FZN_H__
39 
40 #include "scip/def.h"
41 #include "scip/type_retcode.h"
42 #include "scip/type_scip.h"
43 #include "scip/type_sol.h"
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 /** includes the FlatZinc file reader into SCIP
50  *
51  * @ingroup FileReaderIncludes
52  */
53 SCIP_EXPORT
55  SCIP* scip /**< SCIP data structure */
56  );
57 
58 /**@addtogroup FILEREADERS
59  *
60  * @{
61  */
62 
63 /** print given solution in Flatzinc format w.r.t. the output annotation */
64 SCIP_EXPORT
66  SCIP* scip, /**< SCIP data structure */
67  SCIP_SOL* sol, /**< primal solution, or NULL for current LP/pseudo solution */
68  FILE* file /**< output file (or NULL for standard output) */
69  );
70 
71 /** @} */
72 
73 #ifdef __cplusplus
74 }
75 #endif
76 
77 #endif
SCIP_RETCODE SCIPprintSolReaderFzn(SCIP *scip, SCIP_SOL *sol, FILE *file)
Definition: reader_fzn.c:4955
SCIP_RETCODE SCIPincludeReaderFzn(SCIP *scip)
Definition: reader_fzn.c:4932
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
type definitions for storing primal CIP solutions
common defines and data types used in all packages of SCIP