Scippy

SCIP

Solving Constraint Integer Programs

scipshell.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 scipshell.h
26  * @ingroup PUBLICCOREAPI
27  * @brief SCIP command line interface
28  * @author Tobias Achterberg
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_SCIPSHELL_H__
34 #define __SCIP_SCIPSHELL_H__
35 
36 #include "scip/def.h"
37 #include "scip/type_retcode.h"
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 /** evaluates command line parameters and runs SCIP appropriately in the given SCIP instance */
44 SCIP_EXPORT
46  SCIP* scip, /**< SCIP data structure */
47  int argc, /**< number of shell parameters */
48  char** argv, /**< array with shell parameters */
49  const char* defaultsetname /**< name of default settings file */
50  );
51 
52 /** creates a SCIP instance with default plugins, evaluates command line parameters, runs SCIP appropriately,
53  * and frees the SCIP instance
54  */
55 SCIP_EXPORT
57  int argc, /**< number of shell parameters */
58  char** argv, /**< array with shell parameters */
59  const char* defaultsetname /**< name of default settings file */
60  );
61 
62 #ifdef __cplusplus
63 }
64 #endif
65 
66 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPrunShell(int argc, char **argv, const char *defaultsetname)
Definition: scipshell.c:534
SCIP_RETCODE SCIPprocessShellArguments(SCIP *scip, int argc, char **argv, const char *defaultsetname)
Definition: scipshell.c:243
common defines and data types used in all packages of SCIP