nbklu 0.1.0__tar.gz

nbklu-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+build/
+dist/
+.cache/
+.venv/
+compile_commands.json
+tmp/
+wheelhouse/

nbklu-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

nbklu-0.1.0/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "cmake.generator": "Ninja",
+  "cmake.copyCompileCommands": "${workspaceFolder}/compile_commands.json",
+  "cmake.configureArgs": [
+    "-DSKBUILD_PROJECT_NAME=nbklu",
+    "-DPython_ROOT_DIR=${workspaceFolder}/.venv",
+    "-DPython_FIND_VIRTUALENV=FIRST",
+    "-DCMAKE_PREFIX_PATH=${workspaceFolder}/.venv/lib/site-packages"
+  ],
+}

nbklu-0.1.0/CMakeLists.txt

@@ -0,0 +1,14 @@
+cmake_minimum_required(VERSION 3.15)
+project(${SKBUILD_PROJECT_NAME} LANGUAGES CXX)
+
+add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/src/suitesparse)
+
+find_package(Python 3.10 REQUIRED
+  COMPONENTS Interpreter Development.Module
+  OPTIONAL_COMPONENTS Development.SABIModule
+)
+find_package(nanobind CONFIG REQUIRED)
+
+nanobind_add_module(_ext NB_STATIC STABLE_ABI src/_ext/main.cc)
+target_link_libraries(_ext PRIVATE klu)
+install(TARGETS _ext LIBRARY DESTINATION nbklu)

nbklu-0.1.0/LICENSE

@@ -0,0 +1,13 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Liangyu Zhang
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

