Merge pull request #9 from jurgen-lentz/master

rename GCGModel to Model

CHANGELOG.md

@@ -6,6 +6,11 @@
 ### Changed
 ### Removed
 
+## v0.1.4
+### Changed
+* rename GCGModel to Model
+### Removed
+* pyscipopt.Model not importable with pygcgopt.Model anymore
 ## v0.1.3
 ### Added
 * Initial public release

docs/api/index.rst

@@ -3,7 +3,7 @@ API Reference
 
 .. toctree::
 
-    gcgmodel.rst
+    model.rst
     decomposition.rst
     detprobdata.rst
     detector.rst

docs/api/model.rst

@@ -0,0 +1,5 @@
+Model
+*************
+
+.. autoclass:: pygcgopt.gcg.Model
+    :members:

src/pygcgopt/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.1.3'
+__version__ = '0.1.4'
 
 # required for Python 3.8 on Windows
 import os
@@ -8,7 +8,6 @@
 
 # Expose pyscipopt object through pygcgopt
 from pyscipopt import multidict
-from pyscipopt import Model
 from pyscipopt import Benders
 from pyscipopt import Benderscut
 from pyscipopt import Branchrule
@@ -42,5 +41,5 @@
 from pyscipopt import SCIP_ROWORIGINTYPE
 
 # export user-relevant objects
-from pygcgopt.gcg import GCGModel, Detector, PricingSolver
+from pygcgopt.gcg import Model, Detector, PricingSolver
 from pygcgopt.gcg import PY_GCG_PRICINGSTATUS as GCG_PRICINGSTATUS

src/pygcgopt/detector.pxi

@@ -1,6 +1,6 @@
 cdef class Detector:
     """Base class of the Detector Plugin"""
-    cdef public Model model
+    cdef public SCIPModel model
     cdef public str detectorname
 
     def freeDetector(self):

src/pygcgopt/detprobdata.pxi

@@ -436,7 +436,7 @@ cdef class DetProbData:
         :return: the corresponding Model instance wrapping scip data structure.
         """
         cdef SCIP * scip = self.thisptr.getScip()
-        return Model.create(scip)
+        return SCIPModel.create(scip)
 
     def getSortedCandidatesNBlocks(DetProbData self, object candidates):
         """gets the candidates for number of blocks added by the user followed by the found ones sorted in descending order by how often a candidate was proposed

src/pygcgopt/gcg.pyx

@@ -1,7 +1,8 @@
 # distutils: language = c++
 
 from pyscipopt.scip import PY_SCIP_CALL
-from pyscipopt.scip cimport Model, Variable, Constraint, Solution, SCIP_RESULT, SCIP_DIDNOTRUN, SCIPgetStage, SCIP_STAGE, SCIP_STAGE_PRESOLVED, SCIP_OKAY, SCIPvarSetData, SCIPgetBestSol
+from pyscipopt.scip cimport Model as SCIPModel
+from pyscipopt.scip cimport Variable, Constraint, Solution, SCIP_RESULT, SCIP_DIDNOTRUN, SCIPgetStage, SCIP_STAGE, SCIP_STAGE_PRESOLVED, SCIP_OKAY, SCIPvarSetData, SCIPgetBestSol
 
 from cpython cimport Py_INCREF, Py_DECREF
 
@@ -50,7 +51,7 @@ cdef class PY_GCG_PRICINGSTATUS:
     UNBOUNDED = GCG_PRICINGSTATUS_UNBOUNDED
 
 
-cdef class GCGModel(Model):
+cdef class Model(SCIPModel):
     """Main class for interaction with the GCG solver."""
 
     def includeDefaultPlugins(self):
