PySCIPOpt 5.7.1__cp39-cp39-win_amd64.whl → 6.1.0__cp39-cp39-win_amd64.whl

pyscipopt/scip.pxd

@@ -28,6 +28,7 @@ cdef extern from "scip/scip.h":
         SCIP_VARTYPE SCIP_VARTYPE_BINARY
         SCIP_VARTYPE SCIP_VARTYPE_INTEGER
         SCIP_VARTYPE SCIP_VARTYPE_IMPLINT
+        SCIP_VARTYPE SCIP_DEPRECATED_VARTYPE_IMPLINT
         SCIP_VARTYPE SCIP_VARTYPE_CONTINUOUS
 
     ctypedef int SCIP_VARSTATUS
@@ -267,12 +268,15 @@ cdef extern from "scip/scip.h":
         SCIP_EVENTTYPE SCIP_EVENTTYPE_LHOLEADDED
         SCIP_EVENTTYPE SCIP_EVENTTYPE_LHOLEREMOVED
         SCIP_EVENTTYPE SCIP_EVENTTYPE_IMPLADDED
+        SCIP_EVENTTYPE SCIP_EVENTTYPE_TYPECHANGED
+        SCIP_EVENTTYPE SCIP_EVENTTYPE_IMPLTYPECHANGED
         SCIP_EVENTTYPE SCIP_EVENTTYPE_PRESOLVEROUND
         SCIP_EVENTTYPE SCIP_EVENTTYPE_NODEFOCUSED
         SCIP_EVENTTYPE SCIP_EVENTTYPE_NODEFEASIBLE
         SCIP_EVENTTYPE SCIP_EVENTTYPE_NODEINFEASIBLE
         SCIP_EVENTTYPE SCIP_EVENTTYPE_NODEBRANCHED
         SCIP_EVENTTYPE SCIP_EVENTTYPE_NODEDELETE
+        SCIP_EVENTTYPE SCIP_EVENTTYPE_DUALBOUNDIMPROVED
         SCIP_EVENTTYPE SCIP_EVENTTYPE_FIRSTLPSOLVED
         SCIP_EVENTTYPE SCIP_EVENTTYPE_LPSOLVED
         SCIP_EVENTTYPE SCIP_EVENTTYPE_POORSOLFOUND
@@ -302,6 +306,7 @@ cdef extern from "scip/scip.h":
         SCIP_EVENTTYPE SCIP_EVENTTYPE_LPEVENT
         SCIP_EVENTTYPE SCIP_EVENTTYPE_SOLFOUND
         SCIP_EVENTTYPE SCIP_EVENTTYPE_SOLEVENT
+        SCIP_EVENTTYPE SCIP_EVENTTYPE_GAPUPDATED        
         SCIP_EVENTTYPE SCIP_EVENTTYPE_ROWCHANGED
         SCIP_EVENTTYPE SCIP_EVENTTYPE_ROWEVENT
 
@@ -314,6 +319,12 @@ cdef extern from "scip/scip.h":
     cdef extern from "scip/type_var.h":
         SCIP_LOCKTYPE SCIP_LOCKTYPE_MODEL
         SCIP_LOCKTYPE SCIP_LOCKTYPE_CONFLICT
+    
+    ctypedef int SCIP_IMPLINTTYPE
+    cdef extern from "scip/type_var.h":
+        SCIP_IMPLINTTYPE SCIP_IMPLINTTYPE_NONE
+        SCIP_IMPLINTTYPE SCIP_IMPLINTTYPE_WEAK
+        SCIP_IMPLINTTYPE SCIP_IMPLINTTYPE_STRONG
 
     ctypedef int SCIP_BENDERSENFOTYPE
     cdef extern from "scip/type_benders.h":
@@ -370,6 +381,9 @@ cdef extern from "scip/scip.h":
 
     ctypedef double SCIP_Real
 
+    ctypedef struct SCIP_RATIONAL:
+        pass
+
     ctypedef struct SCIP:
         pass
 
@@ -381,12 +395,18 @@ cdef extern from "scip/scip.h":
 
     ctypedef struct SCIP_ROW:
         pass
+    
+    ctypedef struct SCIP_ROWEXACT:
+        pass
 
     ctypedef struct SCIP_NLROW:
         pass
 
     ctypedef struct SCIP_COL:
         pass
