cardal 0.0.1__tar.gz

cardal-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,82 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  source-hygiene:
+    name: Source hygiene
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Validate project metadata
+        run: |
+          python - <<'PY'
+          import pathlib
+          import tomllib
+
+          root = pathlib.Path(".")
+          data = tomllib.loads(root.joinpath("pyproject.toml").read_text())
+          project = data["project"]
+          assert project["name"] == "cardal"
+          assert project["license"] == "Apache-2.0"
+          assert root.joinpath("LICENSE").exists()
+          assert root.joinpath("CITATION.cff").exists()
+          for key in ("Homepage", "Repository", "Issues", "Documentation"):
+              assert key in project["urls"], key
+          PY
+
+      - name: Compile Python sources
+        run: python -m compileall -q python/cardal
+
+      - name: Check for stale private paths
+        run: |
+          python - <<'PY'
+          import pathlib
+          import re
+          import sys
+
+          pattern = re.compile(r"/home/sevan|/data0|/data1|loralm")
+          skipped_dirs = {".git", "build", ".pytest_cache", "__pycache__"}
+          hits = []
+          for path in pathlib.Path(".").rglob("*"):
+              if not path.is_file():
+                  continue
+              if any(part in skipped_dirs for part in path.parts):
+                  continue
+              if path == pathlib.Path(".github/workflows/ci.yml"):
+                  continue
+              try:
+                  text = path.read_text(errors="ignore")
+              except Exception:
+                  continue
+              for lineno, line in enumerate(text.splitlines(), 1):
+                  if pattern.search(line):
+                      hits.append(f"{path}:{lineno}: {line}")
+          if hits:
+              print("\n".join(hits))
+              sys.exit(1)
+          PY
+
+  cuda-smoke:
+    name: CUDA smoke build
+    if: github.event_name == 'workflow_dispatch'
+    runs-on: [self-hosted, linux, x64, cuda]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure single-GPU build
+        run: cmake -S . -B build -DENABLE_MPI=OFF -DCARDAL_BUILD_QUBO=OFF
+
+      - name: Build
+        run: cmake --build build -j
+
+      - name: Run generated MaxCut smoke test
+        run: ./build/cardal -g maxcut,100,1e-2 -T 30 -v 1

cardal-0.0.1/.gitignore

