localmip 2.0.1__tar.gz

localmip-2.0.1/CMakeLists.txt

@@ -0,0 +1,64 @@
+cmake_minimum_required(VERSION 3.15...3.27)
+
+# Set minimum policy version to allow older pybind11 CMake files
+cmake_policy(VERSION 3.5)
+
+project(localmip_py LANGUAGES CXX)
+
+# Suppress deprecation warnings from pybind11's legacy Python finding modules
+if(POLICY CMP0148)
+  cmake_policy(SET CMP0148 OLD)
+endif()
+
+# Find pybind11 (expects it installed or discoverable via CMAKE_PREFIX_PATH)
+find_package(Threads REQUIRED)
+find_package(pybind11 REQUIRED)
+
+# Disable IPO/LTO to avoid toolchain-induced zero-sized outputs
+set(CMAKE_INTERPROCEDURAL_OPTIMIZATION OFF)
+set(PYBIND11_LTO_CXX_FLAGS "" CACHE STRING "" FORCE)
+set(PYBIND11_LTO_C_FLAGS "" CACHE STRING "" FORCE)
+
+# Prefer bundled core sources in source distributions; fall back to the repo root in development checkouts.
+set(LOCALMIP_ROOT "${CMAKE_CURRENT_LIST_DIR}/..")
+if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/localmip_core/src")
+  set(LOCALMIP_ROOT "${CMAKE_CURRENT_LIST_DIR}/localmip_core")
+endif()
+set(LOCALMIP_INCLUDE_DIR "${LOCALMIP_ROOT}/src")
+file(GLOB_RECURSE LOCALMIP_SOURCES CONFIGURE_DEPENDS
+  "${LOCALMIP_ROOT}/src/*.cpp"
+  "${LOCALMIP_ROOT}/src/*.cc"
+)
+list(REMOVE_ITEM LOCALMIP_SOURCES "${LOCALMIP_ROOT}/src/utils/main.cpp")
+
+add_library(LocalMIP STATIC ${LOCALMIP_SOURCES})
+target_include_directories(LocalMIP PUBLIC
+  ${LOCALMIP_INCLUDE_DIR}
+  ${LOCALMIP_ROOT}/src/local_mip
+)
+target_compile_features(LocalMIP PUBLIC cxx_std_20)
+target_compile_definitions(LocalMIP PUBLIC $<$<CONFIG:Debug>:DEBUG>)
+target_compile_options(LocalMIP PUBLIC
+  -fPIC
+  $<$<CONFIG:Debug>:-g>
+  $<$<CONFIG:Release>:-O3>
+)
+target_link_libraries(LocalMIP PUBLIC Threads::Threads)
+
+pybind11_add_module(localmip_py MODULE local_mip_py.cpp)
+target_include_directories(localmip_py PRIVATE ${LOCALMIP_INCLUDE_DIR})
+target_link_libraries(localmip_py PRIVATE LocalMIP)
+target_compile_features(localmip_py PRIVATE cxx_std_20)
+set_target_properties(localmip_py PROPERTIES INTERPROCEDURAL_OPTIMIZATION OFF)
+
+# Use parallel LTO to suppress warnings when linking against LTO-compiled static library
+if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+  target_link_options(localmip_py PRIVATE -flto=auto)
+endif()
+
+# Produce a plain .so (no python prefix/suffix mangling already handled by pybind11_add_module)
+set_target_properties(localmip_py PROPERTIES
+  OUTPUT_NAME "localmip_py"
+)
+
+install(TARGETS localmip_py LIBRARY DESTINATION .)

localmip-2.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Local-MIP
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

localmip-2.0.1/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include VERSION
+include CMakeLists.txt
+include local_mip_py.cpp
+include smoke_test.py
+include LICENSE

