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