From 6ee2c6763eaa2ae0dd7ff504705046c1702b3574 Mon Sep 17 00:00:00 2001 From: Marc Pfetsch Date: Mon, 16 Dec 2024 10:27:35 +0100 Subject: [PATCH 1/4] add support for [get|set]HeurTiming --- src/pyscipopt/scip.pxd | 2 ++ src/pyscipopt/scip.pxi | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/src/pyscipopt/scip.pxd b/src/pyscipopt/scip.pxd index 2b629053c..013faf9d0 100644 --- a/src/pyscipopt/scip.pxd +++ b/src/pyscipopt/scip.pxd @@ -1119,6 +1119,8 @@ cdef extern from "scip/scip.h": SCIP_HEURDATA* heurdata) SCIP_HEURDATA* SCIPheurGetData(SCIP_HEUR* heur) SCIP_HEUR* SCIPfindHeur(SCIP* scip, const char* name) + SCIP_HEURTIMING SCIPheurGetTimingmask(SCIP_HEUR* heur) + void SCIPheurSetTimingmask(SCIP_HEUR* heur, SCIP_HEURTIMING timingmask) #Relaxation plugin SCIP_RETCODE SCIPincludeRelax(SCIP* scip, diff --git a/src/pyscipopt/scip.pxi b/src/pyscipopt/scip.pxi index d95e45ea2..4a51dd1a5 100644 --- a/src/pyscipopt/scip.pxi +++ b/src/pyscipopt/scip.pxi @@ -2887,6 +2887,41 @@ cdef class Model: """ PY_SCIP_CALL(SCIPsetHeuristics(self._scip, setting, True)) + def setHeurTiming(self, heurname, heurtiming): + """ + Set the timing of a heuristic + + Parameters + ---------- + heurname : string, name of the heuristic + heurtiming : PY_SCIP_HEURTIMING + """ + cdef SCIP_HEUR* _heur + n = str_conversion(heurname) + _heur = SCIPfindHeur(self._scip, n) + if _heur == NULL: + raise ValueError("Could not find heuristic <%s>" % heurname) + SCIPheurSetTimingmask(_heur, heurtiming) + + def getHeurTiming(self, heurname): + """ + Get the timing of a heuristic + + Parameters + ---------- + heurname : string, name of the heuristic + + Returns + ------- + SCIP_HEURTIMING + """ + cdef SCIP_HEUR* _heur + n = str_conversion(heurname) + _heur = SCIPfindHeur(self._scip, n) + if _heur == NULL: + raise ValueError("Could not find heuristic <%s>" % heurname) + return SCIPheurGetTimingmask(_heur) + def disablePropagation(self, onlyroot=False): """ Disables propagation in SCIP to avoid modifying the original problem during transformation. From d57c40e89cd920e45f87f63f9a62aba6d24ae6b9 Mon Sep 17 00:00:00 2001 From: Marc Pfetsch Date: Mon, 16 Dec 2024 10:48:43 +0100 Subject: [PATCH 2/4] added test for heur timing --- tests/test_heur.py | 5 +++++ tests/test_heurtiming.py | 8 ++++++++ 2 files changed, 13 insertions(+) create mode 100644 tests/test_heurtiming.py diff --git a/tests/test_heur.py b/tests/test_heur.py index 454f11c74..a625475a7 100644 --- a/tests/test_heur.py +++ b/tests/test_heur.py @@ -130,3 +130,8 @@ def test_simple_round_heur(): timingmask=SCIP_HEURTIMING.DURINGLPLOOP) # solve problem s.optimize() + +def test_heurTiming(): + model = Model() + model.setHeurTiming('rins', SCIP_HEURTIMING.BEFORENODE) + print("timing of rins: %d\n" % model.getHeurTiming('rins')) diff --git a/tests/test_heurtiming.py b/tests/test_heurtiming.py new file mode 100644 index 000000000..9d955a641 --- /dev/null +++ b/tests/test_heurtiming.py @@ -0,0 +1,8 @@ +import pytest + +from pyscipopt import Model, SCIP_HEURTIMING + +def test_heurTiming(): + model = Model() + model.setHeurTiming('rins', SCIP_HEURTIMING.BEFORENODE) + print("timing of rins: %d\n" % model.getHeurTiming('rins')) From 8ad051c1acc12aed801f1de478cbda964f3147da Mon Sep 17 00:00:00 2001 From: Marc Pfetsch Date: Mon, 16 Dec 2024 10:50:23 +0100 Subject: [PATCH 3/4] extend documentation --- src/pyscipopt/scip.pxi | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/pyscipopt/scip.pxi b/src/pyscipopt/scip.pxi index 4a51dd1a5..e7bb98955 100644 --- a/src/pyscipopt/scip.pxi +++ b/src/pyscipopt/scip.pxi @@ -2895,6 +2895,7 @@ cdef class Model: ---------- heurname : string, name of the heuristic heurtiming : PY_SCIP_HEURTIMING + positions in the node solving loop where heuristic should be executed """ cdef SCIP_HEUR* _heur n = str_conversion(heurname) @@ -2913,7 +2914,8 @@ cdef class Model: Returns ------- - SCIP_HEURTIMING + PY_SCIP_HEURTIMING + positions in the node solving loop where heuristic should be executed """ cdef SCIP_HEUR* _heur n = str_conversion(heurname) From 9e8c96186c86a9171ee18f19b5b7ec22e03f3098 Mon Sep 17 00:00:00 2001 From: Joao-Dionisio Date: Mon, 16 Dec 2024 11:00:42 +0100 Subject: [PATCH 4/4] delete duplicate test, add CHANGELOG --- CHANGELOG.md | 1 + tests/test_heurtiming.py | 8 -------- 2 files changed, 1 insertion(+), 8 deletions(-) delete mode 100644 tests/test_heurtiming.py diff --git a/CHANGELOG.md b/CHANGELOG.md index cc662cc45..b323dd31d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Unreleased ### Added +- Added wrappers for setting and getting heuristic timing - Added transformed option to getVarDict, updated test - Added categorical data example - Added printProblem to print problem to stdout diff --git a/tests/test_heurtiming.py b/tests/test_heurtiming.py deleted file mode 100644 index 9d955a641..000000000 --- a/tests/test_heurtiming.py +++ /dev/null @@ -1,8 +0,0 @@ -import pytest - -from pyscipopt import Model, SCIP_HEURTIMING - -def test_heurTiming(): - model = Model() - model.setHeurTiming('rins', SCIP_HEURTIMING.BEFORENODE) - print("timing of rins: %d\n" % model.getHeurTiming('rins'))