Apply suggestions from code review

Co-authored-by: DominikKamp <130753997+DominikKamp@users.noreply.github.com>

Author: Joao-Dionisio

CHANGELOG.md

@@ -4,7 +4,7 @@
 ### Added
 - Added support for knapsack constraints
 - Added isPositive(), isNegative(), isFeasLE(), isFeasLT(), isFeasGE(), isFeasGT(), isHugeValue(), and tests
-- Added SCIP_LOCKTYPE, addVarLocksType, getNLocksDown, getNLocksUp, getNLocksUpType, getNLocksDownType, and tests
+- Added SCIP_LOCKTYPE, addVarLocksType(), getNLocksDown(), getNLocksUp(), getNLocksDownType(), getNLocksUpType(), and tests
 ### Fixed
 ### Changed
 ### Removed

src/pyscipopt/scip.pxd

@@ -799,8 +799,8 @@ cdef extern from "scip/scip.h":
     SCIP_RETCODE SCIPaddVarLocksType(SCIP* scip, SCIP_VAR* var, SCIP_LOCKTYPE locktype, int nlocksdown, int nlocksup)
     int SCIPvarGetNLocksDown(SCIP_VAR* var)
     int SCIPvarGetNLocksUp(SCIP_VAR* var)
-    int SCIPvarGetNLocksUpType(SCIP_VAR* var, SCIP_LOCKTYPE locktype)
     int SCIPvarGetNLocksDownType(SCIP_VAR* var, SCIP_LOCKTYPE locktype)
+    int SCIPvarGetNLocksUpType(SCIP_VAR* var, SCIP_LOCKTYPE locktype)
     SCIP_VAR** SCIPgetVars(SCIP* scip)
     SCIP_VAR** SCIPgetOrigVars(SCIP* scip)
     const char* SCIPvarGetName(SCIP_VAR* var)
@@ -831,7 +831,7 @@ cdef extern from "scip/scip.h":
     SCIP_Real SCIPvarGetCutoffSum(SCIP_VAR* var, SCIP_BRANCHDIR dir)
     SCIP_Longint SCIPvarGetNBranchings(SCIP_VAR* var, SCIP_BRANCHDIR dir)
     SCIP_Bool SCIPvarMayRoundUp(SCIP_VAR* var)
-    SCIP_Bool SCIPvarMayRoundDown(SCIP_VAR*  var)
+    SCIP_Bool SCIPvarMayRoundDown(SCIP_VAR* var)
 
     # LP Methods
     SCIP_RETCODE SCIPgetLPColsData(SCIP* scip, SCIP_COL*** cols, int* ncols)
@@ -920,8 +920,8 @@ cdef extern from "scip/scip.h":
     SCIP_Real SCIPgetGap(SCIP* scip)
     int SCIPgetDepth(SCIP* scip)
     SCIP_RETCODE SCIPcutoffNode(SCIP* scip, SCIP_NODE* node)
-    SCIP_Bool SCIPhasPrimalRay(SCIP*  scip)
-    SCIP_Real SCIPgetPrimalRayVal(SCIP*  scip, SCIP_VAR*  var)
+    SCIP_Bool SCIPhasPrimalRay(SCIP* scip)
+    SCIP_Real SCIPgetPrimalRayVal(SCIP* scip, SCIP_VAR* var)
     SCIP_RETCODE SCIPaddSolFree(SCIP* scip, SCIP_SOL** sol, SCIP_Bool* stored)
     SCIP_RETCODE SCIPaddSol(SCIP* scip, SCIP_SOL* sol, SCIP_Bool* stored)
     SCIP_RETCODE SCIPreadSol(SCIP* scip, const char* filename)
@@ -1065,7 +1065,7 @@ cdef extern from "scip/scip.h":
                                      SCIP_RETCODE (*consgetnvars) (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons, int* nvars, SCIP_Bool* success),
                                      SCIP_RETCODE (*consgetdivebdchgs) (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_DIVESET* diveset, SCIP_SOL* sol, SCIP_Bool* success, SCIP_Bool* infeasible),
                                      SCIP_RETCODE (*consgetpermsymgraph)(SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons, SYM_GRAPH* graph, SCIP_Bool* success),