+    
+    ctypedef struct SCIP_COLEXACT:
+        pass
 
     ctypedef struct SCIP_SOL:
         pass
@@ -430,6 +450,15 @@ cdef extern from "scip/scip.h":
     ctypedef struct SCIP_HEURDATA:
         pass
 
+    ctypedef struct SCIP_IISFINDER:
+        pass
+    
+    ctypedef struct SCIP_IISFINDERDATA:
+        pass
+    
+    ctypedef struct SCIP_IIS:
+        pass
+
     ctypedef struct SCIP_RELAX:
         pass
 
@@ -508,6 +537,9 @@ cdef extern from "scip/scip.h":
     ctypedef struct SCIP_LPI:
         pass
 
+    ctypedef struct SCIP_LPEXACT:
+        pass
+
     ctypedef struct BMS_BLKMEM:
         pass
 
@@ -538,6 +570,9 @@ cdef extern from "scip/scip.h":
     ctypedef union SCIP_DOMCHG:
         pass
 
+    ctypedef struct SCIP_RATIONAL:
+        pass
+
     ctypedef void (*messagecallback) (SCIP_MESSAGEHDLR* messagehdlr, FILE* file, const char* msg) noexcept
     ctypedef void (*errormessagecallback) (void* data, FILE* file, const char* msg)
     ctypedef SCIP_RETCODE (*messagehdlrfree) (SCIP_MESSAGEHDLR* messagehdlr)
@@ -702,6 +737,7 @@ cdef extern from "scip/scip.h":
     SCIP_Real SCIPepsilon(SCIP* scip)
     SCIP_Real SCIPfeastol(SCIP* scip)
     SCIP_RETCODE SCIPsetObjIntegral(SCIP* scip)
+    SCIP_Bool SCIPisObjIntegral(SCIP* scip)
     SCIP_Real SCIPgetLocalOrigEstimate(SCIP* scip)
     SCIP_Real SCIPgetLocalTransEstimate(SCIP* scip)
 
@@ -802,6 +838,11 @@ cdef extern from "scip/scip.h":
     int SCIPgetNImplVars(SCIP* scip)
     int SCIPgetNContVars(SCIP* scip)
     SCIP_VARTYPE SCIPvarGetType(SCIP_VAR* var)
+    SCIP_Bool SCIPvarIsBinary(SCIP_VAR* var)
+    SCIP_Bool SCIPvarIsIntegral(SCIP_VAR* var)
+    SCIP_Bool SCIPvarIsImpliedIntegral(SCIP_VAR* var)
+    SCIP_Bool SCIPvarIsNonimpliedIntegral(SCIP_VAR* var)
+    SCIP_IMPLINTTYPE SCIPvarGetImplType(SCIP_VAR* var)
     SCIP_VARSTATUS SCIPvarGetStatus(SCIP_VAR* var)
     SCIP_Bool SCIPvarIsOriginal(SCIP_VAR* var)
     SCIP_Bool SCIPvarIsTransformed(SCIP_VAR* var)
@@ -830,6 +871,18 @@ cdef extern from "scip/scip.h":
     SCIP_Longint SCIPvarGetNBranchingsCurrentRun(SCIP_VAR* var, SCIP_BRANCHDIR dir)
     SCIP_Bool SCIPvarMayRoundUp(SCIP_VAR* var)
     SCIP_Bool SCIPvarMayRoundDown(SCIP_VAR* var)
+    SCIP_Bool SCIPvarIsActive(SCIP_VAR* var)
+    SCIP_Real SCIPadjustedVarLb(SCIP* scip, SCIP_VAR* var, SCIP_Real lb)
+    SCIP_Real SCIPadjustedVarUb(SCIP* scip, SCIP_VAR* var, SCIP_Real ub)
+    SCIP_RETCODE SCIPaggregateVars(SCIP* scip,
+                                   SCIP_VAR* varx,
+                                   SCIP_VAR* vary,
+                                   SCIP_Real scalarx,
+                                   SCIP_Real scalary,
+                                   SCIP_Real rhs,
+                                   SCIP_Bool* infeasible,
+                                   SCIP_Bool* redundant,
+                                   SCIP_Bool* aggregated)
 
     # LP Methods
     SCIP_RETCODE SCIPgetLPColsData(SCIP* scip, SCIP_COL*** cols, int* ncols)
