Merge branch 'latest' of https://github.com/ERGO-Code/HiGHS into latest

Author: jajhall

docs/make.jl

@@ -88,6 +88,7 @@ Documenter.makedocs(
             "Python" => Any[
                 "interfaces/python/index.md",
                 "interfaces/python/example-py.md",
+                "interfaces/python/model-py.md",
             ],
             "CSharp" => "interfaces/csharp.md",
             "Julia" => "interfaces/julia/index.md",

docs/src/interfaces/python/index.md

@@ -18,13 +18,6 @@ To use `highspy` within a Python program, it must be imported
 import highspy
 ```
 
-When using `highspy`, it is likely that `numpy` structures will be needed,
-so must also be imported
-
-```python
-import numpy as np
-```
-
 ## Initialize
 
 HiGHS must be initialized before making calls to the HiGHS Python library:

docs/src/interfaces/python/model-py.md

@@ -0,0 +1,90 @@
+# [Modelling](@id model-py)
+
+HiGHS has a rudimentry modelling language that allows models to be built and run using `highspy`. 
+
+Below is an example of building a mathematical LP. The functions used are documented in detail below
+```
+# model and solve the LP
+#
+# maximize 10 x1 + 25x2
+# s. t.       x1 +  2x2 <=  80
+#             x1 +  4x2 <= 120
+#             x1 >= 0; x2 >= 0
+import highspy
+
+h = highspy.Highs()
+
+x1 = h.addVar()
+x2 = h.addVar()
+
+h.addConstr(x1 + 2*x2 <=  80)
+h.addConstr(x1 + 4*x2 <= 120)
+
+h.maximize(10*x1 + 25*x2)
+
+print("x1 = ", h.val(x1))
+print("x2 = ", h.val(x2))
+```
+
+## addVar
+
+Adds a variable to the model. By default it is continuous,
+non-negative, with zero objective coefficient, and has no name
+associated with it.
+
+```
+addVar(lb = 0, ub = kHighsInf, obj = 0, type=HighsVarType.kContinuous, name = None)
+```
+
+## addConstr
+
+Adds a constraint to the model. It must be defined in terms of a
+linear function, with `*` used when there are non-unit
+coefficients. By default it has a lower bound of -infinity, an upper
+bound of +infinity, and no name associated with it.
+
+```
+addConstr(cons, name = None)
+```
+
+## maximize
+
+Calls HiGHS to maximize the objective. By default it uses the
+objective coefficients defined when the variables were added to the
+model. However, a linear function can be passed as an argument.
+
+```
+maximize(obj=None)
+```
+
+## minimize
+
+Calls HiGHS to minimize the objective. By default it uses the
+objective coefficients defined when the variables were added to the
+model. However, a linear function can be passed as an argument.
+
+```
+minimize(obj=None)
+```
+
+## val
+
+Extracts the current value of a particular variable
+
+```
+val(var)
+```
+
+## vals
+
+Extracts the current values of a particular set of variables
+
+```
+vals(vars)
+```
+
+## MIP Example
+
+
+
+

examples/chip0.py

@@ -0,0 +1,29 @@
+# model and solve the LP
+#
+# maximize 10 x1 + 25x2
+# s. t.       x1 +  2x2 <= 80
+#             x1 +  4x2 <= 120
+#             x1 >= 0; x2 >= 0
+import highspy
+
+h = highspy.Highs()
+
+x1 = h.addVar(obj = 10)
+x2 = h.addVar(obj = 25)
+
+h.addConstr(x1 + 2*x2 <= 80)
+h.addConstr(x1 + 4*x2 <= 120)
+
+h.writeModel("")
+print("x1 = ", h.val(x1))
+print("x2 = ", h.val(x2))
+
+h.maximize()
+
+print("x1 = ", h.val(x1))
+print("x2 = ", h.val(x2))
+
+print("x = ", h.vals([x1, x2]))
+
+
+

extern/amd/SuiteSparse_config.c

@@ -13,7 +13,7 @@
 
 #include "SuiteSparse_config.h"
 
-void *SuiteSparse_malloc    /* pointer to allocated block of memory */
+void *Highs_SuiteSparse_malloc    /* pointer to allocated block of memory */
 (
     size_t nitems,          /* number of items to malloc */
     size_t size_of_item     /* sizeof each item */
@@ -41,7 +41,7 @@ void *SuiteSparse_malloc    /* pointer to allocated block of memory */
 /* SuiteSparse_free: free wrapper */
 /* -------------------------------------------------------------------------- */
 
-void *SuiteSparse_free      /* always returns NULL */
+void *Highs_SuiteSparse_free      /* always returns NULL */
 (
     void *p                 /* block to free */
 )

extern/amd/SuiteSparse_config.h

@@ -36,25 +36,17 @@
 #include <stdarg.h>
 #include <ctype.h>
 
-void *SuiteSparse_malloc    // pointer to allocated block of memory
+void *Highs_SuiteSparse_malloc    // pointer to allocated block of memory
 (
     size_t nitems,          // number of items to malloc (>=1 is enforced)
     size_t size_of_item     // sizeof each item
 ) ;
 
-void *SuiteSparse_free      // always returns NULL
+void *Highs_SuiteSparse_free      // always returns NULL
 (
     void *p                 // block to free
 ) ;
 
-// SuiteSparse printf macro
-#define SUITESPARSE_PRINTF(params)                          \
-{                                                           \
-                                                            \
-         printf params ;                                    \
-                                                            \
-}
-
 #define SUITESPARSE_DATE "Nov 4, 2025"
 #define SUITESPARSE_MAIN_VERSION    7
 #define SUITESPARSE_SUB_VERSION     12

extern/amd/amd.h

@@ -53,7 +53,7 @@ typedef unsigned int amd_uint;
 extern "C" {
 #endif
 
-int amd_order  /* returns AMD_OK, AMD_OK_BUT_JUMBLED,
+int Highs_amd_order  /* returns AMD_OK, AMD_OK_BUT_JUMBLED,
                                     * AMD_INVALID, or AMD_OUT_OF_MEMORY */
 (
     amd_int n,                         /* A is n-by-n.  n must be >= 0. */
@@ -232,7 +232,7 @@ int amd_order  /* returns AMD_OK, AMD_OK_BUT_JUMBLED,
  * of the matrix for AMD to destroy).  Refer to AMD/Source/amd_2.c for a
  * description of each parameter. */
 
-void amd_2
+void Highs_amd_2
 (
     amd_int n,
     amd_int Pe [ ],
@@ -263,7 +263,7 @@ void amd_2
  * of columns of the matrix.  For its use in AMD, these must both equal n.
  */
 
-int amd_valid
+int Highs_amd_valid
 (
     amd_int n_row,                 /* # of rows */
     amd_int n_col,                 /* # of columns */
@@ -276,13 +276,13 @@ int amd_valid
 /* ------------------------------------------------------------------------- */
 
 /* amd_defaults:  sets the default control settings */
-void amd_defaults   (double Control [ ]) ;
+void Highs_amd_defaults   (double Control [ ]) ;
 
 /* amd_control: prints the control settings */
-void amd_control    (double Control [ ]) ;
+void Highs_amd_control    (double Control [ ]) ;
 
 /* amd_info: prints the statistics */
-void amd_info       (double Info [ ]) ;
+void Highs_amd_info       (double Info [ ]) ;
 
 #ifdef __cplusplus
 }

extern/amd/amd_1.c

@@ -167,6 +167,6 @@ void amd_1
     /* order the matrix */
     /* --------------------------------------------------------------------- */
 
-    amd_2 (n, Pe, Iw, Len, iwlen, pfree,
+    Highs_amd_2 (n, Pe, Iw, Len, iwlen, pfree,
 	Nv, Pinv, P, Head, Elen, Degree, W, Control, Info) ;
 }

extern/amd/amd_2.c

@@ -39,7 +39,7 @@ static amd_int clear_flag (amd_int wflg, amd_int wbig, amd_int W [ ], amd_int n)
 /* === AMD_2 =============================================================== */
 /* ========================================================================= */
 
-void amd_2
+void Highs_amd_2
 (
     amd_int n,		/* A is n-by-n, where n > 0 */
     amd_int Pe [ ],		/* Pe [0..n-1]: index in Iw of row i on input */

extern/amd/amd_control.c

@@ -15,7 +15,7 @@
 
 #include "amd_internal.h"
 
-void amd_control
+void Highs_amd_control
 (
     double Control [ ]
 )
@@ -34,31 +34,31 @@ void amd_control
 	aggressive = AMD_DEFAULT_AGGRESSIVE ;
     }
 
-    SUITESPARSE_PRINTF ((
+    printf (
         "\nAMD version %d.%d.%d, %s: approximate minimum degree ordering\n"
 	"    dense row parameter: %g\n", AMD_MAIN_VERSION, AMD_SUB_VERSION,
-	AMD_SUBSUB_VERSION, AMD_DATE, alpha)) ;
+	AMD_SUBSUB_VERSION, AMD_DATE, alpha) ;
 
     if (alpha < 0)
     {
-	SUITESPARSE_PRINTF (("    no rows treated as dense\n")) ;
+	printf ("    no rows treated as dense\n") ;
     }
     else
     {
-	SUITESPARSE_PRINTF ((
+	printf (
 	"    (rows with more than max (%g * sqrt (n), 16) entries are\n"
 	"    considered \"dense\", and placed last in output permutation)\n",
-	alpha)) ;
+	alpha) ;
     }
 
     if (aggressive)
     {
-	SUITESPARSE_PRINTF (("    aggressive absorption:  yes\n")) ;
+	printf ("    aggressive absorption:  yes\n") ;
     }
     else
     {
-	SUITESPARSE_PRINTF (("    aggressive absorption:  no\n")) ;
+	printf ("    aggressive absorption:  no\n") ;
     }
 
-    SUITESPARSE_PRINTF (("    size of AMD integer: %lu\n\n", sizeof (amd_int))) ;
+    printf ("    size of AMD integer: %lu\n\n", sizeof (amd_int)) ;
 }