Merge pull request #3 from JetBrains-Research/master

Pull changes

Author: Krekep

.github/workflows/ubuntu.yml

@@ -55,4 +55,9 @@ jobs:
 
       - name: Build library sources
         working-directory: ${{ env.build_dir }}
-        run: cmake --build . --target all --verbose -j `nproc`
+        run: cmake --build . --target all --verbose -j `nproc`
+
+      - name: Run unit-tests (sequential backend)
+        working-directory: ${{ env.build_dir }}
+        run: bash scripts/tests_run_fallback.sh
+        shell: bash

.gitmodules

@@ -1,6 +1,6 @@
-[submodule "thirdparty/googletest"]
-	path = thirdparty/googletest
+[submodule "deps/gtest"]
+	path = deps/gtest
 	url = https://github.com/google/googletest.git
-[submodule "thirdparty/cub"]
-	path = thirdparty/cub
+[submodule "deps/cub"]
+	path = deps/cub
 	url = https://github.com/NVIDIA/cub.git

CMakeLists.txt

@@ -1,119 +1,60 @@
 # CuBool library Cmake config file
 # Add this file as sub-directory to your project to use library functionality
+
 cmake_minimum_required(VERSION 3.17 FATAL_ERROR)
-project(CUBOOL LANGUAGES CXX CUDA)
+project(cubool LANGUAGES CXX)
 
 # Exposed to the user build options
-option(CUBOOL_WITH_CUB "Build project with locally stored CUB library" ON)
-option(CUBOOL_WITH_NSPARSE "Build library with nsparse crs matrix multiplication backend" ON)
-option(CUBOOL_WITH_NAIVE "Build library with naive and naive-shared dense matrix multiplication" ON)
-option(CUBOOL_BUILD_TESTS "Build project unit-tests with gtest" ON)
+option(CUBOOL_WITH_CUDA       "Build library with cuda backend (default)" ON)
+option(CUBOOL_WITH_SEQUENTIAL "Build library with cpu sequential backend (fallback)" ON)
+option(CUBOOL_WITH_NAIVE      "Build library with naive and naive-shared dense matrix multiplication" OFF)
+option(CUBOOL_BUILD_TESTS     "Build project unit-tests with gtest" ON)
 
 set(CUBOOL_VERSION_MAJOR 1)
 set(CUBOOL_VERSION_MINOR 0)
+set(CUBOOL_VERSION_SUB 0)
+
+set(CUBOOL_DEBUG OFF)
+set(CUBOOL_RELEASE OFF)
+
+if (${CMAKE_BUILD_TYPE} MATCHES Release)
+    message(STATUS "Build cubool in release mode")
+    set(CUBOOL_RELEASE ON)
+elseif (${CMAKE_BUILD_TYPE} MATCHES Debug)
+    message(STATUS "Build cubool in debug mode")
+    set(CUBOOL_DEBUG ON)
+else()
+    message(STATUS "Build cubool in release mode (default: was not specified)")
+    set(CUBOOL_RELEASE ON)
+    set(CMAKE_BUILD_TYPE Release)
+endif()
 
-# Configure dependencies
-if (CUBOOL_WITH_CUB)
+# Configure cuda dependencies
+if (CUBOOL_WITH_CUDA)
     message(STATUS "Add cub as cuda utility")
     set(CUB_ENABLE_HEADER_TESTING OFF CACHE BOOL "" FORCE)
     set(CUB_ENABLE_TESTING OFF CACHE BOOL "" FORCE)
     set(CUB_ENABLE_EXAMPLES OFF CACHE BOOL "" FORCE)
-    add_subdirectory(thirdparty/cub)
+    add_subdirectory(deps/cub)
     add_library(cub INTERFACE IMPORTED)
     target_link_libraries(cub INTERFACE CUB::CUB)
-endif()
 
-if (CUBOOL_WITH_NSPARSE)
     message(STATUS "Add nsparse library as crs matrix multiplication backend")
-    add_subdirectory(thirdparty/nsparse-um)
+    add_subdirectory(deps/nsparse-um)
 endif()
 
 if (CUBOOL_WITH_NAIVE)
     message(STATUS "Add naive library as dense matrix multiplication implementation for benchmarks")
-    add_subdirectory(thirdparty/naive)
+    add_subdirectory(deps/naive)
 endif()
 
 if (CUBOOL_BUILD_TESTS)
     message(STATUS "Add googletest as unit-testing library")
