Merge branch 'main' into junikimm717/binsparse-pr

Author: BenBrock

.github/workflows/ci.yml

@@ -26,19 +26,33 @@ jobs:
 
   gcc:
     runs-on: 'ubuntu-latest'
-    strategy:
-      matrix:
-        cxx: [gcc, clang]
-    name: ${{ matrix.cxx }}
     env:
-      CXX: ${{ matrix.cxx }}
+      CXX: g++-12
+      CC: gcc-12
     steps:
     - uses: actions/checkout@v4
     - name: CMake
       run: |
         sudo apt-get update
-        sudo apt-get install libhdf5-dev g++-12
-        CXX=g++-12 cmake -B build
+        sudo apt-get install libhdf5-dev $CXX $CC
+        cmake -B build
+    - name: Build
+      run: VERBOSE=true make -C build -j `nproc`
+    - name: Test
+      run: ctest --test-dir ./build/test/bash
+
+  clang:
+    runs-on: 'ubuntu-latest'
+    env:
+      CXX: clang++
+      CC: clang
+    steps:
+    - uses: actions/checkout@v4
+    - name: CMake
+      run: |
+        sudo apt-get update
+        sudo apt-get install libhdf5-dev clang
+        cmake -B build
     - name: Build
       run: VERBOSE=true make -C build -j `nproc`
     - name: Test

.gitignore

@@ -4,6 +4,6 @@
 
 scripts
 venv
-build
+build*
 ._*
 tensor_test_files

CMakeLists.txt

@@ -2,43 +2,88 @@
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
-cmake_minimum_required(VERSION 3.5)
-project(binsparse-rc)
+cmake_minimum_required(VERSION 3.20)
+project(binsparse VERSION 1.0.0)
 
 cmake_policy(SET CMP0079 NEW)
 
 set(CMAKE_C_STANDARD 11)
-
 set(CMAKE_CXX_STANDARD 20)
-
 set(CMAKE_C_FLAGS "-O3 -march=native")
 
-add_library(binsparse-rc SHARED)
+include(GNUInstallDirs)
+
+add_library(binsparse STATIC)
 
 add_subdirectory(include)
 add_subdirectory(src)
 
 # NOTE: For now, both HDF5 and cJSON are `PUBLIC`, meaning that anything that
-# depends on `binsparse-rc` will also link/include HDF5 and cJSON. We can change
-# these to `PRIVATE` to use them only when building binsparse-rc.
+# depends on `binsparse` will also link/include HDF5 and cJSON. We can change
+# these to `PRIVATE` to use them only when building binsparse.
 
 find_package(HDF5 REQUIRED COMPONENTS C)
-target_link_libraries(binsparse-rc PUBLIC ${HDF5_C_LIBRARIES})
-target_include_directories(binsparse-rc PUBLIC . ${HDF5_INCLUDE_DIRS})
+target_link_libraries(binsparse PUBLIC ${HDF5_C_LIBRARIES})
 
 include(FetchContent)
 FetchContent_Declare(
   cJSON
-  GIT_REPOSITORY https://github.com/DaveGamble/cJSON.git
-  GIT_TAG v1.7.17
+  # GIT_REPOSITORY https://github.com/DaveGamble/cJSON.git
+  GIT_REPOSITORY https://github.com/p1k0chu/cJSON.git
+  GIT_TAG 887642c0a93bd8a6616bf90daacac0ea7d4b095e
 )
 FetchContent_MakeAvailable(cJSON)
 
 configure_file(${cJSON_SOURCE_DIR}/cJSON.h ${CMAKE_BINARY_DIR}/include/cJSON/cJSON.h)
-target_include_directories(${PROJECT_NAME} PUBLIC ${CMAKE_BINARY_DIR}/include)
 target_link_libraries(${PROJECT_NAME} PUBLIC cjson)
 
+# Set up include directories properly for both build and install
+target_include_directories(${PROJECT_NAME}
+    PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+        $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/include>
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+        ${HDF5_INCLUDE_DIRS})
+
 if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
   add_subdirectory(examples)
   add_subdirectory(test)
 endif()
+
+# Installation rules - these are always needed when the library is built
+install(TARGETS binsparse
+        EXPORT binsparse-targets
+        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+        INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+
+# Install headers
+install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/binsparse
+        DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+        FILES_MATCHING PATTERN "*.h"
+                       PATTERN "*.hpp")
+
+# Export targets
+install(EXPORT binsparse-targets
+        FILE binsparse-targets.cmake
+        NAMESPACE binsparse::
+        DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/binsparse)
+
+# Create and install package config files
+include(CMakePackageConfigHelpers)
+write_basic_package_version_file(
+    "${CMAKE_CURRENT_BINARY_DIR}/binsparse-config-version.cmake"
+    VERSION ${PROJECT_VERSION}
+    COMPATIBILITY SameMajorVersion)
+
+configure_package_config_file(
+    "${CMAKE_CURRENT_SOURCE_DIR}/cmake/binsparse-config.cmake.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/binsparse-config.cmake"
+    INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/binsparse)
+
+install(FILES
+    "${CMAKE_CURRENT_BINARY_DIR}/binsparse-config.cmake"
+    "${CMAKE_CURRENT_BINARY_DIR}/binsparse-config-version.cmake"
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/binsparse)