localmip-2.0.1/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: localmip
+Version: 2.0.1
+Summary: Python bindings for the Local-MIP solver
+Author: Local-MIP authors
+License: MIT License
+        
+        Copyright (c) 2025 Local-MIP
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/shaowei-cai-group/Local-MIP
+Project-URL: Repository, https://github.com/shaowei-cai-group/Local-MIP
+Project-URL: Issues, https://github.com/shaowei-cai-group/Local-MIP/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Python Bindings (pybind11)
+
+This folder provides a pybind11 module that exposes `Local_MIP` to Python without touching the main solver code.
+
+The bindings expose the core solver configuration and result-query API used in normal runs, including `.set` parameter-file loading, plus the in-memory modeling interface.
+
+## Install from PyPI
+For Linux x86_64:
+```bash
+python3 -m pip install localmip
+```
+
+Import it directly:
+```python
+import localmip_py as lm
+```
+
+## Install from the repository
+From repo root:
+```bash
+python3 -m pip install ./python-bindings
+```
+
+This builds both the Local-MIP core and the pybind11 extension during installation.
+After installation, the module can be imported directly:
+```bash
+python3 -c "import localmip_py as lm; print(lm.LocalMIP)"
+```
+
+## Run the demos
+From repo root:
+```bash
+python3 python-bindings/sample.py
+python3 python-bindings/model_api_demo.py
+python3 python-bindings/test_python_api.py
+python3 python-bindings/smoke_test.py
+```
+
+## Development build without pip
+The legacy local build flow is still supported. From repo root:
+```bash
+PY_EXE="$(python3 -c 'import sys; print(sys.executable)')"
+PYTHON_EXECUTABLE="${PY_EXE}" python-bindings/build.sh
+```
+
+Output: `python-bindings/build/localmip_py.cpython-*.so` (exact suffix depends on Python version).
+
+Use the same interpreter for build and run so the compiled module suffix matches the interpreter that imports it:
+```bash
+PY_EXE="$(python3 -c 'import sys; print(sys.executable)')"
+PYTHON_EXECUTABLE="${PY_EXE}" python-bindings/build.sh
+"${PY_EXE}" python-bindings/sample.py
+"${PY_EXE}" python-bindings/model_api_demo.py
+"${PY_EXE}" python-bindings/test_python_api.py
+"${PY_EXE}" python-bindings/smoke_test.py
+```
+
+## Use in Python
+If installed with pip:
+```python
+import localmip_py as lm
+```
+
+If using the local development build, either append the build directory to `PYTHONPATH` or copy the `.so` next to your script:
+```python
+import sys
+sys.path.append("python-bindings/build")  # if not installed
+import localmip_py as lm
+
+solver = lm.LocalMIP()
+solver.set_model_file("test-set/sct1.mps")
+solver.set_sol_path("py_example.sol")
+solver.set_time_limit(10.0)
+solver.set_log_obj(True)
+
+# Optional: register a start callback
+stats = {"calls": 0}
+
+def start_cbk(ctx, user_data):
+    user_data["calls"] += 1
+    if ctx.shared.binary_idx_list:
+        idx = ctx.shared.binary_idx_list[0]
+        ctx.current_values[idx] = 1.0
+
+solver.set_start_cbk(start_cbk, stats)
+solver.run()
+
+print("Feasible:", solver.is_feasible(), "Obj:", solver.get_obj_value())
+print("Start callback calls:", stats["calls"])
+```
+
+## Model API (Programmatic Modeling)
+The bindings also expose Local-MIP's **Model API**, which lets you build a model
+directly in Python (mirrors `example/model-api/model_api_demo.cpp`).
+
+Run the demo:
+```bash
+PY_EXE="$(python3 -c 'import sys; print(sys.executable)')"
+"${PY_EXE}" python-bindings/model_api_demo.py
+```
+
+Smoke test:
+```bash
+PY_EXE="$(python3 -c 'import sys; print(sys.executable)')"
+"${PY_EXE}" python-bindings/test_python_api.py
+```
+
+Key symbols:
+- `lm.Sense.{minimize,maximize}`
+- `lm.VarType.{binary,general_integer,real,fixed}`
+- `LocalMIP.set_param_set_file(...)`
+- `LocalMIP.set_bms_unsat_con(...)`, `set_bms_mtm_unsat_op(...)`, `set_bms_sat_con(...)`, `set_bms_mtm_sat_op(...)`, `set_bms_flip_op(...)`, `set_bms_easy_op(...)`, `set_bms_random_op(...)`
+- `LocalMIP.enable_model_api()`
+- `LocalMIP.add_var(...)`, `LocalMIP.add_con(...)`
+- `LocalMIP.get_solution()`
+
+## Notes
+- `pip install ./python-bindings` compiles the Local-MIP core and the extension together inside the wheel build.
+- The local helper script `python-bindings/build.sh` still works for iterative development builds.
+- Long-running `run()` releases the GIL; Python callbacks reacquire the GIL before execution.
+- Callback contexts (`Start::Start_Ctx`, etc.) are exposed as structured Python objects with read-only shared sequence views and writable fields where the solver expects mutation.
+- `NeighborCtx.op_size` is derived from `clear_ops()`, `set_single_op(...)`, and `append_op(...)`; update move outputs through those helpers instead of writing the size directly.
+- Python callbacks can optionally receive a Python `user_data` object; if omitted, the old shorter callback signatures still work.

localmip-2.0.1/README.md