nbklu-0.1.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: nbklu
+Version: 0.1.0
+Summary: Python wrapper for KLU
+Author-Email: Azuk 443 <me@azuk.top>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Project-URL: Homepage, https://github.com/determ1ne/nbklu
+Project-URL: Issues, https://github.com/determ1ne/nbklu/issues
+Requires-Python: >=3.10
+Requires-Dist: numpy>=2.0.0
+Description-Content-Type: text/markdown
+
+# nbklu: Python bindings for KLU in nanobind
+
+## Installation
+
+```
+pip install nbklu
+# or install from source
+pip install git+https://github.com/determ1ne/nbklu.git
+```
+
+## Usage
+
+```python
+import numpy as np
+import nbklu._ext as klu
+
+n = 5
+Ap = np.array([0, 2, 5, 9, 10, 12])
+Ai = np.array([0, 1, 0, 2, 4, 1, 2, 3, 4, 2, 1, 4])
+Ax = np.array([2.0, 3.0, 3.0, -1.0, 4.0, 4.0, -3.0, 1.0, 2.0, 2.0, 6.0, 1.0])
+b = np.array([8.0, 45.0, -3.0, 3.0, 19.0])
+
+common = klu.Common()
+common.defaults()
+symbolic = klu.analyze(n, Ap, Ai, common)
+numeric = klu.factor(Ap, Ai, Ax, symbolic, common)
+klu.solve(symbolic, numeric, n, 1, b, common)
+print(b)
+```
+
+Detailed documentation can be found in the [KLU documentation](https://github.com/DrTimothyAldenDavis/SuiteSparse/blob/dev/KLU/Doc/KLU_UserGuide.pdf).

nbklu-0.1.0/README.md

@@ -0,0 +1,31 @@
+# nbklu: Python bindings for KLU in nanobind
+
+## Installation
+
+```
+pip install nbklu
+# or install from source
+pip install git+https://github.com/determ1ne/nbklu.git
+```
+
+## Usage
+
+```python
+import numpy as np
+import nbklu._ext as klu
+
+n = 5
+Ap = np.array([0, 2, 5, 9, 10, 12])
+Ai = np.array([0, 1, 0, 2, 4, 1, 2, 3, 4, 2, 1, 4])
+Ax = np.array([2.0, 3.0, 3.0, -1.0, 4.0, 4.0, -3.0, 1.0, 2.0, 2.0, 6.0, 1.0])
+b = np.array([8.0, 45.0, -3.0, 3.0, 19.0])
+
+common = klu.Common()
+common.defaults()
+symbolic = klu.analyze(n, Ap, Ai, common)
+numeric = klu.factor(Ap, Ai, Ax, symbolic, common)
+klu.solve(symbolic, numeric, n, 1, b, common)
+print(b)
+```
+
+Detailed documentation can be found in the [KLU documentation](https://github.com/DrTimothyAldenDavis/SuiteSparse/blob/dev/KLU/Doc/KLU_UserGuide.pdf).

nbklu-0.1.0/examples/raw_klu_simple.py

@@ -0,0 +1,21 @@
+import numpy as np
+import nbklu._ext as klu
+
+
+def main():
+    n = 5
+    Ap = np.array([0, 2, 5, 9, 10, 12])
+    Ai = np.array([0, 1, 0, 2, 4, 1, 2, 3, 4, 2, 1, 4])
+    Ax = np.array([2.0, 3.0, 3.0, -1.0, 4.0, 4.0, -3.0, 1.0, 2.0, 2.0, 6.0, 1.0])
+    b = np.array([8.0, 45.0, -3.0, 3.0, 19.0])
+
+    common = klu.Common()
+    common.defaults()
+    symbolic = klu.analyze(n, Ap, Ai, common)
+    numeric = klu.factor(Ap, Ai, Ax, symbolic, common)
+    klu.solve(symbolic, numeric, n, 1, b, common)
+    print(b)
+
+
+if __name__ == "__main__":
+    main()

nbklu-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "nbklu"
+version = "0.1.0"
+description = "Python wrapper for KLU"
+readme = "README.md"
+authors = [
+    { name = "Azuk 443", email = "me@azuk.top" }
+]
+requires-python = ">=3.10"
+dependencies = [
+    "numpy>=2.0.0",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+
+[project.urls]
+Homepage = "https://github.com/determ1ne/nbklu"
+Issues = "https://github.com/determ1ne/nbklu/issues"
+
+[tool.scikit-build]
+minimum-version = "build-system.requires"
+build-dir = "build/{wheel_tag}"
+wheel.py-api = "cp312"
+
+[tool.uv]
+cache-keys = [{ file = "pyproject.toml" }, { file = "src/**/*.{h,c,hpp,cpp}" }, { file = "CMakeLists.txt" }]
+no-build-isolation-package = ["nbklu"]
+
+[tool.cibuildwheel]
+build-frontend = "build[uv]"
+
+[build-system]
+requires = ["scikit-build-core>=0.10", "nanobind"]
+build-backend = "scikit_build_core.build"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+    "scikit-build-core",
+    "nanobind",
+]
+build = [
+    "scikit-build-core",
+]

nbklu-0.1.0/src/_ext/main.cc

@@ -0,0 +1,103 @@
+#include <nanobind/nanobind.h>
+#include <nanobind/stl/string.h>
+#include <nanobind/stl/vector.h>
+#include <nanobind/ndarray.h>
+#include <klu.h>
+
+namespace nb = nanobind;
+
+NB_MODULE(_ext, m) {
+    m.doc() = "KLU sparse solver Python bindings";
+
+    // Define klu_common struct wrapper
+    nb::class_<klu_common>(m, "Common")
+        .def(nb::init<>())
+        .def("defaults", &klu_defaults)
+        .def_rw("tol", &klu_common::tol)
+        .def_rw("memgrow", &klu_common::memgrow)
+        .def_rw("initmem_amd", &klu_common::initmem_amd)
+        .def_rw("initmem", &klu_common::initmem)
+        .def_rw("maxwork", &klu_common::maxwork)
+        .def_rw("btf", &klu_common::btf)
+        .def_rw("ordering", &klu_common::ordering)
+        .def_rw("scale", &klu_common::scale)
+        .def_rw("halt_if_singular", &klu_common::halt_if_singular)
+        .def_rw("status", &klu_common::status)
+        .def_rw("nrealloc", &klu_common::nrealloc)
+        .def_rw("structural_rank", &klu_common::structural_rank)
+        .def_rw("numerical_rank", &klu_common::numerical_rank)
+        .def_rw("singular_col", &klu_common::singular_col)
+        .def_rw("noffdiag", &klu_common::noffdiag)
+        .def_rw("flops", &klu_common::flops)
+        .def_rw("rcond", &klu_common::rcond)
+        .def_rw("condest", &klu_common::condest)
+        .def_rw("rgrowth", &klu_common::rgrowth)
+        .def_rw("work", &klu_common::work)
+        .def_rw("memusage", &klu_common::memusage)
+        .def_rw("mempeak", &klu_common::mempeak);
+
+    // Define klu_symbolic struct wrapper
+    nb::class_<klu_symbolic>(m, "Symbolic")
+        .def("free", [](klu_symbolic* self, klu_common* common) {
+            klu_free_symbolic(&self, common);
+        })
+        .def_rw("symmetry", &klu_symbolic::symmetry)
+        .def_rw("est_flops", &klu_symbolic::est_flops)
+        .def_rw("lnz", &klu_symbolic::lnz)
+        .def_rw("unz", &klu_symbolic::unz)
+        .def_rw("n", &klu_symbolic::n)
+        .def_rw("nz", &klu_symbolic::nz)
+        .def_rw("nzoff", &klu_symbolic::nzoff)
+        .def_rw("nblocks", &klu_symbolic::nblocks)
+        .def_rw("maxblock", &klu_symbolic::maxblock)
+        .def_rw("ordering", &klu_symbolic::ordering)
+        .def_rw("do_btf", &klu_symbolic::do_btf)
+        .def_rw("structural_rank", &klu_symbolic::structural_rank);
+
+    // Define klu_numeric struct wrapper
+    nb::class_<klu_numeric>(m, "Numeric")
+        .def("free", [](klu_numeric* self, klu_common* common) {
+            klu_free_numeric(&self, common);
+        })
+        .def_rw("n", &klu_numeric::n)
+        .def_rw("nblocks", &klu_numeric::nblocks)
+        .def_rw("lnz", &klu_numeric::lnz)
+        .def_rw("unz", &klu_numeric::unz)
+        .def_rw("max_lnz_block", &klu_numeric::max_lnz_block)
+        .def_rw("max_unz_block", &klu_numeric::max_unz_block)
+        .def_rw("nzoff", &klu_numeric::nzoff);
+
+    // KLU status constants
+    m.attr("KLU_OK") = KLU_OK;
+    m.attr("KLU_SINGULAR") = KLU_SINGULAR;
+    m.attr("KLU_OUT_OF_MEMORY") = KLU_OUT_OF_MEMORY;
+    m.attr("KLU_INVALID") = KLU_INVALID;
+    m.attr("KLU_TOO_LARGE") = KLU_TOO_LARGE;
+
+    // KLU functions
+    m.def("analyze", [](int32_t n, const nb::ndarray<int32_t>& Ap, const nb::ndarray<int32_t>& Ai, klu_common* common) {
+        return klu_analyze(n, Ap.data(), Ai.data(), common);
+    });
+
+    m.def("analyze_given", [](int32_t n, const nb::ndarray<int32_t>& Ap, const nb::ndarray<int32_t>& Ai, const nb::ndarray<int32_t>& P, const nb::ndarray<int32_t>& Q, klu_common* common) {
+        return klu_analyze_given(n, Ap.data(), Ai.data(), P.data(), Q.data(), common);
+    });
+
+    m.def("factor", [](const nb::ndarray<int32_t>& Ap, const nb::ndarray<int32_t>& Ai, const nb::ndarray<double>& Ax, klu_symbolic* symbolic, klu_common* common) {
+        return klu_factor(Ap.data(), Ai.data(), Ax.data(), symbolic, common);
+    });
+
+    m.def("solve",
+          [](klu_symbolic *symbolic, klu_numeric *numeric, int32_t ldim,
+             int32_t nrhs, nb::ndarray<double> &B, klu_common *common) {
+            return klu_solve(symbolic, numeric, ldim, nrhs, B.data(), common);
+          });
+
+    // m.def("tsolve", [](klu_symbolic* symbolic, klu_numeric* numeric, int32_t ldim, int32_t nrhs, double* B, klu_common* common) {
+    //     return klu_tsolve(symbolic, numeric, ldim, nrhs, B, common);
+    // });
+
+    // m.def("refactor", [](const int32_t* Ap, const int32_t* Ai, const double* Ax, klu_symbolic* symbolic, klu_numeric* numeric, klu_common* common) {
+    //     return klu_refactor(const_cast<int32_t*>(Ap), const_cast<int32_t*>(Ai), const_cast<double*>(Ax), symbolic, numeric, common);
+    // });
+}

nbklu-0.1.0/src/nbklu/_ext.pyi

@@ -0,0 +1,81 @@
+"""KLU sparse solver Python bindings"""
+
+import numpy as np
+
+# Type aliases
+typedict = dict[str, np.ndarray]
+
+# KLU status constants
+KLU_OK: int
+KLU_SINGULAR: int
+KLU_OUT_OF_MEMORY: int
+KLU_INVALID: int
+KLU_TOO_LARGE: int
+
+class Common:
+    """KLU common control parameters and statistics"""
+    def __init__(self) -> None: ...
+    def defaults(self) -> None: ...
+    
+    # Parameters
+    tol: float
+    memgrow: float
+    initmem_amd: float
+    initmem: float
+    maxwork: float
+    btf: int
+    ordering: int
+    scale: int
+    halt_if_singular: int
+    
+    # Statistics
+    status: int
+    nrealloc: int
+    structural_rank: int
+    numerical_rank: int
+    singular_col: int
+    noffdiag: int
+    flops: float
+    rcond: float
+    condest: float
+    rgrowth: float
+    work: float
+    memusage: int
+    mempeak: int
+
+class Symbolic:
+    """KLU symbolic factorization object"""
+    def free(self, common: Common) -> None: ...
+    
+    # Symbolic factorization properties
+    symmetry: float
+    est_flops: float
+    lnz: float
+    unz: float
+    n: int
+    nz: int
+    nzoff: int
+    nblocks: int
+    maxblock: int
+    ordering: int
+    do_btf: int
+    structural_rank: int
+
+class Numeric:
+    """KLU numeric factorization object"""
+    def free(self, common: Common) -> None: ...
+    
+    # Numeric factorization properties
+    n: int
+    nblocks: int
+    lnz: int
+    unz: int
+    max_lnz_block: int
+    max_unz_block: int
+    nzoff: int
+
+# KLU functions
+def analyze(n: int, Ap: np.ndarray[int], Ai: np.ndarray[int], common: Common) -> Symbolic: ...
+def analyze_given(n: int, Ap: np.ndarray[int], Ai: np.ndarray[int], P: np.ndarray[int], Q: np.ndarray[int], common: Common) -> Symbolic: ...
+def factor(Ap: np.ndarray[int], Ai: np.ndarray[int], Ax: np.ndarray[float], symbolic: Symbolic, common: Common) -> Numeric: ...
+def solve(symbolic: Symbolic, numeric: Numeric, ldim: int, nrhs: int, B: np.ndarray[float], common: Common) -> int: ...

nbklu-0.1.0/src/suitesparse/CMakeLists.txt

@@ -0,0 +1,30 @@
+project(suitesparse)
+
+file(GLOB SUITESPARSE_CONFIG_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/suitesparse_config/src/*.c")
+add_library(suitesparse_config ${SUITESPARSE_CONFIG_SOURCES})
+target_compile_definitions(suitesparse_config PUBLIC NTIMER)
+target_include_directories(suitesparse_config PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/suitesparse_config/include)
+
+file(GLOB SUITESPARSE_AMD_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/amd/src/*.c")
+add_library(amd ${SUITESPARSE_AMD_SOURCES})
+target_include_directories(amd PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/amd/include)
+target_link_libraries(amd PUBLIC suitesparse_config)
+
+file(GLOB SUITESPARSE_COLAMD_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/colamd/src/*.c")
+add_library(colamd ${SUITESPARSE_COLAMD_SOURCES})
+target_include_directories(colamd PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/colamd/include)
+target_link_libraries(colamd PUBLIC suitesparse_config)
+
+file(GLOB SUITESPARSE_BTF_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/btf/src/*.c")
+add_library(btf ${SUITESPARSE_BTF_SOURCES})
+target_include_directories(btf PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/btf/include)
+target_link_libraries(btf PUBLIC suitesparse_config)
+
+file(GLOB SUITESPARSE_KLU_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/klu/src/*.c")
+add_library(klu ${SUITESPARSE_KLU_SOURCES})
+target_include_directories(klu PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/klu/include)
+target_link_libraries(klu PUBLIC suitesparse_config amd colamd btf)
+
+set_target_properties(amd btf colamd klu suitesparse_config 
+  PROPERTIES POSITION_INDEPENDENT_CODE ON
+)