@@ -183,16 +184,16 @@ cdef class GCGModel(Model):
         c_desc = str_conversion(desc)
 
         PY_SCIP_CALL(GCGpricerIncludeSolver(
-            (<Model>self.getMasterProb())._scip, c_solvername, c_desc, priority, heuristicEnabled, exactEnabled, PyPricingSolverUpdate,
+            (<SCIPModel>self.getMasterProb())._scip, c_solvername, c_desc, priority, heuristicEnabled, exactEnabled, PyPricingSolverUpdate,
             PyPricingSolverSolve, PyPricingSolverSolveHeur, PyPricingSolverFree, PyPricingSolverInit, PyPricingSolverExit,
             PyPricingSolverInitSol, PyPricingSolverExitSol, <GCG_SOLVERDATA*>pricingSolver))
 
-        pricingSolver.model = <Model>weakref.proxy(self)
+        pricingSolver.model = <SCIPModel>weakref.proxy(self)
         pricingSolver.solvername = solvername
         Py_INCREF(pricingSolver)
 
     def listPricingSolvers(self):
-        cdef Model mp = <Model>self.getMasterProb()
+        cdef SCIPModel mp = <SCIPModel>self.getMasterProb()
         cdef int n_pricing_solvers = GCGpricerGetNSolvers(mp._scip)
         cdef GCG_SOLVER** pricing_solvers = GCGpricerGetSolvers(mp._scip)
 
@@ -257,7 +258,7 @@ cdef class GCGModel(Model):
             PyDetectorExit, PyDetectorPropagatePartialdec, PyDetectorFinishPartialdec, PyDetectorPostprocessPartialdec,
             PyDetectorSetParamAggressive, PyDetectorSetParamDefault, PyDetectorSetParamFast))
 
-        detector.model = <Model>weakref.proxy(self)
+        detector.model = <SCIPModel>weakref.proxy(self)
         detector.detectorname = detectorname
         Py_INCREF(detector)
 
@@ -348,7 +349,7 @@ cdef class GCGModel(Model):
         PY_SCIP_CALL(DECwriteAllDecomps(self._scip, c_directory, c_extension, original, presolved))
 
 
-cdef class GCGPricingModel(Model):
+cdef class GCGPricingModel(SCIPModel):
     @staticmethod
     cdef create(SCIP* scip):
         """Creates a pricing problem model and appropriately assigns the scip and bestsol parameters
@@ -388,7 +389,7 @@ cdef class GCGPricingModel(Model):
         return pyGCGCol
 
 
-cdef class GCGMasterModel(Model):
+cdef class GCGMasterModel(SCIPModel):
     @staticmethod
     cdef create(SCIP* scip):
         """Creates a pricing problem model and appropriately assigns the scip and bestsol parameters

src/pygcgopt/pricing_solver.pxi

@@ -1,7 +1,7 @@
 cdef class PricingSolver:
     """Base class of the Pricing Solver Plugin"""
 
-    cdef public Model model
+    cdef public SCIPModel model
     cdef public str solvername
 
     def freeSolver(self):

tests/test_pricing_solver.py

@@ -3,12 +3,10 @@
 from functools import reduce
 from collections import defaultdict
 
-from pygcgopt import GCGModel, quicksum, PricingSolver, GCG_PRICINGSTATUS
+from pygcgopt import Model, PricingSolver, GCG_PRICINGSTATUS
 
 from ortools.algorithms import pywrapknapsack_solver
 
-from test_cpmp import build_model
-
 import pytest
 
 import os
@@ -151,7 +149,7 @@ def test_pypricer_fast(lp_file, dec_file):
     lp_file = os.path.join(dirname, lp_file)
     dec_file = os.path.join(dirname, dec_file)
 
-    m = GCGModel()
+    m = Model()
     m.readProblem(lp_file)
     m.readProblem(dec_file)
 
@@ -161,7 +159,7 @@ def test_pypricer_fast(lp_file, dec_file):
 
     gcg_pricer_sol_obj_val = m.getSolObjVal(m.getBestSol())
 
-    m = GCGModel()
+    m = Model()
     m.readProblem(lp_file)
     m.readProblem(dec_file)