OR-Tools Integration & C++17 upgrade

.github/workflows/ci.yml

@@ -8,6 +8,7 @@ env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
   BUILD_TYPE: Release
   GTEST_REF: b85864c64758dec007208e56af933fc3f52044ee
+  ORTOOLS_VER: "9.8"
 
 jobs:
   build-on-ubuntu:
@@ -27,7 +28,27 @@ jobs:
         echo "GTEST=$GTEST" >> $GITHUB_ENV
         SSCDIR=$GITHUB_WORKSPACE/ssc
         echo "SSCDIR=$SSCDIR" >> $GITHUB_ENV
+        ORTOOLSDIR=$GITHUB_WORKSPACE/or-tools
+        echo "ORTOOLSDIR=$ORTOOLSDIR" >> $GITHUB_ENV
 
+    - name: Get cached OR-Tools
+      uses: actions/cache@v4
+      id: cachedortools
+      with:
+        path: ${{env.ORTOOLSDIR}}/
+        key: ortools-ubuntu
+
+    - name: Download OR-Tools
+      if: steps.cachedortools.outputs.cache-hit != 'true'
+      run: |
+          sudo apt update
+          sudo apt install -y build-essential cmake lsb-release
+          cd $GITHUB_WORKSPACE
+          wget -q https://github.com/google/or-tools/releases/download/v${ORTOOLS_VER}/or-tools_amd64_ubuntu-22.04_cpp_v${ORTOOLS_VER}.3296.tar.gz
+          tar -xvf or-tools_amd64_ubuntu-*
+          mkdir or-tools
+          mv or-tools*/* or-tools
+
     - name: Get cached GTest
       uses: actions/cache@v4
       id: cachedgtest
@@ -51,7 +72,7 @@ jobs:
           cd ${GTEST}/build
           cmake -DCMAKE_CXX_FLAGS=-std=c++11 ..
           make          
-    
+
     - name: Checkout SSC
       uses: actions/checkout@v4
       with:
@@ -62,7 +83,7 @@ jobs:
       run: |
         mkdir ${SSCDIR}/build
         cd ${SSCDIR}/build
-        cmake .. -DCMAKE_BUILD_TYPE=Release -DSAM_SKIP_TOOLS=1
+        cmake .. -DCMAKE_BUILD_TYPE=Release -DSAM_SKIP_TOOLS=1 -DCMAKE_INSTALL_PREFIX=${ORTOOLSDIR}
 
     - name: Build
       # Build your program with the given configuration
@@ -78,7 +99,7 @@ jobs:
         ${SSCDIR}/build/test/Test
 
     - name: Upload Artifacts
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v2
       with:
           name: SSC Linux Shared Libraries
           path: |
@@ -105,13 +126,39 @@ jobs:
         echo "GTEST=$GTEST" >> $GITHUB_ENV
         SSCDIR=$GITHUB_WORKSPACE/ssc
         echo "SSCDIR=$SSCDIR" >> $GITHUB_ENV
+        ORTOOLSDIR=$GITHUB_WORKSPACE/or-tools
+        echo "ORTOOLSDIR=$ORTOOLSDIR" >> $GITHUB_ENV
 
+    - name: Get cached OR-Tools
+      uses: actions/cache@v4
+      id: cachedortools
+      with:
+        path: ${{env.ORTOOLSDIR}}/
+        key: ortools-${{ matrix.os }}
+
+    - name: download OR-Tools for Arm64
+      if: ${{ matrix.os == 'macos-latest' && steps.cachedortools.outputs.cache-hit != 'true'}}
+      run: |
+          cd $GITHUB_WORKSPACE
+          curl -LJO https://github.com/google/or-tools/releases/download/v${ORTOOLS_VER}/or-tools_arm64_macOS-14.1_cpp_v${ORTOOLS_VER}.3296.tar.gz
+          tar -xvf or-tools_arm64*.tar.gz
+          mkdir or-tools
+          mv or-tools*/* or-tools
+    - name: download OR-Tools for Intel
+      if: ${{ matrix.os == 'macos-14-large' && steps.cachedortools.outputs.cache-hit != 'true'}}
+      run: |
+          cd $GITHUB_WORKSPACE
+          curl -LJO https://github.com/google/or-tools/releases/download/v${ORTOOLS_VER}/or-tools_x86_64_macOS-14.1_cpp_v${ORTOOLS_VER}.3296.tar.gz
+          tar -xvf or-tools_x86_64*tar.gz
+          mkdir or-tools
+          mv or-tools*/* or-tools
+
     - name: Get cached GTest
       uses: actions/cache@v4
       id: cachedgtest
       with:
         path: ${{env.GTEST}}/
-        key: gtest-${{ matrix.os }}
+        key: ortools-${{ matrix.os }}
     - name: Clone Gtest
       if: steps.cachedgtest.outputs.cache-hit != 'true'
       uses: actions/checkout@v4
@@ -139,7 +186,7 @@ jobs:
       run: |
         mkdir ${SSCDIR}/build
         cd ${SSCDIR}/build
-        cmake .. -DCMAKE_BUILD_TYPE=Release -DSAM_SKIP_TOOLS=1 -DSAMAPI_EXPORT=0 
+        cmake .. -DCMAKE_BUILD_TYPE=Release -DSAM_SKIP_TOOLS=1 -DSAMAPI_EXPORT=0 -DCMAKE_INSTALL_PREFIX=${ORTOOLSDIR}
 
     - name: Build
       # Build your program with the given configuration
@@ -152,11 +199,11 @@ jobs:
       run: |
         set -e
         ${SSCDIR}/build/test/Test
-      shell: bash      
+      shell: bash
 
     - name: Upload Artifacts
       if: ${{ matrix.os == 'macos-latest' }}
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v2
       with:
           name: SSC Mac Arm Shared Libraries
           path: |
@@ -165,15 +212,15 @@ jobs:
 
     - name: Upload Artifacts
       if: ${{ matrix.os != 'macos-latest' }}
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v2
       with:
           name: SSC Mac Intel Shared Libraries
           path: |
             ${{env.SSCDIR}}/build/ssc/libssc.dylib
             ${{env.SSCDIR}}/build/ssc/ssc.dylib 
 
   build-on-windows:
-    runs-on: windows-2019
+    runs-on: windows-latest
 
     steps:
     - name: Setup cmake
@@ -190,7 +237,25 @@ jobs:
         echo "GTEST=$GTEST" >> $GITHUB_ENV
         SSCDIR=$GITHUB_WORKSPACE/ssc
         echo "SSCDIR=$SSCDIR" >> $GITHUB_ENV
-
+        ORTOOLSDIR=$GITHUB_WORKSPACE/or-tools/install
+        echo "ORTOOLSDIR=$ORTOOLSDIR" >> $GITHUB_ENV
+
+    - name: Get cached OR-Tools
+      uses: actions/cache@v4
+      id: cachedortools
+      with:
+        path: ${{env.ORTOOLSDIR}}
+        key: ortools-windows
+
+    - name: Download OR-Tools
+      if: steps.cachedortools.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        cd $GITHUB_WORKSPACE
+        curl -LJO https://github.com/google/or-tools/releases/download/v${ORTOOLS_VER}/or-tools_x64_VisualStudio2022_cpp_v${ORTOOLS_VER}.3296.zip
+        unzip or-tools_x64_VisualStudio2022_cpp_* -d or-tools
+        mv or-tools/or-tools_* $ORTOOLSDIR
+
     - name: Get cached GTest
       uses: actions/cache@v4
       id: cachedgtest
@@ -210,7 +275,6 @@ jobs:
       if: steps.cachedgtest.outputs.cache-hit != 'true'
       shell: bash
       run: | 
-          export 
           mkdir ${GTEST}/build
           cd ${GTEST}/build
           cmake -Dgtest_force_shared_crt=ON ..
@@ -221,19 +285,18 @@ jobs:
       with:
           path: ssc
 
-    - name: Configure CMake
+    - name: Build SSC
       shell: bash
-      # Configure cmake to build ssc tests but not tools
       run: |
-        mkdir ${SSCDIR}/build
-        cd ${SSCDIR}/build
-        cmake .. -DSAM_SKIP_TOOLS=1 -DCMAKE_CONFIGURATION_TYPES="Release"
-        cmake --build . --config Release -j4
+        # Downloaded OR-Tools has CoinOR enabled
+        mkdir $SSCDIR/build
+        cd $SSCDIR/build
+        cmake .. -DSAM_SKIP_TOOLS=1 -DCMAKE_CONFIGURATION_TYPES="Release" -DCMAKE_SYSTEM_VERSION="10.0" -DCMAKE_GENERATOR_PLATFORM=x64 -DUSE_COINOR=1 -DCMAKE_GENERATOR_PLATFORM=x64 -DUSE_COINOR=1 
+        cmake --build . --config Release -j4 --target Test
         cp ssc/Release/* test/Release
 
     - name: Test
       shell: bash
-      # Turn off fast fail for when the landbosse tests write to cerr
       run: |
         cd ${SSCDIR}/build/test/Release
         ./Test.exe

.gitignore

@@ -33,6 +33,8 @@ bld/
 build/
 cmake-build-debug/
 cmake-build-release/
+CMakeFiles
+CMakeCache.txt
 test/Test
 
 # Visual Studio 2015 cache/options directory
@@ -344,6 +346,7 @@ build_osx/Test
 build_linux/Test
 build_linux/config.status
 linux_test\.txt
+build2
 
 nlopt/config.h
 nlopt/config.status
@@ -360,3 +363,5 @@ ssc/ssc\.exp
 ssc/sscd\.exp
 
 build_android/lib_oldssc.zip
+
+or-tools

CMakeLists.txt

@@ -16,6 +16,18 @@ option(SAM_SKIP_TESTS "Skips building tests" OFF)
 
 option(SAMAPI_EXPORT "Export of ssc binaries to the SAM_api directory; for Unix, compile ssc libraries for SAM_api" ON)
 
+include(CMakeDependentOption)
+
+CMAKE_DEPENDENT_OPTION(BUILD_DEPS "Build OR-Tools dependencies" ON "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(USE_COINOR "Use the COIN-OR solver" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(USE_HIGHS "Use the HiGHS solver" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(BUILD_EXAMPLES "Build examples" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(BUILD_SAMPLES "Build samples" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(INSTALL_DOC "Install doc" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(USE_COINOR "Use COINOR solvers" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(USE_XPRESS "Adds support for the XPRESS Solver" OFF "NOT SKIP_ORTOOLS" OFF)
+
+
 #
 # If project isn't system_advisor_model and SAM_SKIP_TOOLS=1,
 #   environment vars LK_LIB and LKD_LIB can be used to specify where to find those libraries
@@ -26,10 +38,10 @@ if(APPLE)
 endif()
 
 if (UNIX AND NOT CMAKE_C_COMPILER)
-	set(CMAKE_C_COMPILER gcc)
-	set(CMAKE_CXX_COMPILER g++)
+    set(CMAKE_C_COMPILER gcc)
+    set(CMAKE_CXX_COMPILER g++)
 endif()
-set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD 20)
 
 if ( NOT APPLE)
     set(CURL_DIR build_resources/libcurl_ssl_x64)
@@ -45,7 +57,6 @@ Project(sam_simulation_core VERSION 1.0.0)
 #####################################################################################################################
 set(CMAKE_VERBOSE_MAKEFILE ON)
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
-set(CMAKE_CXX_STANDARD 11)
 
 function(set_no_warnings target)
     get_target_property(MAIN_CFLAGS ${target} COMPILE_FLAGS)
@@ -82,14 +93,15 @@ function(set_default_compile_options target)
         set(MAIN_CFLAGS "")
     endif()
     set(MAIN_CFLAGS "${MAIN_CFLAGS} -D__64BIT__")
+    set_property(TARGET ${target} PROPERTY CXX_STANDARD 20)
+    set_property(TARGET ${target} PROPERTY CXX_STANDARD_REQUIRED ON)
     if(MSVC)
         set(MAIN_CFLAGS "${MAIN_CFLAGS} /bigobj /MP")
         set(MAIN_CFLAGS "${MAIN_CFLAGS} /D__WINDOWS__ /D_WINDOWS /D_CRT_SECURE_NO_WARNINGS /DLPWINAPP")
         foreach (flag_var CMAKE_C_FLAGS_DEBUG CMAKE_CXX_FLAGS_DEBUG)
             set(${flag_var} "${${flag_var}} /D_DEBUG" CACHE STRING "compile flags" FORCE)
         endforeach()
     else(MSVC)
-        SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
         if (APPLE)
             set(MAIN_CFLAGS "${MAIN_CFLAGS} -fno-common -DWX_PRECOMP -D__MACOSX__")
         else()
@@ -119,7 +131,7 @@ function(set_tools_compile_options target)
         if (APPLE)
             set(MAIN_CFLAGS "${MAIN_CFLAGS} -D__WXOSX__")
         endif()
-        set(MAIN_CFLAGS "${MAIN_CFLAGS} -Wall -Wno-deprecated -Wno-unknown-pragmas -Wno-overloaded-virtual -fno-common -std=c++11")
+        set(MAIN_CFLAGS "${MAIN_CFLAGS} -Wall -Wno-deprecated -Wno-unknown-pragmas -Wno-overloaded-virtual -fno-common")
         set(MAIN_CFLAGS "${MAIN_CFLAGS} -DLK_USE_WXWIDGETS")
     endif(MSVC)
     set_target_properties(${target} PROPERTIES COMPILE_FLAGS ${MAIN_CFLAGS})
@@ -150,9 +162,9 @@ add_subdirectory(tcs)
 add_subdirectory(ssc)
 
 if (NOT SAM_SKIP_TOOLS)
-	add_subdirectory(sdktool)
+    add_subdirectory(sdktool)
 endif()
 
 if (NOT SAM_SKIP_TESTS)
-	add_subdirectory(test)
+    add_subdirectory(test)
 endif()

code_attic/cmod_tcstrough_physical_csp_solver.cpp

@@ -30,6 +30,8 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
+#define _HAS_STD_BYTE 0
+
 // Trough CSP - physical model
 #include "core.h"
 #include "tckernel.h"

code_attic/cmod_trough_physical_iph_old.cpp

@@ -30,6 +30,8 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
+#define _HAS_STD_BYTE 0
+
 // Trough CSP - physical model
 #include "core.h"
 //#include "tckernel.h"

lpsolve/commonlib.cpp

@@ -381,8 +381,8 @@ int CMP_CALLMODEL compareREAL(const void *current, const void *candidate)
    where interchanges are reflected in a caller-initialized integer "tags" list. */
 void hpsort(void *attributes, int count, int offset, int recsize, MYBOOL descending, findCompare_func findCompare)
 {
-  register int  i, j, k, ir, order;
-  register char *hold, *base;
+  int  i, j, k, ir, order;
+  char *hold, *base;
   char          *save;
 
   if(count < 2)
@@ -443,8 +443,8 @@ void hpsortex(void *attributes, int count, int offset, int recsize, MYBOOL desce
     return;
   }
   else {
-    register int  i, j, k, ir, order;
-    register char *hold, *base;
+    int  i, j, k, ir, order;
+    char *hold, *base;
     char          *save;
     int           savetag;
 
@@ -528,7 +528,7 @@ void qsortex_swap(void *attributes, int l, int r, int recsize,
 int qsortex_sort(void *attributes, int l, int r, int recsize, int sortorder, findCompare_func findCompare,
                         void *tags, int tagsize, char *save, char *savetag)
 {
-  register int i, j, nmove = 0;
+  int i, j, nmove = 0;
   char     *v;
 
   /* Perform the a fast QuickSort */
@@ -667,7 +667,7 @@ void QS_delete(UNIONTYPE QSORTrec a[], int ipos, int epos)
 }
 int QS_sort(UNIONTYPE QSORTrec a[], int l, int r, findCompare_func findCompare)
 {
-  register int i, j, nmove = 0;
+  int i, j, nmove = 0;
   UNIONTYPE QSORTrec v;
 
   /* Perform the a fast QuickSort */

lpsolve/lp_BFP2.cpp

@@ -158,9 +158,9 @@ REAL BFP_CALLMODEL bfp_pivotRHS(lprec *lp, LREAL theta, REAL *pcol)
     pcol = lu->pcol;
 
   if(theta != 0) {
-    register int    i, n = lp->rows;
-    register LREAL  roundzero = lp->epsvalue;
-    register LREAL  *rhs = lp->rhs, rhsmax = 0;
+    int    i, n = lp->rows;
+    LREAL  roundzero = lp->epsvalue;
+    LREAL  *rhs = lp->rhs, rhsmax = 0;
 
     for(i = 0; i <= n; i++, rhs++, pcol++) {
       (*rhs) -= theta * (*pcol);