-                                     SCIP_RETCODE (*consgetsignedpermsymgraph)(SCIP*  scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS*  cons, SYM_GRAPH*  graph, SCIP_Bool*  success),
+                                     SCIP_RETCODE (*consgetsignedpermsymgraph)(SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS* cons, SYM_GRAPH* graph, SCIP_Bool* success),
                                      SCIP_CONSHDLRDATA* conshdlrdata)
     SCIP_CONSHDLRDATA* SCIPconshdlrGetData(SCIP_CONSHDLR* conshdlr)
     SCIP_CONSHDLR* SCIPfindConshdlr(SCIP* scip, const char* name)
@@ -1634,7 +1634,7 @@ cdef extern from "scip/cons_disjunction.h":
                                             const char* name,
                                             int nconss,
                                             SCIP_CONS** conss,
-                                            SCIP_CONS*  relaxcons,
+                                            SCIP_CONS* relaxcons,
                                             SCIP_Bool initial,
                                             SCIP_Bool enforce,
                                             SCIP_Bool check,
@@ -1643,7 +1643,7 @@ cdef extern from "scip/cons_disjunction.h":
                                             SCIP_Bool dynamic)
 
     SCIP_RETCODE SCIPaddConsElemDisjunction(SCIP* scip,
-                                            SCIP_CONS*  cons,
+                                            SCIP_CONS* cons,
                                             SCIP_CONS* addcons)
 
 cdef extern from "scip/cons_and.h":

src/pyscipopt/scip.pxi

@@ -1696,37 +1696,37 @@ cdef class Variable(Expr):
         """
         return SCIPvarGetNLocksUp(self.scip_var)
 
-    def getNLocksUpType(self, locktype):
+    def getNLocksDownType(self, locktype):
         """
-        Returns the number of locks for rounding up of a certain type.
+        Returns the number of locks for rounding down of a certain type.
 
         Parameters
         ----------
         locktype: PY_SCIP_LOCKTYPE
-            types of variable locks
+            type of variable locks
 
         Returns
         -------
         int
 
         """
-        return SCIPvarGetNLocksUpType(self.scip_var, locktype)
-    
-    def getNLocksDownType(self, locktype):
+        return SCIPvarGetNLocksDownType(self.scip_var, locktype)
+
+    def getNLocksUpType(self, locktype):
         """
-        Returns the number of locks for rounding down of a certain type.
+        Returns the number of locks for rounding up of a certain type.
 
         Parameters
         ----------
         locktype: PY_SCIP_LOCKTYPE
-            types of variable locks
+            type of variable locks
 
         Returns
         -------
         int
 
         """
-        return SCIPvarGetNLocksDownType(self.scip_var, locktype)
+        return SCIPvarGetNLocksUpType(self.scip_var, locktype)
 
     def varMayRound(self, direction="down"):
         """
@@ -3159,7 +3159,7 @@ cdef class Model:
 
     def isFeasLE(self, val1, val2):
         """
-        Returns whether relative difference between val1 and val2 is lower than feasibility tolerance.
+        Returns whether relative difference between val1 and val2 is not greater than feasibility tolerance.
 
         Parameters
         ----------
@@ -3191,7 +3191,7 @@ cdef class Model:
 
     def isFeasGE(self, val1, val2):
         """
-        Returns whether relative difference of val1 and val2 is greater than minus feasibility tolerance.
+        Returns whether relative difference of val1 and val2 is not lower than minus feasibility tolerance.
 
         Parameters
         ----------
@@ -3937,12 +3937,12 @@ cdef class Model:
         ----------
         var : Variable
             variable to adjust the locks for
-        type : str
-            type of the variable locks
+        locktype : PY_SCIP_LOCKTYPE
+            type of variable locks
         nlocksdown : int
-            modification in number of rounding down locks
+            modification in number of down locks
         nlocksup : int
-            modification in number of rounding up locks
+            modification in number of up locks
 
         """
         PY_SCIP_CALL(SCIPaddVarLocksType(self._scip, var.scip_var, locktype, nlocksdown, nlocksup))

tests/helpers/utils.py

@@ -64,7 +64,7 @@ def random_nlp_1():
     w = model.addVar(name="w")
     x = model.addVar(name="x")
     y = model.addVar(name="y", ub=1.4)
-    z = model.addVar(name="z")
+    z = model.addVar(name="z", ub=4)
 
     model.addCons(exp(v) + log(w) + sqrt(x) + sin(y) + z ** 3 * y <= 5)
     model.setObjective(v + w + x + y + z, sense='maximize')
@@ -259,4 +259,5 @@ def gastrans_lp():
     model = gastrans_model()
     model.relax()
 
-    return model
+    return model
+