@@ -0,0 +1,123 @@
+# Python Bindings (pybind11)
+
+This folder provides a pybind11 module that exposes `Local_MIP` to Python without touching the main solver code.
+
+The bindings expose the core solver configuration and result-query API used in normal runs, including `.set` parameter-file loading, plus the in-memory modeling interface.
+
+## Install from PyPI
+For Linux x86_64:
+```bash
+python3 -m pip install localmip
+```
+
+Import it directly:
+```python
+import localmip_py as lm
+```
+
+## Install from the repository
+From repo root:
+```bash
+python3 -m pip install ./python-bindings
+```
+
+This builds both the Local-MIP core and the pybind11 extension during installation.
+After installation, the module can be imported directly:
+```bash
+python3 -c "import localmip_py as lm; print(lm.LocalMIP)"
+```
+
+## Run the demos
+From repo root:
+```bash
+python3 python-bindings/sample.py
+python3 python-bindings/model_api_demo.py
+python3 python-bindings/test_python_api.py
+python3 python-bindings/smoke_test.py
+```
+
+## Development build without pip
+The legacy local build flow is still supported. From repo root:
+```bash
+PY_EXE="$(python3 -c 'import sys; print(sys.executable)')"
+PYTHON_EXECUTABLE="${PY_EXE}" python-bindings/build.sh
+```
+
+Output: `python-bindings/build/localmip_py.cpython-*.so` (exact suffix depends on Python version).
+
+Use the same interpreter for build and run so the compiled module suffix matches the interpreter that imports it:
+```bash
+PY_EXE="$(python3 -c 'import sys; print(sys.executable)')"
+PYTHON_EXECUTABLE="${PY_EXE}" python-bindings/build.sh
+"${PY_EXE}" python-bindings/sample.py
+"${PY_EXE}" python-bindings/model_api_demo.py
+"${PY_EXE}" python-bindings/test_python_api.py
+"${PY_EXE}" python-bindings/smoke_test.py
+```
+
+## Use in Python
+If installed with pip:
+```python
+import localmip_py as lm
+```
+
+If using the local development build, either append the build directory to `PYTHONPATH` or copy the `.so` next to your script:
+```python
+import sys
+sys.path.append("python-bindings/build")  # if not installed
+import localmip_py as lm
+
+solver = lm.LocalMIP()
+solver.set_model_file("test-set/sct1.mps")
+solver.set_sol_path("py_example.sol")
+solver.set_time_limit(10.0)
+solver.set_log_obj(True)
+
+# Optional: register a start callback
+stats = {"calls": 0}
+
+def start_cbk(ctx, user_data):
+    user_data["calls"] += 1
+    if ctx.shared.binary_idx_list:
+        idx = ctx.shared.binary_idx_list[0]
+        ctx.current_values[idx] = 1.0
+
+solver.set_start_cbk(start_cbk, stats)
+solver.run()
+
+print("Feasible:", solver.is_feasible(), "Obj:", solver.get_obj_value())
+print("Start callback calls:", stats["calls"])
+```
+
+## Model API (Programmatic Modeling)
+The bindings also expose Local-MIP's **Model API**, which lets you build a model
+directly in Python (mirrors `example/model-api/model_api_demo.cpp`).
+
+Run the demo:
+```bash
+PY_EXE="$(python3 -c 'import sys; print(sys.executable)')"
+"${PY_EXE}" python-bindings/model_api_demo.py
+```
+
+Smoke test:
+```bash
+PY_EXE="$(python3 -c 'import sys; print(sys.executable)')"
+"${PY_EXE}" python-bindings/test_python_api.py
+```
+
+Key symbols:
+- `lm.Sense.{minimize,maximize}`
+- `lm.VarType.{binary,general_integer,real,fixed}`
+- `LocalMIP.set_param_set_file(...)`
+- `LocalMIP.set_bms_unsat_con(...)`, `set_bms_mtm_unsat_op(...)`, `set_bms_sat_con(...)`, `set_bms_mtm_sat_op(...)`, `set_bms_flip_op(...)`, `set_bms_easy_op(...)`, `set_bms_random_op(...)`
+- `LocalMIP.enable_model_api()`
+- `LocalMIP.add_var(...)`, `LocalMIP.add_con(...)`
+- `LocalMIP.get_solution()`
+
+## Notes
+- `pip install ./python-bindings` compiles the Local-MIP core and the extension together inside the wheel build.
+- The local helper script `python-bindings/build.sh` still works for iterative development builds.
+- Long-running `run()` releases the GIL; Python callbacks reacquire the GIL before execution.
+- Callback contexts (`Start::Start_Ctx`, etc.) are exposed as structured Python objects with read-only shared sequence views and writable fields where the solver expects mutation.
+- `NeighborCtx.op_size` is derived from `clear_ops()`, `set_single_op(...)`, and `append_op(...)`; update move outputs through those helpers instead of writing the size directly.
+- Python callbacks can optionally receive a Python `user_data` object; if omitted, the old shorter callback signatures still work.

localmip-2.0.1/VERSION

@@ -0,0 +1 @@
+2.0.1