@@ -0,0 +1,72 @@
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+Testing/*
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+# debug information files
+*.dwo
+
+# ignored files
+build/*
+/dist/
+test/*
+/.vscode
+/.venv
+/_b
+*.whl
+*.pyc
+known_bugs/*
+bench_out/*
+docs/*
+logs/*
+scripts/*
+__pycache__/

cardal-0.0.1/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to CARDAL will be documented in this file.
+
+The format is inspired by Keep a Changelog, and this project uses semantic
+versioning once public releases begin.
+
+## [Unreleased]
+
+- Replaced the shared feasibility tolerance with independent primal and dual
+  residual tolerances across the CLI, C API, and Python API.
+- Prepared repository metadata, CI, and community documents for public release.
+- Added Apache-2.0 source headers across tracked source files.
+
+## [0.0.1] - 2026-07-14
+
+- Initial public source snapshot of CARDAL.

cardal-0.0.1/CITATION.cff

@@ -0,0 +1,27 @@
+cff-version: 1.2.0
+message: "If you use CARDAL in academic work, please cite the companion paper below."
+title: "CARDAL: A Curvature-Aware Rank-Adaptive Distributed Augmented-Lagrangian Solver for Large-Scale SDPs"
+authors:
+  - family-names: Li
+    given-names: Hongpei
+    email: ishongpeili@gmail.com
+version: 0.0.1
+date-released: 2026-07-14
+license: Apache-2.0
+repository-code: "https://github.com/Lhongpei/CARDAL"
+url: "https://github.com/Lhongpei/CARDAL"
+preferred-citation:
+  type: article
+  title: "A Curvature-Aware Rank-Adaptive Distributed Augmented-Lagrangian Solver for Large-Scale SDPs"
+  authors:
+    - family-names: Li
+      given-names: Hongpei
+    - family-names: Liu
+      given-names: Huikang
+    - family-names: Ge
+      given-names: Dongdong
+    - family-names: Ye
+      given-names: Yinyu
+  year: 2026
+  doi: "10.48550/arXiv.2607.17933"
+  url: "https://arxiv.org/abs/2607.17933"

cardal-0.0.1/CMakeLists.txt

@@ -0,0 +1,206 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2026 Hongpei Li
+
+cmake_minimum_required(VERSION 3.20)
+option(ENABLE_MPI            "Enable distributed computing with MPI"  ON)
+option(CARDAL_BUILD_PYTHON   "Build the CARDAL pybind11 module"       OFF)
+option(CARDAL_BUILD_CLI      "Build the cardal CLI"                    ON)
+option(CARDAL_BUILD_QUBO     "Build the QUBO auxiliary library + CLI" ON)
+
+project(cardal VERSION 0.0.1 LANGUAGES C CXX CUDA)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CUDA_STANDARD 17)
+set(CMAKE_CUDA_STANDARD_REQUIRED ON)
+
+if(NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE Release)
+endif()
+
+if(NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
+    set(CMAKE_CUDA_ARCHITECTURES 70 75 80 86 89 90)
+endif()
+
+find_package(CUDAToolkit REQUIRED)
+find_package(ZLIB REQUIRED)
+
+set(CUDA_LIBS 
+    CUDA::cudart 
+    CUDA::cublas 
+    CUDA::cusparse
+    CUDA::curand
+)
+
+set(CORE_LINK_LIBS 
+    ZLIB::ZLIB
+)
+option(ENABLE_MATIO "Enable .mat file parsing via libmatio" ON)
+
+if(ENABLE_MATIO)
+    find_path(MATIO_INCLUDE_DIR NAMES matio.h)
+    find_library(MATIO_LIBRARY NAMES matio)
+
+    if(MATIO_INCLUDE_DIR AND MATIO_LIBRARY)
+        message(STATUS "Found system matio header: ${MATIO_INCLUDE_DIR}")
+        message(STATUS "Found system matio library: ${MATIO_LIBRARY}")
+        list(APPEND CORE_LINK_LIBS ${MATIO_LIBRARY})
+        
+        set(MATIO_EXTRA_DEFS USE_MATIO)
+        set(MATIO_EXTRA_INCLUDES ${MATIO_INCLUDE_DIR})
+    else()
+        message(STATUS "System matio not found. Auto-downloading and building libmatio from source...")
+        
+        include(FetchContent)
+        set(MATIO_SHARED OFF CACHE BOOL "Build static libmatio" FORCE)
+        set(MATIO_MAT73 OFF CACHE BOOL "Disable MAT73" FORCE)
+        set(MATIO_WITH_ZLIB ON CACHE BOOL "Enable ZLIB" FORCE)
+        set(MATIO_PIC ON CACHE BOOL "Enable PIC" FORCE)
+        
+        FetchContent_Declare(
+            matio
+            GIT_REPOSITORY https://github.com/tbeu/matio.git
+            GIT_TAG v1.5.23
+            GIT_SHALLOW TRUE
+            GIT_SUBMODULES ""
+            GIT_SUBMODULES_RECURSE FALSE
+        )
+        FetchContent_MakeAvailable(matio)
+        
+        list(APPEND CORE_LINK_LIBS matio)
+        
+        set(MATIO_EXTRA_DEFS USE_MATIO)
+        set(MATIO_EXTRA_INCLUDES ${matio_SOURCE_DIR}/src ${matio_BINARY_DIR})
+    endif()
+else()
+    message(STATUS "matio is DISABLED.")
+endif()
+
+if(ENABLE_MPI)
+    find_package(MPI REQUIRED)
+    message(STATUS "MPI is ENABLED")
+    list(APPEND CORE_LINK_LIBS MPI::MPI_C)
+    
+    list(APPEND CORE_LINK_LIBS MPI::MPI_CXX)
+    
+    find_library(NCCL_LIB NAMES nccl 
+                 PATHS ${CMAKE_CUDA_IMPLICIT_LINK_DIRECTORIES}
+                       $ENV{NCCL_ROOT}/lib
+                       /usr/local/cuda/lib64
+                       /usr/lib/x86_64-linux-gnu)
+
+    if(NCCL_LIB)
+        message(STATUS "Found NCCL: ${NCCL_LIB}")
+        list(APPEND CORE_LINK_LIBS ${NCCL_LIB})
+    else()
+        message(WARNING "NCCL library not found explicitly, falling back to -lnccl")
+        list(APPEND CORE_LINK_LIBS nccl)
+    endif()
+else()
+    message(STATUS "MPI is DISABLED (Single Node Mode)")
+endif()
+
+file(GLOB_RECURSE SRC_FILES CONFIGURE_DEPENDS
+    "${CMAKE_CURRENT_SOURCE_DIR}/src/*.c"
+    "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cu"
+)
+
+list(FILTER SRC_FILES EXCLUDE REGEX "src/(main|cli)\\.c$")
+
+# Distributed (MPI+NCCL) source files — exclude when MPI is off so the
+# non-distributed build produces a lean, single-GPU-only library.
+if(NOT ENABLE_MPI)
+    list(FILTER SRC_FILES EXCLUDE REGEX "src/distribution_(solver|utils)\\.cu$")
+endif()
+
+add_library(sdp_core STATIC ${SRC_FILES})
+
+target_compile_definitions(sdp_core PRIVATE
+    CARDAL_VERSION="${PROJECT_VERSION}"
+)
+
+target_link_libraries(sdp_core 
+    PRIVATE ${CUDA_LIBS} 
+    PUBLIC ${CORE_LINK_LIBS}
+)
+
+target_include_directories(sdp_core PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/internal>
+    ${CUDAToolkit_INCLUDE_DIRS}
+)
+
+if(ENABLE_MPI)
+    target_compile_definitions(sdp_core PUBLIC USE_MPI)
+endif()
+
+if(MATIO_EXTRA_DEFS)
+    target_compile_definitions(sdp_core PUBLIC ${MATIO_EXTRA_DEFS})
+endif()
+if(MATIO_EXTRA_INCLUDES)
+    target_include_directories(sdp_core PUBLIC ${MATIO_EXTRA_INCLUDES})
+endif()
+
+target_compile_options(sdp_core PRIVATE
+    $<$<COMPILE_LANGUAGE:C,CXX>:-O3 -Wall -Wextra -fPIC>
+    $<$<COMPILE_LANGUAGE:CUDA>:-O3 -Xcompiler=-Wall,-Wextra,-fPIC>
+)
+
+set_target_properties(sdp_core PROPERTIES
+    CUDA_SEPARABLE_COMPILATION ON
+    CUDA_RESOLVE_DEVICE_SYMBOLS ON
+)
+
+file(GLOB_RECURSE QUBO_SRC_FILES CONFIGURE_DEPENDS
+    "${CMAKE_CURRENT_SOURCE_DIR}/qubo/*.c"
+    "${CMAKE_CURRENT_SOURCE_DIR}/qubo/*.cu"
+)
+list(FILTER QUBO_SRC_FILES EXCLUDE REGEX "qubo/qubo_cli\\.c$")
+
+if(CARDAL_BUILD_QUBO AND QUBO_SRC_FILES)
+    add_library(sdp_qubo STATIC ${QUBO_SRC_FILES})
+    target_link_libraries(sdp_qubo
+        PUBLIC sdp_core
+        PRIVATE ${CUDA_LIBS}
+    )
+    target_include_directories(sdp_qubo PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/qubo>
+    )
+    target_compile_options(sdp_qubo PRIVATE
+        $<$<COMPILE_LANGUAGE:C,CXX>:-O3 -Wall -Wextra -fPIC>
+        $<$<COMPILE_LANGUAGE:CUDA>:-O3 -Xcompiler=-Wall,-Wextra,-fPIC>
+    )
+    set_target_properties(sdp_qubo PROPERTIES
+        CUDA_SEPARABLE_COMPILATION ON
+        CUDA_RESOLVE_DEVICE_SYMBOLS ON
+    )
+endif()
+
+if(CARDAL_BUILD_CLI AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/src/cli.c")
+    add_executable(cardal src/cli.c)
+    target_compile_definitions(cardal PRIVATE
+        CARDAL_VERSION="${PROJECT_VERSION}"
+    )
+    target_link_libraries(cardal PRIVATE sdp_core)
+endif()
+
+if(CARDAL_BUILD_QUBO AND TARGET sdp_qubo AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/qubo/qubo_cli.c")
+    add_executable(cardal_qubo qubo/qubo_cli.c)
+    target_link_libraries(cardal_qubo PRIVATE sdp_qubo)
+endif()
+
+if(CARDAL_BUILD_PYTHON)
+    add_subdirectory(python_bindings)
+endif()
+
+if(TARGET cardal)
+    install(TARGETS cardal RUNTIME DESTINATION bin)
+endif()
+if(TARGET cardal_qubo)
+    install(TARGETS cardal_qubo RUNTIME DESTINATION bin)
+endif()
+install(TARGETS sdp_core ARCHIVE DESTINATION lib)
+if(TARGET sdp_qubo)
+    install(TARGETS sdp_qubo ARCHIVE DESTINATION lib)
+endif()
+install(DIRECTORY include/ DESTINATION include)

cardal-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may accept and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Hongpei Li
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing permissions
+   and limitations under the License.

cardal-0.0.1/NOTICE

@@ -0,0 +1,5 @@
+CARDAL
+Copyright 2026 Hongpei Li
+
+This product is licensed under the Apache License, Version 2.0. See the
+LICENSE file for details.