Modularized bitsets

jvdp1 · jvdp1 · commit 584e08926ed0 · 2025-10-24T12:25:21.000+02:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -49,6 +49,8 @@ if(NOT DEFINED CMAKE_MAXIMUM_RANK)
   set(CMAKE_MAXIMUM_RANK 4 CACHE STRING "Maximum array rank for generated procedures")
 endif()
 
+option(WITH_BITSETS "Compile STDLIB BITSETS" ON)
+
 option(FIND_BLAS "Find external BLAS and LAPACK" ON)
 
 # --- find external BLAS and LAPACK
@@ -118,6 +120,7 @@ endif()
 
 list(
   APPEND fyppFlags
+  "-DWITH_BITSETS=$<BOOL:${WITH_BITSETS}>"
   "-DWITH_CBOOL=$<BOOL:${WITH_CBOOL}>"
   "-DWITH_QP=$<BOOL:${WITH_QP}>"
   "-DWITH_XDP=$<BOOL:${WITH_XDP}>"
diff --git a/example/CMakeLists.txt b/example/CMakeLists.txt
@@ -9,7 +9,9 @@ endmacro(ADD_EXAMPLE)
 add_subdirectory(ansi)
 add_subdirectory(array)
 add_subdirectory(ascii)
-add_subdirectory(bitsets)
+if (WITH_BITSETS)
+  add_subdirectory(bitsets)
+endif()
 add_subdirectory(constants)
 add_subdirectory(error)
 add_subdirectory(hashmaps)
diff --git a/example/math/example_math_swap.f90 b/example/math/example_math_swap.f90
@@ -43,12 +43,4 @@ program example_math_swap
         call swap(x,y)
     end block
 
-    block
-        use stdlib_bitsets
-        type(bitset_64) :: x, y
-        call x%from_string('0000')
-        call y%from_string('1111')
-        call swap(x,y)
-    end block
-
-end program example_math_swap  
+end program example_math_swap  
diff --git a/example/sorting/CMakeLists.txt b/example/sorting/CMakeLists.txt
@@ -3,4 +3,6 @@ ADD_EXAMPLE(sort)
 ADD_EXAMPLE(sort_adjoint)
 ADD_EXAMPLE(sort_index)
 ADD_EXAMPLE(radix_sort)
+if (WITH_BITSETS)
 ADD_EXAMPLE(sort_bitset)
+endif()
diff --git a/include/common.fypp b/include/common.fypp
@@ -18,6 +18,11 @@
 #:set WITH_XDP = False
 #:endif
 
+#! Support for bitsets
+#:if not defined("WITH_BITSETS")
+#:set WITH_CBOOL = True
+#:endif
+
 #! Support for linear algebra with 64-bit integer sizes
 #:if not defined("WITH_ILP64")
 #:set WITH_ILP64 = False
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -1,11 +1,12 @@
+if (WITH_BITSETS)
+  add_subdirectory(bitsets)
+endif()
+
 add_subdirectory(blas)
 add_subdirectory(lapack)
 
 set(fppFiles
     stdlib_ascii.fypp
-    stdlib_bitsets.fypp
-    stdlib_bitsets_64.fypp
-    stdlib_bitsets_large.fypp
     stdlib_codata_type.fypp
     stdlib_constants.fypp
     stdlib_error.fypp
@@ -121,4 +122,7 @@ set(f90Files
 
 configure_stdlib_target(${PROJECT_NAME} f90Files fppFiles cppFiles)
 
-target_link_libraries(${PROJECT_NAME} PUBLIC blas lapack)
+target_link_libraries(${PROJECT_NAME} PUBLIC 
+  $<$<BOOL:${WITH_BITSETS}>:bitsets>
+  blas lapack)
+
diff --git a/src/bitsets/CMakeLists.txt b/src/bitsets/CMakeLists.txt
@@ -0,0 +1,9 @@
+set(bitsets_fppFiles
+    ../stdlib_kinds.fypp
+    ../stdlib_optval.fypp
+    stdlib_bitsets.fypp
+    stdlib_bitsets_64.fypp
+    stdlib_bitsets_large.fypp
+)
+
+configure_stdlib_target(bitsets "" bitsets_fppFiles "")
diff --git a/src/bitsets/stdlib_bitsets.fypp b/src/bitsets/stdlib_bitsets.fypp
diff --git a/src/bitsets/stdlib_bitsets_64.fypp b/src/bitsets/stdlib_bitsets_64.fypp
diff --git a/src/bitsets/stdlib_bitsets_large.fypp b/src/bitsets/stdlib_bitsets_large.fypp
diff --git a/src/stdlib_math.fypp b/src/stdlib_math.fypp
@@ -1,11 +1,20 @@
 #:include "common.fypp"
 #:set IR_KINDS_TYPES = INT_KINDS_TYPES + REAL_KINDS_TYPES
 #:set RC_KINDS_TYPES = REAL_KINDS_TYPES + CMPLX_KINDS_TYPES
+
+#:set IRB_KIND_TYPES = INT_KINDS_TYPES + REAL_KINDS_TYPES
+
+#:if WITH_BITSETS
 #:set BITSET_KINDS_TYPES = list(zip(BITSET_KINDS, BITSET_TYPES))
+#:set IRB_KIND_TYPES = IRB_KIND_TYPES + BITSET_KINDS_TYPES
+#:endif
+
 module stdlib_math
     use stdlib_kinds, only: int8, int16, int32, int64, sp, dp, xdp, qp
     use stdlib_optval, only: optval
+#:if WITH_BITSETS
     use stdlib_bitsets, only: bitset_64, bitset_large
+#:endif
 
     implicit none
     private
@@ -48,7 +57,7 @@ module stdlib_math
     !>
     !> Version: experimental
     interface swap
-      #:for k1, t1 in INT_KINDS_TYPES + REAL_KINDS_TYPES + BITSET_KINDS_TYPES
+      #:for k1, t1 in IRB_KIND_TYPES
       module procedure :: swap_${k1}$
       #:endfor
       #:for k1, t1 in CMPLX_KINDS_TYPES
@@ -527,7 +536,7 @@ contains
 
     #:endfor
 
-    #:for k1, t1 in INT_KINDS_TYPES + REAL_KINDS_TYPES + BITSET_KINDS_TYPES
+    #:for k1, t1 in IRB_KIND_TYPES
     elemental subroutine swap_${k1}$(lhs, rhs)
         ${t1}$, intent(inout) :: lhs, rhs
         ${t1}$ :: temp
diff --git a/src/stdlib_sorting.fypp b/src/stdlib_sorting.fypp
@@ -4,17 +4,20 @@
 #:set REAL_TYPES_ALT_NAME = list(zip(REAL_TYPES, REAL_TYPES, REAL_KINDS))
 #:set STRING_TYPES_ALT_NAME = list(zip(STRING_TYPES, STRING_TYPES, STRING_KINDS))
 #:set CHAR_TYPES_ALT_NAME = list(zip(["character(len=*)"], ["character(len=len(array))"], ["char"]))
-#:set BITSET_TYPES_ALT_NAME = list(zip(BITSET_TYPES, BITSET_TYPES, BITSET_KINDS))
 
 #:set INT_INDEX_TYPES_ALT_NAME = list(zip(["int_index", "int_index_low"], ["integer(int_index)", "integer(int_index_low)"], ["default", "low"]))
 
 #! For better code reuse in fypp, make lists that contain the input types,
 #! with each having output types and a separate name prefix for subroutines
 #! This approach allows us to have the same code for all input types.
-#:set IRSCB_TYPES_ALT_NAME = INT_TYPES_ALT_NAME + REAL_TYPES_ALT_NAME + STRING_TYPES_ALT_NAME + CHAR_TYPES_ALT_NAME &
-    & + BITSET_TYPES_ALT_NAME
+#:set IRSCB_TYPES_ALT_NAME = INT_TYPES_ALT_NAME + REAL_TYPES_ALT_NAME + STRING_TYPES_ALT_NAME + CHAR_TYPES_ALT_NAME
 #:set IR_INDEX_TYPES_ALT_NAME = INT_TYPES_ALT_NAME + REAL_TYPES_ALT_NAME
 
+#:if WITH_BITSETS
+#:set BITSET_TYPES_ALT_NAME = list(zip(BITSET_TYPES, BITSET_TYPES, BITSET_KINDS))
+#:set IRSCB_TYPES_ALT_NAME = IRSCB_TYPES_ALT_NAME + BITSET_TYPES_ALT_NAME
+#:endif
+
 !! Licensing:
 !!
 !! This file is subject both to the Fortran Standard Library license, and
@@ -134,8 +137,10 @@ module stdlib_sorting
     use stdlib_string_type, only: string_type, assignment(=), operator(>), &
         operator(>=), operator(<), operator(<=)
 
+#:if WITH_BITSETS
     use stdlib_bitsets, only: bitset_64, bitset_large, &
         assignment(=), operator(>), operator(>=), operator(<), operator(<=)
+#:endif
 
     implicit none
     private
diff --git a/src/stdlib_sorting_ord_sort.fypp b/src/stdlib_sorting_ord_sort.fypp
@@ -3,13 +3,16 @@
 #:set REAL_TYPES_ALT_NAME = list(zip(REAL_TYPES, REAL_TYPES, REAL_TYPES, REAL_KINDS))
 #:set STRING_TYPES_ALT_NAME = list(zip(STRING_TYPES, STRING_TYPES, STRING_TYPES, STRING_KINDS))
 #:set CHAR_TYPES_ALT_NAME = list(zip(["character(len=*)"],  ["character(len=:)"], ["character(len=len(array))"], ["char"]))
-#:set BITSET_TYPES_ALT_NAME = list(zip(BITSET_TYPES, BITSET_TYPES, BITSET_TYPES, BITSET_KINDS))
 
 #! For better code reuse in fypp, make lists that contain the input types,
 #! with each having output types and a separate name prefix for subroutines
 #! This approach allows us to have the same code for all input types.
-#:set IRSCB_TYPES_ALT_NAME = INT_TYPES_ALT_NAME + REAL_TYPES_ALT_NAME + STRING_TYPES_ALT_NAME + CHAR_TYPES_ALT_NAME &
-    & + BITSET_TYPES_ALT_NAME
+#:set IRSCB_TYPES_ALT_NAME = INT_TYPES_ALT_NAME + REAL_TYPES_ALT_NAME + STRING_TYPES_ALT_NAME + CHAR_TYPES_ALT_NAME
+
+#:if WITH_BITSETS
+#:set BITSET_TYPES_ALT_NAME = list(zip(BITSET_TYPES, BITSET_TYPES, BITSET_TYPES, BITSET_KINDS))
+#:set IRSCB_TYPES_ALT_NAME = IRSCB_TYPES_ALT_NAME + BITSET_TYPES_ALT_NAME
+#:endif
 
 #:set SIGN_NAME = ["increase", "decrease"]
 #:set SIGN_TYPE = [">", "<"]
diff --git a/src/stdlib_sorting_sort.fypp b/src/stdlib_sorting_sort.fypp
@@ -3,13 +3,16 @@
 #:set REAL_TYPES_ALT_NAME = list(zip(REAL_TYPES, REAL_TYPES, REAL_KINDS))
 #:set STRING_TYPES_ALT_NAME = list(zip(STRING_TYPES, STRING_TYPES, STRING_KINDS))
 #:set CHAR_TYPES_ALT_NAME = list(zip(["character(len=*)"],  ["character(len=len(array))"], ["char"]))
-#:set BITSET_TYPES_ALT_NAME = list(zip(BITSET_TYPES, BITSET_TYPES, BITSET_KINDS))
 
 #! For better code reuse in fypp, make lists that contain the input types,
 #! with each having output types and a separate name prefix for subroutines
 #! This approach allows us to have the same code for all input types.
-#:set IRSCB_TYPES_ALT_NAME = INT_TYPES_ALT_NAME + REAL_TYPES_ALT_NAME + STRING_TYPES_ALT_NAME + CHAR_TYPES_ALT_NAME &
-    & + BITSET_TYPES_ALT_NAME
+#:set IRSCB_TYPES_ALT_NAME = INT_TYPES_ALT_NAME + REAL_TYPES_ALT_NAME + STRING_TYPES_ALT_NAME + CHAR_TYPES_ALT_NAME
+
+#:if WITH_BITSETS
+#:set BITSET_TYPES_ALT_NAME = list(zip(BITSET_TYPES, BITSET_TYPES, BITSET_KINDS))
+#:set IRSCB_TYPES_ALT_NAME = IRSCB_TYPES_ALT_NAME + BITSET_TYPES_ALT_NAME
+#:endif
 
 #:set SIGN_NAME = ["increase", "decrease"]
 #:set SIGN_TYPE = [">", "<"]
diff --git a/src/stdlib_sorting_sort_adjoint.fypp b/src/stdlib_sorting_sort_adjoint.fypp
@@ -3,15 +3,18 @@
 #:set REAL_TYPES_ALT_NAME = list(zip(REAL_TYPES, REAL_TYPES, REAL_TYPES, REAL_KINDS))
 #:set STRING_TYPES_ALT_NAME = list(zip(STRING_TYPES, STRING_TYPES, STRING_TYPES, STRING_KINDS))
 #:set CHAR_TYPES_ALT_NAME = list(zip(["character(len=*)"],  ["character(len=:)"], ["character(len=len(array))"], ["char"]))
-#:set BITSET_TYPES_ALT_NAME = list(zip(BITSET_TYPES, BITSET_TYPES, BITSET_TYPES, BITSET_KINDS))
 
 #! For better code reuse in fypp, make lists that contain the input types,
 #! with each having output types and a separate name prefix for subroutines
 #! This approach allows us to have the same code for all input types.
-#:set IRSCB_TYPES_ALT_NAME = INT_TYPES_ALT_NAME + REAL_TYPES_ALT_NAME + STRING_TYPES_ALT_NAME + CHAR_TYPES_ALT_NAME &
-    & + BITSET_TYPES_ALT_NAME
+#:set IRSCB_TYPES_ALT_NAME = INT_TYPES_ALT_NAME + REAL_TYPES_ALT_NAME + STRING_TYPES_ALT_NAME + CHAR_TYPES_ALT_NAME
 #:set IR_INDEX_TYPES_ALT_NAME = INT_TYPES_ALT_NAME + REAL_TYPES_ALT_NAME
 
+#:if WITH_BITSETS
+#:set BITSET_TYPES_ALT_NAME = list(zip(BITSET_TYPES, BITSET_TYPES, BITSET_TYPES, BITSET_KINDS))
+#:set IRSCB_TYPES_ALT_NAME = IRSCB_TYPES_ALT_NAME + BITSET_TYPES_ALT_NAME
+#:endif
+
 !! Licensing:
 !!
 !! This file is subjec† both to the Fortran Standard Library license, and
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -29,7 +29,9 @@ endmacro(ADDTESTPP)
 
 add_subdirectory(array)
 add_subdirectory(ascii)
-add_subdirectory(bitsets)
+if (WITH_BITSETS)
+  add_subdirectory(bitsets)
+endif()
 add_subdirectory(constants)
 add_subdirectory(hash_functions)
 add_subdirectory(hash_functions_perf)
diff --git a/test/math/test_stdlib_math.fypp b/test/math/test_stdlib_math.fypp
@@ -370,6 +370,7 @@ contains
         if (allocated(error)) return
     end subroutine test_swap_stt
 
+    #:if WITH_BITSETS
     subroutine test_swap_bitset_64(error)
         use stdlib_bitsets
         type(error_type), allocatable, intent(out) :: error
@@ -415,6 +416,7 @@ contains
         call check(error, x == v )
         if (allocated(error)) return
     end subroutine test_swap_bitset_large
+    #:endif
 
     #:for k1 in CMPLX_KINDS
     subroutine test_arg_${k1}$(error)
diff --git a/test/sorting/test_sorting.fypp b/test/sorting/test_sorting.fypp