@@ -970,11 +1023,12 @@ cdef extern from "scip/scip.h":
                                    SCIP_RETCODE (*readercopy) (SCIP* scip, SCIP_READER* reader),
                                    SCIP_RETCODE (*readerfree) (SCIP* scip, SCIP_READER* reader),
                                    SCIP_RETCODE (*readerread) (SCIP* scip, SCIP_READER* reader, const char* filename, SCIP_RESULT* result),
-                                   SCIP_RETCODE (*readerwrite) (SCIP* scip, SCIP_READER* reader, FILE* file,
+                                   SCIP_RETCODE (*readerwrite) (SCIP* scip, SCIP_READER* reader, FILE* file, const char* filename,
                                                                 const char* name, SCIP_PROBDATA* probdata, SCIP_Bool transformed,
-                                                                SCIP_OBJSENSE objsense, SCIP_Real objscale, SCIP_Real objoffset,
-                                                                SCIP_VAR** vars, int nvars, int nbinvars, int nintvars, int nimplvars, int ncontvars,
-                                                                SCIP_VAR** fixedvars, int nfixedvars, int startnvars,
+                                                                SCIP_OBJSENSE objsense, SCIP_Real objoffset, SCIP_Real objscale,
+                                                                SCIP_RATIONAL* objoffsetexact, SCIP_RATIONAL* objscaleexact,
+                                                                SCIP_VAR** vars, int nvars, int nbinvars, int nintvars, int nimplvars,
+                                                                int ncontvars, SCIP_VAR** fixedvars, int nfixedvars, int startnvars,
                                                                 SCIP_CONS** conss, int nconss, int maxnconss, int startnconss,
                                                                 SCIP_Bool genericnames, SCIP_RESULT* result),
                                    SCIP_READERDATA* readerdata)
@@ -1167,6 +1221,31 @@ cdef extern from "scip/scip.h":
     SCIP_HEURTIMING SCIPheurGetTimingmask(SCIP_HEUR* heur)
     void SCIPheurSetTimingmask(SCIP_HEUR* heur, SCIP_HEURTIMING timingmask)
 
