CPP modularized bitset module

Author: jvdp1

CMakeLists.txt

@@ -49,6 +49,14 @@ if(NOT DEFINED CMAKE_MAXIMUM_RANK)
   set(CMAKE_MAXIMUM_RANK 4 CACHE STRING "Maximum array rank for generated procedures")
 endif()
 
+
+option(STDLIB_WITH_BITSET "Compile STDLIB BITSET" ON)
+
+if(STDLIB_WITH_BITSET)
+  message(STATUS "Enable stdlib bitset module")
+  add_compile_definitions(STDLIB_BITSET)
+endif() 
+
 option(FIND_BLAS "Find external BLAS and LAPACK" ON)
 
 # --- find external BLAS and LAPACK

cmake/stdlib.cmake

@@ -101,6 +101,9 @@ function(configure_stdlib_target target_name regular_sources_var fypp_files_var
         $<BUILD_INTERFACE:${LIB_MOD_DIR}>
         $<INSTALL_INTERFACE:${CMAKE_INSTALL_MODULEDIR}>
     )
+    target_include_directories(${target_name} PRIVATE
+        ${PROJECT_SOURCE_DIR}/include
+    )
 
     install(TARGETS ${target_name}
             EXPORT ${PROJECT_NAME}-targets

doc/specs/stdlib_math.md

@@ -93,7 +93,7 @@ All arguments must have same `type` and same `kind`.
 #### Examples
 
 ```fortran
-{!example/math/example_math_swap.f90!}
+{!example/math/example_math_swap.F90!}
 ```
 
 ### `gcd` function

example/CMakeLists.txt

@@ -6,10 +6,22 @@ macro(ADD_EXAMPLE name)
              WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
 endmacro(ADD_EXAMPLE)
 
+macro(ADD_EXAMPLEPP name)
+    add_executable(example_${name} example_${name}.F90)
+    target_link_libraries(example_${name} "${PROJECT_NAME}")
+    add_test(NAME ${name}
+             COMMAND $<TARGET_FILE:example_${name}> ${CMAKE_CURRENT_BINARY_DIR}
+             WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+endmacro(ADD_EXAMPLEPP)
+
+
+
 add_subdirectory(ansi)
 add_subdirectory(array)
 add_subdirectory(ascii)
-add_subdirectory(bitsets)
+if (STDLIB_WITH_BITSET)
+  add_subdirectory(bitsets)
+endif()
 add_subdirectory(constants)
 add_subdirectory(error)
 add_subdirectory(hashmaps)

example/math/CMakeLists.txt

@@ -15,5 +15,5 @@ ADD_EXAMPLE(math_argpi)
 ADD_EXAMPLE(math_deg2rad)
 ADD_EXAMPLE(math_rad2deg)
 ADD_EXAMPLE(math_is_close)
-ADD_EXAMPLE(math_swap)
+ADD_EXAMPLEPP(math_swap)
 ADD_EXAMPLE(meshgrid)

example/math/example_math_swap.f90 renamed to example/math/example_math_swap.F90

@@ -43,12 +43,14 @@ program example_math_swap
         call swap(x,y)
     end block
 
+#ifdef STDLIB_BITSET
     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
+#endif
 
-end program example_math_swap  
+end program example_math_swap  

example/sorting/CMakeLists.txt

@@ -3,4 +3,6 @@ ADD_EXAMPLE(sort)
 ADD_EXAMPLE(sort_adjoint)
 ADD_EXAMPLE(sort_index)
 ADD_EXAMPLE(radix_sort)
-ADD_EXAMPLE(sort_bitset)
+if (STDLIB_WITH_BITSET)
+  ADD_EXAMPLE(sort_bitset)
+endif()

include/common.fypp

@@ -45,8 +45,11 @@
 #:set REAL_TYPES = ["real({})".format(k) for k in REAL_KINDS]
 #:set REAL_SUFFIX = REAL_KINDS
 
+#! Real CPPS to be considered during templating
+#:set REAL_CPPS = ["" for k in REAL_KINDS]
+
 #! Collected (kind, type) tuples for real types
-#:set REAL_KINDS_TYPES = list(zip(REAL_KINDS, REAL_TYPES, REAL_INIT))
+#:set REAL_KINDS_TYPES = list(zip(REAL_KINDS, REAL_TYPES, REAL_INIT, REAL_CPPS))
 
 #! Complex kinds to be considered during templating
 #:set CMPLX_KINDS = ["sp", "dp"]
@@ -102,8 +105,14 @@ $:"s" if cmplx=="c" else "d" if cmplx=="z" else "x" if cmplx=="y" else "q" if cm
 #! Integer types to be considered during templating
 #:set INT_TYPES = ["integer({})".format(k) for k in INT_KINDS]
 
+#! Integer abbreviations to be considered during templating
+#:set INT_INIT = ["" for k in INT_KINDS]
+
+#! Integer CPPs to be considered during templating
+#:set INT_CPPS = ["" for k in INT_KINDS]
+
 #! Collected (kind, type) tuples for integer types
-#:set INT_KINDS_TYPES = list(zip(INT_KINDS, INT_TYPES))
+#:set INT_KINDS_TYPES = list(zip(INT_KINDS, INT_TYPES, INT_INIT, INT_CPPS))
 
 #! Logical kinds to be considered during templating
 #:set LOG_KINDS = ["lk"]
@@ -123,6 +132,12 @@ $:"s" if cmplx=="c" else "d" if cmplx=="z" else "x" if cmplx=="y" else "q" if cm
 #! String types to be considered during templating
 #:set STRING_TYPES = ["type({})".format(k) for k in STRING_KINDS]
 
+#! String abbreviations to be considered during templating
+#:set STRING_INIT = ["" for k in STRING_KINDS]
+
+#! String CPPs to be considered during templating
+#:set STRING_CPPS = ["" for k in STRING_KINDS]
+
 #! Collected (kind, type) tuples for string derived types
 #:set STRING_KINDS_TYPES = list(zip(STRING_KINDS, STRING_TYPES))
 
@@ -132,6 +147,15 @@ $:"s" if cmplx=="c" else "d" if cmplx=="z" else "x" if cmplx=="y" else "q" if cm
 #! Bitset types to be considered during templating
 #:set BITSET_TYPES = ["type({})".format(k) for k in BITSET_KINDS]
 
+#! Bitset abbreviations directive to be considered during templating
+#:set BITSET_INIT = ["" for k in BITSET_KINDS]
+
+#! Bitset CPP directive to be considered during templating
+#:set BITSET_CPPS = ["STDLIB_BITSET" for k in BITSET_KINDS]
+
+#! Collected (kind, type) tuples for bitset types
+#:set BITSET_KINDS_TYPES = list(zip(BITSET_KINDS, BITSET_TYPES, BITSET_INIT, BITSET_CPPS))
+
 #! Sparse types to be considered during templating
 #:set SPARSE_KINDS = ["COO", "CSR", "CSC", "ELL"]
 
@@ -463,4 +487,23 @@ ${indent}$do ${varname}$${n+1+dim_offset-i}$ = lbound(${matname}$, ${n+1+dim_off
   #:endcall  
 #:enddef
 
+#!
+
+#!
+#! Encapsulate code into CPP pre-processing directives #ifdef and #endif
+#!
+#! Args:
+#!   code    (str): Code to be encapsulated
+#!   cpp_var (str): CPP variable
+#!
+#:def generate_cpp(code, cpp_var)
+  #:if cpp_var != ""
+#ifdef ${cpp_var}$
+  #:endif
+  $:code
+  #:if cpp_var != ""
+#endif
+  #:endif
+#:enddef generate_cpp
+
 #:endmute

src/CMakeLists.txt

@@ -1,11 +1,11 @@
+if (STDLIB_WITH_BITSET)
+  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
@@ -49,10 +49,6 @@ set(fppFiles
     stdlib_linalg_matrix_functions.fypp
     stdlib_optval.fypp
     stdlib_selection.fypp
-    stdlib_sorting.fypp
-    stdlib_sorting_ord_sort.fypp
-    stdlib_sorting_sort.fypp
-    stdlib_sorting_sort_adjoint.fypp
     stdlib_sparse_constants.fypp
     stdlib_sparse_conversion.fypp
     stdlib_sparse_kinds.fypp
@@ -79,7 +75,6 @@ set(fppFiles
     stdlib_quadrature_trapz.fypp
     stdlib_quadrature_simps.fypp
     stdlib_random.fypp
-    stdlib_math.fypp
     stdlib_math_linspace.fypp
     stdlib_math_logspace.fypp
     stdlib_math_arange.fypp
@@ -94,7 +89,13 @@ set(fppFiles
     stdlib_strings.fypp
     stdlib_version.fypp
 )
-set(cppFiles stdlib_linalg_constants.fypp)
+set(cppFiles stdlib_linalg_constants.fypp
+    stdlib_math.fypp
+    stdlib_sorting.fypp
+    stdlib_sorting_ord_sort.fypp
+    stdlib_sorting_sort.fypp
+    stdlib_sorting_sort_adjoint.fypp
+    )
 set(f90Files
     stdlib_ansi.f90
     stdlib_ansi_operator.f90
@@ -121,4 +122,6 @@ 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:${STDLIB_WITH_BITSET}>:bitsets>
+  blas lapack)

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 "")