cleanup, rename to pbsolver, remove retcode SCIP_BIGINT

GioniMexi · DominikKamp · commit 3785b0bf234f · 2025-03-10T18:15:34.000+01:00
diff --git a/INSTALL_APPLICATIONS_EXAMPLES.md b/INSTALL_APPLICATIONS_EXAMPLES.md
@@ -17,7 +17,7 @@ Applications
 | `Coloring`        | `coloring`        | `coloring`        |
 | `CycleClustering` | `cycleclustering` | `cycleclustering` |
 | `MinIISC`         | `miniisc`         | `miniisc`         |
-| `PBSolver`        | `pbscip`          | `pbscip`          |
+| `PBSolver`        | `pbsolver`        | `pbsolver`        |
 | `Ringpacking`     | `ringpacking`     | `ringpacking`     |
 | `Scheduler`       | `scheduler`       | `scheduler`       |
 
diff --git a/applications/PBSolver/CMakeLists.txt b/applications/PBSolver/CMakeLists.txt
@@ -11,16 +11,16 @@ endif()
 
 include_directories(${SCIP_INCLUDE_DIRS})
 
-add_executable(pbscip
+add_executable(pbsolver
     src/main.cpp
-    src/message_pbscip.c
+    src/message_pb.c
     src/event_bestsol.c
 )
 
-target_link_libraries(pbscip ${SCIP_LIBRARIES})
+target_link_libraries(pbsolver ${SCIP_LIBRARIES})
 
 if( TARGET applications )
-    add_dependencies( applications pbscip )
+    add_dependencies( applications pbsolver )
 endif()
 
 enable_testing()
diff --git a/applications/PBSolver/src/event_bestsol.c b/applications/PBSolver/src/event_bestsol.c
@@ -3,7 +3,7 @@
 /*                  This file is part of the program and library             */
 /*         SCIP --- Solving Constraint Integer Programs                      */
 /*                                                                           */
-/*  Copyright (c) 2002-2024 Zuse Institute Berlin (ZIB)                      */
+/*  Copyright (c) 2002-2025 Zuse Institute Berlin (ZIB)                      */
 /*                                                                           */
 /*  Licensed under the Apache License, Version 2.0 (the "License");          */
 /*  you may not use this file except in compliance with the License.         */
@@ -22,8 +22,15 @@
 /*                                                                           */
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/**@file   event_bestsol.c
+ * @brief  eventhdlr to print the best solution value
+ * @author Alexander Hoen
+ * @author Gioni Mexi
+ */
 
-#include "message_pbscip.h"
+/*--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
+
+#include "message_pb.h"
 #include "event_bestsol.h"
 
 #include <string.h>
@@ -97,7 +104,7 @@ SCIP_DECL_EVENTEXEC(eventExecBestsol)
    assert(scip != NULL);
    assert(SCIPeventGetType(event) == SCIP_EVENTTYPE_BESTSOLFOUND);
 
-   SCIPdebugMessage("exec method of event handler for pbscip\n");
+   SCIPdebugMessage("exec method of event handler for pbsolver\n");
 
    bestsol = SCIPgetBestSol(scip);
    assert(bestsol != NULL);
diff --git a/applications/PBSolver/src/event_bestsol.h b/applications/PBSolver/src/event_bestsol.h
@@ -3,7 +3,7 @@
 /*                  This file is part of the program and library             */
 /*         SCIP --- Solving Constraint Integer Programs                      */
 /*                                                                           */
-/*  Copyright (c) 2002-2024 Zuse Institute Berlin (ZIB)                      */
+/*  Copyright (c) 2002-2025 Zuse Institute Berlin (ZIB)                      */
 /*                                                                           */
 /*  Licensed under the Apache License, Version 2.0 (the "License");          */
 /*  you may not use this file except in compliance with the License.         */
@@ -22,6 +22,15 @@
 /*                                                                           */
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/**@file   event_bestsol.h
+ * @brief  eventhdlr to print the best solution value
+ * @author Alexander Hoen
+ * @author Gioni Mexi
+ */
+
+/*--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
 #ifndef __SCIP_EVENT_HANDLER_PB_H__
 #define __SCIP_EVENT_HANDLER_PB_H__
 
diff --git a/applications/PBSolver/src/main.cpp b/applications/PBSolver/src/main.cpp
@@ -3,7 +3,7 @@
 /*                  This file is part of the program and library             */
 /*         SCIP --- Solving Constraint Integer Programs                      */
 /*                                                                           */
-/*  Copyright (c) 2002-2024 Zuse Institute Berlin (ZIB)                      */
+/*  Copyright (c) 2002-2025 Zuse Institute Berlin (ZIB)                      */
 /*                                                                           */
 /*  Licensed under the Apache License, Version 2.0 (the "License");          */
 /*  you may not use this file except in compliance with the License.         */
@@ -22,6 +22,15 @@
 /*                                                                           */
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/**@file   main.cpp
+ * @brief  main file for the Pseudo-Boolean solver application
+ * @author Alexander Hoen
+ * @author Gioni Mexi
+ */
+
+/*--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
+
+
 #define PBSOLVER
 
 #include <cstdio>
@@ -30,7 +39,7 @@
 #include "scip/scip.h"
 #include "scip/scipdefplugins.h"
 #include "scip/scipshell.h"
-#include "message_pbscip.h"
+#include "message_pb.h"
 #include "event_bestsol.h"
 
 #define SETOBJ FALSE
@@ -277,7 +286,7 @@ SCIP_RETCODE fromCommandLine(
    {
       /* try to read the problem as opb format */
       SCIP_RETCODE scipRetcode = SCIPreadProb(scip, filename, "opb");
-      if( scipRetcode == SCIP_BIGINT)
+      if( scipRetcode == SCIP_INVALIDRESULT)
       {
          printUnsupportedSolution(scip);
          return SCIP_OKAY;
@@ -286,7 +295,7 @@ SCIP_RETCODE fromCommandLine(
    }
    else
    {
-      if( retcode == SCIP_BIGINT)
+      if( retcode == SCIP_INVALIDRESULT)
       {
          printUnsupportedSolution(scip);
          return SCIP_OKAY;
@@ -715,7 +724,7 @@ SCIP_RETCODE runShell(
    SCIPmessagehdlrCapture(defaultmessagehdlr);
 
    /* create own buffered message handler for PB output and overrides default scip message handler */
-   SCIP_CALL( SCIPcreateMessagehdlrPbscip(&messagehdlr, TRUE, NULL, FALSE) );
+   SCIP_CALL( SCIPcreateMessagehdlrPbSolver(&messagehdlr, TRUE, NULL, FALSE) );
 
    /* if we are running the PB competition we use this message handler to produce the required output */
    SCIP_CALL( SCIPsetMessagehdlr(scip, messagehdlr) );
diff --git a/applications/PBSolver/src/message_pb.c b/applications/PBSolver/src/message_pb.c
@@ -3,7 +3,7 @@
 /*                  This file is part of the program and library             */
 /*         SCIP --- Solving Constraint Integer Programs                      */
 /*                                                                           */
-/*  Copyright (c) 2002-2024 Zuse Institute Berlin (ZIB)                      */
+/*  Copyright (c) 2002-2025 Zuse Institute Berlin (ZIB)                      */
 /*                                                                           */
 /*  Licensed under the Apache License, Version 2.0 (the "License");          */
 /*  you may not use this file except in compliance with the License.         */
@@ -22,13 +22,21 @@
 /*                                                                           */
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/**@file   message_pb.c
+ * @brief  messagehdlr for the Pseudo-Boolean output format
+ * @author Alexander Hoen
+ * @author Gioni Mexi
+ */
+
+/*--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
+
 #define PBSOLVER
 
 #include <stdio.h>
 #include <string.h>
 
 #include "scip/scip.h"
-#include "message_pbscip.h"
+#include "message_pb.h"
 
 
 static
@@ -57,7 +65,7 @@ void printMessage(
 
 /** default error printing method which is used to print all occurring errors */
 static
-SCIP_DECL_ERRORPRINTING(messageErrorPbscip) {  /*lint --e{715}*/
+SCIP_DECL_ERRORPRINTING(messageErrorPbSolver) {  /*lint --e{715}*/
 
 #ifdef PBSOLVER
    fputs("c ", stderr);
@@ -68,24 +76,24 @@ SCIP_DECL_ERRORPRINTING(messageErrorPbscip) {  /*lint --e{715}*/
 
 /** warning message print method of default message handler */
 static
-SCIP_DECL_MESSAGEWARNING(messageWarningPbscip) {  /*lint --e{715}*/
+SCIP_DECL_MESSAGEWARNING(messageWarningPbSolver) {  /*lint --e{715}*/
    printMessage(messagehdlr, file, msg);
 }
 
 /** dialog message print method of default message handler */
 static
-SCIP_DECL_MESSAGEDIALOG(messageDialogPbscip) {  /*lint --e{715}*/
+SCIP_DECL_MESSAGEDIALOG(messageDialogPbSolver) {  /*lint --e{715}*/
    printMessage(messagehdlr, file, msg);
 }
 
 /** info message print method of default message handler */
 static
-SCIP_DECL_MESSAGEINFO(messageInfoPbscip) {  /*lint --e{715}*/
+SCIP_DECL_MESSAGEINFO(messageInfoPbSolver) {  /*lint --e{715}*/
    printMessage(messagehdlr, file, msg);
 }
 
 static
-SCIP_DECL_MESSAGEHDLRFREE(messagehdlrFreePbscip) {  /*lint --e{715}*/
+SCIP_DECL_MESSAGEHDLRFREE(messagehdlrFreePbSolver) {  /*lint --e{715}*/
    SCIP_MESSAGEHDLRDATA *messagehdlrdata;
 
    assert(messagehdlr != NULL);
@@ -99,8 +107,8 @@ SCIP_DECL_MESSAGEHDLRFREE(messagehdlrFreePbscip) {  /*lint --e{715}*/
 }
 
 
-/** creates default PBSCIP message handler */
-SCIP_RETCODE SCIPcreateMessagehdlrPbscip(
+/** creates default pbsolver message handler */
+SCIP_RETCODE SCIPcreateMessagehdlrPbSolver(
       SCIP_MESSAGEHDLR **messagehdlr,        /**< pointer to message handler */
       SCIP_Bool buffered,           /**< should the output be buffered */
       const char *filename,           /**< name of log file, or NULL (stdout) */
@@ -116,10 +124,10 @@ SCIP_RETCODE SCIPcreateMessagehdlrPbscip(
    messagehdlrdata->comment = FALSE;
 #endif
    SCIP_CALL(SCIPmessagehdlrCreate(messagehdlr, buffered, filename, quiet,
-                                   messageWarningPbscip, messageDialogPbscip, messageInfoPbscip, messagehdlrFreePbscip,
+                                   messageWarningPbSolver, messageDialogPbSolver, messageInfoPbSolver, messagehdlrFreePbSolver,
                                    messagehdlrdata));
 
-   SCIPmessageSetErrorPrinting(messageErrorPbscip, NULL);
+   SCIPmessageSetErrorPrinting(messageErrorPbSolver, NULL);
 
    return SCIP_OKAY;
 }
diff --git a/applications/PBSolver/src/message_pb.h b/applications/PBSolver/src/message_pb.h
@@ -3,7 +3,7 @@
 /*                  This file is part of the program and library             */
 /*         SCIP --- Solving Constraint Integer Programs                      */
 /*                                                                           */
-/*  Copyright (c) 2002-2024 Zuse Institute Berlin (ZIB)                      */
+/*  Copyright (c) 2002-2025 Zuse Institute Berlin (ZIB)                      */
 /*                                                                           */
 /*  Licensed under the Apache License, Version 2.0 (the "License");          */
 /*  you may not use this file except in compliance with the License.         */
@@ -22,6 +22,14 @@
 /*                                                                           */
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/**@file   message_pb.h
+ * @brief  messagehdlr for the Pseudo-Boolean output format
+ * @author Alexander Hoen
+ * @author Gioni Mexi
+ */
+
+/*--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
+
 #ifndef __SCIP_PB_MESSAGE_PB_H__
 #define __SCIP_PB_MESSAGE_PB_H__
 
@@ -37,9 +45,9 @@ struct SCIP_MessagehdlrData
    SCIP_Bool             comment;            /**< should output be printed as PB comments */
 };
 
-/** creates default PBSCIP message handler */
+/** creates default pbsolver message handler */
 extern
-SCIP_RETCODE SCIPcreateMessagehdlrPbscip(
+SCIP_RETCODE SCIPcreateMessagehdlrPbSolver(
    SCIP_MESSAGEHDLR**    messagehdlr,        /**< pointer to message handler */
    SCIP_Bool             buffered,           /**< should the output be buffered */
    const char*           filename,           /**< name of log file, or NULL (stdout) */
diff --git a/examples/Queens/src/scip_exception.hpp b/examples/Queens/src/scip_exception.hpp
@@ -102,9 +102,6 @@ inline char* SCIPgetErrorString(SCIP_RETCODE retcode, char* buffer_str, int buff
    case SCIP_NOTIMPLEMENTED:
       (void) SCIPsnprintf(buffer_str, buffersize, "function not implemented");
       return buffer_str;
-   case SCIP_BIGINT:
-      (void) SCIPsnprintf(buffer_str, buffersize, "big integers rejected");
-      return buffer_str;
    }
    return NULL;
 }
diff --git a/src/scip/reader_opb.c b/src/scip/reader_opb.c
@@ -1654,7 +1654,7 @@ SCIP_RETCODE readOPBFile(
    if( readerdata->maxintsize >= 0 && intsize > readerdata->maxintsize )
    {
       SCIPinfoMessage(scip, NULL, "Intsize %d exceeds %d maximum.\n", intsize, readerdata->maxintsize);
-      return SCIP_BIGINT;
+      return SCIP_INVALIDDATA;
    }
 
    /* create problem */
@@ -3982,7 +3982,7 @@ SCIP_RETCODE SCIPreadOpb(
    SCIPfreeBlockMemoryArray(scip, &opbinput.token, OPB_MAX_LINELEN);
    SCIPfreeBlockMemoryArray(scip, &opbinput.linebuf, opbinput.linebufsize);
 
-   if( retcode == SCIP_BIGINT )
+   if( retcode == SCIP_INVALIDDATA )
    {
       *result = SCIP_SUSPENDED;
       return SCIP_OKAY;
diff --git a/src/scip/retcode.c b/src/scip/retcode.c
@@ -103,9 +103,6 @@ void SCIPretcodePrint(
    case SCIP_NOTIMPLEMENTED:
       SCIPmessageFPrintInfo(messagehdlr, file, "function not implemented");
       break;
-   case SCIP_BIGINT:
-      SCIPmessageFPrintInfo(messagehdlr, file, "big integers rejected");
-      break;
    default:
       SCIPmessageFPrintInfo(messagehdlr, file, "unknown error code");
       break;
@@ -179,9 +176,6 @@ void SCIPretcodePrintError(
    case SCIP_NOTIMPLEMENTED:
       SCIPmessagePrintError("function not implemented");
       break;
-   case SCIP_BIGINT:
-      SCIPmessagePrintError("big integers rejected");
-      break;
    default:
       SCIPmessagePrintError("unknown error code");
       break;
diff --git a/src/scip/scip_prob.c b/src/scip/scip_prob.c
@@ -479,7 +479,7 @@ SCIP_RETCODE SCIPreadProb(
       retcode = SCIP_OKAY;
       break;
    case SCIP_SUSPENDED:
-      retcode = SCIP_BIGINT;
+      retcode = SCIP_INVALIDDATA;
       break;
    default:
       assert(i < scip->set->nreaders);
diff --git a/src/scip/type_retcode.h b/src/scip/type_retcode.h
@@ -58,8 +58,7 @@ enum SCIP_Retcode
    SCIP_KEYALREADYEXISTING = -15,       /**< the given key is already existing in table */
    SCIP_MAXDEPTHLEVEL      = -16,       /**< maximal branching depth level exceeded */
    SCIP_BRANCHERROR        = -17,       /**< no branching could be created */
-   SCIP_NOTIMPLEMENTED     = -18,       /**< function not implemented */
-   SCIP_BIGINT             = -19        /**< big integers rejected */
+   SCIP_NOTIMPLEMENTED     = -18        /**< function not implemented */
 };
 typedef enum SCIP_Retcode SCIP_RETCODE;           /**< return code for SCIP method */
 

Original file line number	Diff line number	Diff line change
`@@ -102,9 +102,6 @@ inline char* SCIPgetErrorString(SCIP_RETCODE retcode, char* buffer_str, int buff`
`102`	`102`	`case SCIP_NOTIMPLEMENTED:`
`103`	`103`	`(void) SCIPsnprintf(buffer_str, buffersize, "function not implemented");`
`104`	`104`	`return buffer_str;`
`105`		`- case SCIP_BIGINT:`
`106`		`- (void) SCIPsnprintf(buffer_str, buffersize, "big integers rejected");`
`107`		`- return buffer_str;`
`108`	`105`	`}`
`109`	`106`	`return NULL;`
`110`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1654,7 +1654,7 @@ SCIP_RETCODE readOPBFile(`
`1654`	`1654`	`if( readerdata->maxintsize >= 0 && intsize > readerdata->maxintsize )`
`1655`	`1655`	`{`
`1656`	`1656`	`SCIPinfoMessage(scip, NULL, "Intsize %d exceeds %d maximum.\n", intsize, readerdata->maxintsize);`
`1657`		`- return SCIP_BIGINT;`
	`1657`	`+ return SCIP_INVALIDDATA;`
`1658`	`1658`	`}`
`1659`	`1659`
`1660`	`1660`	`/* create problem */`
`@@ -3982,7 +3982,7 @@ SCIP_RETCODE SCIPreadOpb(`
`3982`	`3982`	`SCIPfreeBlockMemoryArray(scip, &opbinput.token, OPB_MAX_LINELEN);`
`3983`	`3983`	`SCIPfreeBlockMemoryArray(scip, &opbinput.linebuf, opbinput.linebufsize);`
`3984`	`3984`
`3985`		`- if( retcode == SCIP_BIGINT )`
	`3985`	`+ if( retcode == SCIP_INVALIDDATA )`
`3986`	`3986`	`{`
`3987`	`3987`	`*result = SCIP_SUSPENDED;`
`3988`	`3988`	`return SCIP_OKAY;`