+    #IIS finder plugin
+    SCIP_RETCODE SCIPincludeIISfinder(SCIP* scip,
+                                      const char* name,
+                                      const char* desc,
+                                      int         priority,
+                                      SCIP_RETCODE (*iisfindercopy) (SCIP* scip, SCIP_IISFINDER* iisfinder),
+                                      SCIP_RETCODE (*iisfinderfree) (SCIP* scip, SCIP_IISFINDER* iisfinder),
+                                      SCIP_RETCODE (*iisfinderexec) (SCIP_IIS* iis, SCIP_IISFINDER* iisfinder, SCIP_RESULT* result),
+                                      SCIP_IISFINDERDATA*   iisfinderdata)
+
+    SCIP_IISFINDERDATA* SCIPiisfinderGetData(SCIP_IISFINDER* iisfinder)
+    SCIP_RETCODE SCIPgenerateIIS(SCIP* scip)
+    SCIP_RETCODE SCIPiisGreedyMakeIrreducible(SCIP_IIS* iis)
+    SCIP_Bool SCIPiisIsSubscipInfeasible(SCIP_IIS* iis)
+    SCIP_Bool SCIPiisIsSubscipIrreducible(SCIP_IIS* iis)
+    SCIP_RETCODE SCIPiisSetSubscipIrreducible(SCIP_IIS* iis, SCIP_Bool irreducible)
+    SCIP_RETCODE SCIPiisSetSubscipInfeasible(SCIP_IIS* iis, SCIP_Bool infeasible)
+    SCIP_IIS* SCIPgetIIS(SCIP* scip)
+    SCIP_IISFINDER* SCIPfindIISfinder(SCIP* scip, const char* name)
+    SCIP_Real SCIPiisGetTime(SCIP_IIS* scip)
+    SCIP_Bool SCIPiisIsSubscipIrreducible(SCIP_IIS* scip)
+    SCIP_Bool SCIPiisIsSubscipInfeasible(SCIP_IIS* scip)
+    SCIP_Longint SCIPiisGetNNodes(SCIP_IIS* scip)
+    SCIP* SCIPiisGetSubscip(SCIP_IIS* iis)
+
     #Relaxation plugin
     SCIP_RETCODE SCIPincludeRelax(SCIP* scip,
 		                         const char* name,
@@ -1366,8 +1445,33 @@ cdef extern from "scip/scip.h":
     SCIP_Bool SCIPisIntegral(SCIP* scip, SCIP_Real val)
     SCIP_Real SCIPgetTreesizeEstimation(SCIP* scip)
 
+    # Exact SCIP methods
+    SCIP_RETCODE SCIPenableExactSolving(SCIP* scip, SCIP_Bool enable);
+    SCIP_Bool SCIPisExact(SCIP* scip);
+    SCIP_Bool SCIPallowNegSlack(SCIP* scip);
+    SCIP_RETCODE SCIPbranchLPExact(SCIP* scip, SCIP_RESULT* result);
+    SCIP_RETCODE SCIPaddRowExact(SCIP* scip, SCIP_ROWEXACT* rowexact);
+
+    # Exact LP SCIP methods
+    SCIP_VAR* SCIPcolExactGetVar(SCIP_COLEXACT* col);
+    SCIP_RATIONAL* SCIProwExactGetLhs(SCIP_ROWEXACT* row);
+    SCIP_RATIONAL* SCIProwExactGetRhs(SCIP_ROWEXACT* row);
+    SCIP_RATIONAL* SCIProwExactGetConstant(SCIP_ROWEXACT* row);
+    int SCIProwExactGetNNonz(SCIP_ROWEXACT* row);
+    SCIP_RATIONAL** SCIProwExactGetVals(SCIP_ROWEXACT* row);
+    SCIP_Bool SCIProwExactIsInLP(SCIP_ROWEXACT* row);
+    void SCIProwExactSort(SCIP_ROWEXACT* row);
+    SCIP_COLEXACT** SCIProwExactGetCols(SCIP_ROWEXACT* row);
+    void SCIProwExactLock(SCIP_ROWEXACT* row);
+    void SCIProwExactUnlock(SCIP_ROWEXACT* row);
+    SCIP_ROW* SCIProwExactGetRow(SCIP_ROWEXACT* row);
+    SCIP_ROW* SCIProwExactGetRowRhs(SCIP_ROWEXACT* row);
+    SCIP_Bool SCIProwExactHasFpRelax(SCIP_ROWEXACT* row);
+    SCIP_Bool SCIPlpExactDiving(SCIP_LPEXACT* lpexact);
+
     # Statistic Methods
     SCIP_RETCODE SCIPprintStatistics(SCIP* scip, FILE* outfile)
+    SCIP_RETCODE SCIPprintStatisticsJson(SCIP* scip, FILE* file)
     SCIP_Longint SCIPgetNNodes(SCIP* scip)
     SCIP_Longint SCIPgetNTotalNodes(SCIP* scip)
     SCIP_Longint SCIPgetNFeasibleLeaves(SCIP* scip)
@@ -1381,6 +1485,7 @@ cdef extern from "scip/scip.h":
     int SCIPgetPlungeDepth(SCIP* scip)
     SCIP_Longint SCIPgetNNodeLPIterations(SCIP* scip)
     SCIP_Longint SCIPgetNStrongbranchLPIterations(SCIP* scip)
+    SCIP_Real SCIPgetPrimalDualIntegral(SCIP* scip)
 
     # Parameter Functions
     SCIP_RETCODE SCIPsetBoolParam(SCIP* scip, char* name, SCIP_Bool value)
@@ -1446,11 +1551,6 @@ cdef extern from "scip/scip.h":
 
     BMS_BLKMEM* SCIPblkmem(SCIP* scip)
 
-    # pub_misc.h
-    SCIP_RETCODE SCIPhashmapCreate(SCIP_HASHMAP** hashmap, BMS_BLKMEM* blkmem, int mapsize)
-    void SCIPhashmapFree(SCIP_HASHMAP** hashmap)
-
-
 cdef extern from "scip/tree.h":
     int SCIPnodeGetNAddedConss(SCIP_NODE* node)
 
@@ -1610,7 +1710,6 @@ cdef extern from "scip/cons_sos1.h":
                                    SCIP_CONS* cons,
                                    SCIP_VAR* var)
 