cmake/binsparse-config.cmake.in

@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: 2024 Binsparse Developers
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+@PACKAGE_INIT@
+
+include("${CMAKE_CURRENT_LIST_DIR}/binsparse-targets.cmake")
+check_required_components(binsparse)
+
+# Include dependencies
+include(CMakeFindDependencyMacro)
+find_dependency(HDF5 COMPONENTS C)
+
+# cJSON is bundled with binsparse, no need to find it externally

examples/CMakeLists.txt

@@ -4,7 +4,7 @@
 
 function(add_example example_name)
   add_executable(${example_name} ${example_name}.c)
-  target_link_libraries(${example_name} binsparse-rc)
+  target_link_libraries(${example_name} binsparse)
 endfunction()
 
 add_example(simple_matrix_write)

examples/bsp2mtx.c

@@ -21,6 +21,9 @@ int main(int argc, char** argv) {
   printf(" === Reading file... ===\n");
   bsp_matrix_t matrix = bsp_read_matrix(input_fname, NULL);
   printf(" === Done writing. ===\n");
+  if (matrix.format != BSP_COO) {
+    matrix = bsp_convert_matrix(matrix, BSP_COO);
+  }
 
   printf(" === Writing to %s... ===\n", output_fname);
   bsp_mmwrite(output_fname, matrix);

examples/cpp/CMakeLists.txt

@@ -4,7 +4,7 @@
 
 function(add_example example_name)
   add_executable(${example_name}-cpp ${example_name}.cpp)
-  target_link_libraries(${example_name}-cpp binsparse-rc)
+  target_link_libraries(${example_name}-cpp binsparse)
 endfunction()
 
 add_example(simple_matrix_write)

include/CMakeLists.txt

@@ -2,4 +2,4 @@
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
-target_include_directories(binsparse-rc PUBLIC .)
+# No need for target_include_directories here - moved to main CMakeLists.txt

include/binsparse/detail/cpp/array.hpp

@@ -63,6 +63,16 @@ inline array_ptr_variant_t get_typed_ptr(bsp_array_t array) {
   return {};
 }
 
+template <typename T>
+constexpr static bool is_c_complex_v =
+    std::is_same_v<std::remove_cvref_t<T>, _Complex double> ||
+    std::is_same_v<std::remove_cvref_t<T>, _Complex float>;
+
+template <typename T, typename U>
+constexpr static bool mixed_c_complex_v =
+    (is_c_complex_v<T> && !is_c_complex_v<U>) ||
+    (!is_c_complex_v<T> && is_c_complex_v<U>);
+
 } // namespace __detail
 
 } // namespace binsparse
@@ -76,7 +86,8 @@ inline void bsp_array_read(bsp_array_t array, size_t index, T& value) {
       [&](auto* ptr) {
         using U = std::remove_pointer_t<decltype(ptr)>;
 
-        if constexpr (std::is_assignable_v<T&, U>) {
+        if constexpr (std::is_convertible_v<U, T> &&
+                      !binsparse::__detail::mixed_c_complex_v<T, U>) {
           value = ptr[index];
         }
       },
@@ -92,7 +103,8 @@ inline void bsp_array_write(bsp_array_t array, size_t index, U value) {
       [&](auto* ptr) {
         using T = std::remove_pointer_t<decltype(ptr)>;
 
-        if constexpr (std::is_assignable_v<T&, U>) {
+        if constexpr (std::is_convertible_v<U, T> &&
+                      !binsparse::__detail::mixed_c_complex_v<T, U>) {
           ptr[index] = value;
         }
       },
@@ -110,7 +122,8 @@ inline void bsp_array_awrite(bsp_array_t array_0, size_t index_0,
         using T = std::remove_pointer_t<decltype(ptr_0)>;
         using U = std::remove_pointer_t<decltype(ptr_1)>;
 
-        if constexpr (std::is_assignable_v<T&, U>) {
+        if constexpr (std::is_convertible_v<U, T> &&
+                      !binsparse::__detail::mixed_c_complex_v<T, U>) {
           ptr_0[index_0] = ptr_1[index_1];
         }
       },

include/binsparse/detail/declamp_values.h

@@ -42,7 +42,12 @@ static inline void bsp_matrix_declamp_values(bsp_matrix_t matrix) {
       real_value = bsp_suitesparse_declamp_impl_(real_value);
       imaginary_value = bsp_suitesparse_declamp_impl_(imaginary_value);
 
-      values[i] = real_value + 1j * imaginary_value;
+      double _Complex complex_value;
+
+      ((double*) &complex_value)[0] = real_value;
+      ((double*) &complex_value)[1] = imaginary_value;
+
+      values[i] = complex_value;
     }
   }
 }