Scippy

SCIP

Solving Constraint Integer Programs

type_retcode.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-2024 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 type_retcode.h
26  * @brief type definitions for return codes for SCIP methods
27  * @author Tobias Achterberg
28  */
29 
30 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
31 
32 #ifndef __SCIP_TYPE_RETCODE_H__
33 #define __SCIP_TYPE_RETCODE_H__
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 /** return codes for SCIP methods: non-positive return codes are errors */
41 {
42  SCIP_OKAY = +1, /**< normal termination */
43  SCIP_ERROR = 0, /**< unspecified error */
44  SCIP_NOMEMORY = -1, /**< insufficient memory error */
45  SCIP_READERROR = -2, /**< read error */
46  SCIP_WRITEERROR = -3, /**< write error */
47  SCIP_NOFILE = -4, /**< file not found error */
48  SCIP_FILECREATEERROR = -5, /**< cannot create file */
49  SCIP_LPERROR = -6, /**< error in LP solver */
50  SCIP_NOPROBLEM = -7, /**< no problem exists */
51  SCIP_INVALIDCALL = -8, /**< method cannot be called at this time in solution process */
52  SCIP_INVALIDDATA = -9, /**< error in input data */
53  SCIP_INVALIDRESULT = -10, /**< method returned an invalid result code */
54  SCIP_PLUGINNOTFOUND = -11, /**< a required plugin was not found */
55  SCIP_PARAMETERUNKNOWN = -12, /**< the parameter with the given name was not found */
56  SCIP_PARAMETERWRONGTYPE = -13, /**< the parameter is not of the expected type */
57  SCIP_PARAMETERWRONGVAL = -14, /**< the value is invalid for the given parameter */
58  SCIP_KEYALREADYEXISTING = -15, /**< the given key is already existing in table */
59  SCIP_MAXDEPTHLEVEL = -16, /**< maximal branching depth level exceeded */
60  SCIP_BRANCHERROR = -17, /**< no branching could be created */
61  SCIP_NOTIMPLEMENTED = -18 /**< function not implemented */
62 };
63 typedef enum SCIP_Retcode SCIP_RETCODE; /**< return code for SCIP method */
64 
65 #ifdef __cplusplus
66 }
67 #endif
68 
69 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
SCIP_Retcode
Definition: type_retcode.h:40