-
 cdef extern from "scip/cons_sos2.h":
     SCIP_RETCODE SCIPcreateConsSOS2(SCIP* scip,
                                     SCIP_CONS** cons,
@@ -1677,8 +1776,6 @@ cdef extern from "scip/cons_and.h":
     SCIP_VAR*    SCIPgetResultantAnd(SCIP* scip, SCIP_CONS* cons)
     SCIP_Bool    SCIPisAndConsSorted(SCIP* scip, SCIP_CONS* cons)
     SCIP_RETCODE SCIPsortAndCons(SCIP* scip, SCIP_CONS* cons)
-    SCIP_RETCODE SCIPchgAndConsCheckFlagWhenUpgr(SCIP* scip, SCIP_CONS* cons, SCIP_Bool flag)
-    SCIP_RETCODE SCIPchgAndConsRemovableFlagWhenUpgr(SCIP* scip, SCIP_CONS* cons, SCIP_Bool flag)
 
 cdef extern from "scip/cons_or.h":
     SCIP_RETCODE SCIPcreateConsOr(SCIP* scip,
@@ -1715,6 +1812,7 @@ cdef extern from "scip/cons_xor.h":
                                          SCIP_Bool dynamic,
                                          SCIP_Bool removable,
                                          SCIP_Bool stickingatnode)
+
 cdef extern from "scip/scip_cons.h":
     SCIP_RETCODE SCIPprintCons(SCIP* scip,
                                SCIP_CONS* cons,
@@ -1869,7 +1967,6 @@ cdef extern from "scip/scip_nlp.h":
     SCIP_RETCODE SCIPgetNlRowActivityBounds(SCIP* scip, SCIP_NLROW* nlrow, SCIP_Real* minactivity, SCIP_Real* maxactivity)
     SCIP_RETCODE SCIPprintNlRow(SCIP* scip, SCIP_NLROW* nlrow, FILE* file)
 
-
 cdef extern from "scip/cons_cardinality.h":
     SCIP_RETCODE SCIPcreateConsCardinality(SCIP* scip,
                                             SCIP_CONS** cons,
@@ -2027,6 +2124,8 @@ cdef extern from "tpi/tpi.h":
 cdef class Expr:
     cdef public terms
 
+    cpdef double _evaluate(self, Solution sol)
+
 cdef class Event:
     cdef SCIP_EVENT* event
     # can be used to store problem data
@@ -2042,6 +2141,14 @@ cdef class Column:
     @staticmethod
     cdef create(SCIP_COL* scipcol)
 
+cdef class ColumnExact:
+    cdef SCIP_COLEXACT* scip_col_exact
+    # can be used to store problem data
+    cdef public object data
+
+    @staticmethod
+    cdef create(SCIP_COLEXACT* scip_col_exact)
+
 cdef class Row:
     cdef SCIP_ROW* scip_row
     # can be used to store problem data
@@ -2050,6 +2157,14 @@ cdef class Row:
     @staticmethod
     cdef create(SCIP_ROW* sciprow)
 
+cdef class RowExact:
+    cdef SCIP_ROWEXACT* scip_row_exact
+    # can be used to store problem data
+    cdef public object data
+
+    @staticmethod
+    cdef create(SCIP_ROWEXACT* scip_row_exact)
+
 cdef class NLRow:
     cdef SCIP_NLROW* scip_nlrow
     # can be used to store problem data
@@ -2103,6 +2218,12 @@ cdef class Constraint:
     @staticmethod
     cdef create(SCIP_CONS* scipcons)
 
+cdef class IIS:
+    cdef SCIP_IIS* _iis
+
+    @staticmethod
+    cdef create(SCIP_IIS* iis)
+
 cdef class Model:
     cdef SCIP* _scip
     cdef SCIP_Bool* _valid
@@ -2117,10 +2238,17 @@ cdef class Model:
     cdef SCIP_Bool _freescip
     # map to store python variables
     cdef _modelvars
+    # map to store python constraints
+    cdef _modelconss
     # used to keep track of the number of event handlers generated
     cdef int _generated_event_handlers_count
     # store references to Benders subproblem Models for proper cleanup
     cdef _benders_subproblems
+    # store iis, if found
+    cdef SCIP_IIS* _iis
+    # helper methods for later var and cons cleanup
+    cdef _getOrCreateCons(self, SCIP_CONS* scip_cons)
+    cdef _getOrCreateVar(self, SCIP_VAR* scip_var)
 
     @staticmethod
     cdef create(SCIP* scip)