-    add_subdirectory(thirdparty/googletest)
+    add_subdirectory(deps/gtest)
 endif()
 
-# Library sources
-set(CUBOOL_SOURCES
-    # Public sources
-    include/cubool/cubool.h
-    # Private sources
-    src/cubool/config.hpp
-    src/cubool/cubool.cu
-    src/cubool/version.hpp
-    src/cubool/instance.cu
-    src/cubool/instance.cpp
-    src/cubool/instance.hpp
-    src/cubool/matrix_base.hpp
-    src/cubool/matrix_dense.cu
-    src/cubool/matrix_dense.hpp
-    src/cubool/matrix_csr.hpp
-    src/cubool/matrix_csr.cu
-    src/cubool/matrix_csr_multiply_sum.cu
-    src/cubool/matrix_csr_multiply_add.cu
-    src/cubool/matrix_csr_ewise_add.cu
-    src/cubool/matrix_csr_kron.cu
-    src/cubool/matrix_csr_transpose.cu
-    src/cubool/kernels/matrix_dense_multiply_add.cuh
-    src/cubool/kernels/matrix_dense_common.cuh
-    src/cubool/kernels/matrix_csr_spkron.cuh
-    src/cubool/kernels/matrix_csr_spmerge.cuh
-    src/cubool/kernels/matrix_csr_sptranspose.cuh
-    src/cubool/details/error.hpp
-    src/cubool/details/device_allocator.cuh
-    src/cubool/details/host_allocator.hpp
-        )
-
-# Shared library object config
-add_library(cubool SHARED ${CUBOOL_SOURCES})
-
-target_include_directories(cubool PUBLIC ${CMAKE_CURRENT_LIST_DIR}/include)
-target_include_directories(cubool PRIVATE ${CMAKE_CURRENT_LIST_DIR}/src)
-
-target_compile_definitions(cubool PRIVATE CUBOOL_VERSION_MAJOR=${CUBOOL_VERSION_MAJOR})
-target_compile_definitions(cubool PRIVATE CUBOOL_VERSION_MINOR=${CUBOOL_VERSION_MINOR})
-
-target_link_libraries(cubool PRIVATE nsparse_um)
-target_compile_features(cubool PUBLIC cxx_std_14)
-
-set_target_properties(cubool PROPERTIES CXX_STANDARD 17)
-set_target_properties(cubool PROPERTIES CXX_STANDARD_REQUIRED ON)
-set_target_properties(cubool PROPERTIES CUDA_STANDARD 14)
-set_target_properties(cubool PROPERTIES CUDA_STANDARD_REQUIRED ON)
-set_target_properties(cubool PROPERTIES CUDA_SEPARABLE_COMPILATION ON)
-
-
-set(CUBOOL_DUMMY_SOURCES
-    include/cubool/cubool.h
-    src/cubool-dummy/cubool.cpp
-    src/cubool-dummy/version.hpp
-    src/cubool-dummy/instance.hpp
-    src/cubool-dummy/matrix.hpp
-        )
-
-# Create dummy library instance for testing purposes
-add_library(cubool_dummy SHARED ${CUBOOL_DUMMY_SOURCES})
-
-target_include_directories(cubool_dummy PUBLIC ${CMAKE_CURRENT_LIST_DIR}/include)
-target_include_directories(cubool_dummy PRIVATE ${CMAKE_CURRENT_LIST_DIR}/src)
-
-target_compile_definitions(cubool_dummy PRIVATE CUBOOL_VERSION_MAJOR=${CUBOOL_VERSION_MAJOR})
-target_compile_definitions(cubool_dummy PRIVATE CUBOOL_VERSION_MINOR=${CUBOOL_VERSION_MINOR})
-
-target_compile_features(cubool_dummy PUBLIC cxx_std_11)
-
-set_target_properties(cubool_dummy PROPERTIES CXX_STANDARD 11)
-set_target_properties(cubool_dummy PROPERTIES CXX_STANDARD_REQUIRED ON)
-
-# If tests enabled, add tests sources to the build
-if (CUBOOL_BUILD_TESTS)
-    add_subdirectory(tests)
-endif()
+# Actual cxx implementation
+add_subdirectory(cubool)
 
 # Copy scripts into binary directory
 file(COPY scripts DESTINATION ${CMAKE_BINARY_DIR}/)

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2020 JetBrains-Research
+Copyright (c) 2020, 2021 JetBrains-Research
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal