Merge branch 'master' of github.com:fortran-lang/stdlib

Author: zoziha

.github/workflows/CI.yml

@@ -19,24 +19,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-12]
+        os: [ubuntu-latest, macos-13]
         toolchain:
           - {compiler: gcc, version: 10}
           - {compiler: gcc, version: 11}
           - {compiler: gcc, version: 12}
           - {compiler: gcc, version: 13}
-          - {compiler: intel, version: '2024.1'}
-          - {compiler: intel-classic, version: '2021.9'}
-        build: [cmake]
+          - {compiler: intel, version: '2024.1'}          
+        build: [cmake]        
         include:
+          - os: ubuntu-22.04
+            build: cmake
+            toolchain: {compiler: intel-classic, version: '2021.10'}            
           - os: ubuntu-latest
             build: cmake-inline
-            toolchain:
-              - {compiler: gcc, version: 10}
+            toolchain: {compiler: gcc, version: 10}
         exclude:
-          - os: macos-12
+          - os: macos-13
             toolchain: {compiler: intel, version: '2024.1'}
-          - os: macos-12
+          - os: macos-13
             toolchain: {compiler: gcc, version: 13}
     env:
       BUILD_DIR: ${{ matrix.build == 'cmake' && 'build' || '.' }}
@@ -54,7 +55,7 @@ jobs:
       run: pip install --upgrade fypp ninja
 
     - name: Setup Fortran compiler
-      uses: fortran-lang/setup-fortran@v1.6.1
+      uses: fortran-lang/setup-fortran@v1.6.2
       id: setup-fortran
       with:
         compiler: ${{ matrix.toolchain.compiler }}

.github/workflows/ci_windows.yml

@@ -13,9 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         include: [
-          { msystem: MSYS,    arch: x86_64 },
-          { msystem: MINGW64, arch: x86_64 },
-          { msystem: MINGW32, arch: i686   }
+          { msystem: MINGW64, arch: x86_64 }
         ]
     defaults:
       run:
@@ -25,7 +23,6 @@ jobs:
 
     - name: Setup MinGW native environment
       uses: msys2/setup-msys2@v2
-      if: contains(matrix.msystem, 'MINGW')
       with:
         msystem: ${{ matrix.msystem }}
         update: false
@@ -34,30 +31,10 @@ jobs:
           mingw-w64-${{ matrix.arch }}-gcc
           mingw-w64-${{ matrix.arch }}-gcc-fortran
           mingw-w64-${{ matrix.arch }}-python
-          mingw-w64-${{ matrix.arch }}-python-pip
-          mingw-w64-${{ matrix.arch }}-python-setuptools
+          mingw-w64-${{ matrix.arch }}-python-fypp
           mingw-w64-${{ matrix.arch }}-cmake
           mingw-w64-${{ matrix.arch }}-ninja
 
-    - name: Setup msys POSIX environment
-      uses: msys2/setup-msys2@v2
-      if: contains(matrix.msystem, 'MSYS')
-      with:
-        msystem: MSYS
-        update: false
-        install: >-
-          git
-          mingw-w64-x86_64-gcc
-          mingw-w64-x86_64-gcc-fortran
-          python
-          python-pip
-          cmake
-          ninja
-
-    - name: Install fypp
-      run: pip install fypp
-    
-    # Build and test with built-in BLAS and LAPACK
     - run: >-
         PATH=$PATH:/mingw64/bin/ cmake
         -Wdev
@@ -82,7 +59,7 @@ jobs:
     - name: CTest
       run: PATH=$PATH:/mingw64/bin/ ctest --test-dir build --output-on-failure --parallel -V -LE quadruple_precision
 
-    - uses: actions/upload-artifact@v1
+    - uses: actions/upload-artifact@v4
       if: failure()
       with:
         name: WindowsCMakeTestlog

.github/workflows/doc-deployment.yml

@@ -40,7 +40,7 @@ jobs:
           ford -r $(git describe --always) --debug ${MAYBE_SKIP_SEARCH} "${FORD_FILE}"
 
       - name: Upload Documentation
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: FORD-API-docs
           path: ./API-doc/

.github/workflows/fpm-deployment.yml

@@ -38,6 +38,9 @@ jobs:
       - run: | # Just for deployment: create stdlib-fpm folder
           python config/fypp_deployment.py --deploy_stdlib_fpm
 
+      - run: | # Just for deployment: create stdlib-fpm-ilp64 folder
+          python config/fypp_deployment.py --deploy_stdlib_fpm --with_ilp64
+
       - run: | # Use fpm gnu ci to check xdp and qp 
           python config/fypp_deployment.py --with_xdp --with_qp
           fpm test --profile release --flag '-DWITH_XDP -DWITH_QP'
@@ -48,4 +51,12 @@ jobs:
         if: github.event_name != 'pull_request'
         with:
           BRANCH: stdlib-fpm
-          FOLDER: stdlib-fpm
+          FOLDER: stdlib-fpm
+
+    # Update and deploy the f90 files generated by github-ci to the `stdlib-fpm-ilp64` branch.
+      - name: Deploy with 64-bit integer support 🚀
+        uses: JamesIves/github-pages-deploy-action@4.1.5
+        if: github.event_name != 'pull_request'
+        with:
+          BRANCH: stdlib-fpm-ilp64
+          FOLDER: stdlib-fpm-ilp64

API-doc-FORD-file.md

@@ -43,7 +43,7 @@ project_website: https://stdlib.fortran-lang.org
 favicon: doc/media/favicon.ico
 license: by-sa
 author: fortran-lang/stdlib contributors
-author_pic: https://fortran-lang.org/assets/img/fortran_logo_512x512.png
+author_pic: https://fortran-lang.org/en/_static/fortran-logo-256x256.png 
 email: fortran-lang@groups.io
 github: https://github.com/fortran-lang
 twitter: https://twitter.com/fortranlang

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.14.0)
 set(CMAKE_USER_MAKE_RULES_OVERRIDE ${CMAKE_CURRENT_SOURCE_DIR}/config/DefaultFlags.cmake)
 
 project(fortran_stdlib
-        LANGUAGES Fortran
+	LANGUAGES Fortran C
         DESCRIPTION "Community driven and agreed upon de facto standard library for Fortran"
 )
 
@@ -88,6 +88,7 @@ list(
   "-DWITH_CBOOL=$<BOOL:${WITH_CBOOL}>"
   "-DWITH_QP=$<BOOL:${WITH_QP}>"
   "-DWITH_XDP=$<BOOL:${WITH_XDP}>"
+  "-DWITH_ILP64=$<BOOL:${WITH_ILP64}>"
   "-DPROJECT_VERSION_MAJOR=${PROJECT_VERSION_MAJOR}"
   "-DPROJECT_VERSION_MINOR=${PROJECT_VERSION_MINOR}"
   "-DPROJECT_VERSION_PATCH=${PROJECT_VERSION_PATCH}"

README.md

@@ -90,15 +90,15 @@ Name | Version | Platform | Architecture
 GCC Fortran | 10, 11, 12, 13 | Ubuntu 22.04.2 LTS | x86_64
 GCC Fortran | 10, 11, 12, 13 | macOS 12.6.3 (21G419) | x86_64
 GCC Fortran (MSYS) | 13 | Windows Server 2022 (10.0.20348 Build 1547) | x86_64
-GCC Fortran (MinGW) | 13 | Windows Server 2022 (10.0.20348 Build 1547) | x86_64, i686
+GCC Fortran (MinGW) | 13 | Windows Server 2022 (10.0.20348 Build 1547) | x86_64
 Intel oneAPI LLVM | 2024.0 | Ubuntu 22.04.2 LTS | x86_64
 Intel oneAPI classic | 2023.1 | macOS 12.6.3 (21G419) | x86_64
 
 The following combinations are known to work, but they are not tested in the CI:
 
 Name | Version | Platform | Architecture
 --- | --- | --- | ---
-GCC Fortran (MinGW) | 9.3.0, 10.2.0, 11.2.0 | Windows 10 | x86_64, i686
+GCC Fortran (MinGW) | 9.3.0, 10.2.0, 11.2.0 | Windows 10 | x86_64
 
 We try to test as many available compilers and platforms as possible.
 A list of tested compilers which are currently not working and the respective issue are listed below.
@@ -220,7 +220,29 @@ python config/fypp_deployment.py --help
 git checkout stdlib-fpm
 fpm build --profile release
 ```
-#### Runing the examples
+
+
+#### Installing with fpm
+
+Either option you chose for building the `stdlib`, you can install it with:
+```sh
+fpm install --profile release
+```
+The command above will install the following files:
+- `libstdlib.a` into `~/.local/lib/` (Unix) or `C:\Users\<username>\AppData\Roaming\local\lib\` (Windows)
+- all the `.[s]mod` files produced by the compiler into `~/.local/include/` (Unix) or `C:\Users\<username>\AppData\Roaming\local\include\` (Windows)
+
+You can change the installation path by setting the prefix option to `fpm`:
+```sh
+fpm install --profile release --prefix /my/custom/installation/path/
+```
+
+You can use the `stdlib` by adding the `-lstdlib` flag to your compiler.
+If your prefix is a non standard path, add also:
+- `-L/my/custom/installation/path/lib`
+- `-I/my/custom/installation/path/include`
+
+#### Running the examples
 You can run the examples with `fpm` as:
 
 ```sh
@@ -324,6 +346,34 @@ as well as a specification document or ["spec"](https://stdlib.fortran-lang.org/
 Some discussions and prototypes of proposed APIs along with a list of popular open source Fortran projects are available on the
 [wiki](https://github.com/fortran-lang/stdlib/wiki).
 
+## BLAS and LAPACK
+
+`stdlib` ships full versions of BLAS and LAPACK, for all `real` and `complex` kinds, through generalized interface modules `stdlib_linalg_blas` and `stdlib_linalg_lapack`.
+The 32- and 64-bit implementations may be replaced by external optimized libraries if available, which may allow for faster code.
+When linking against external BLAS/LAPACK libraries, the user should define macros `STDLIB_EXTERNAL_BLAS` and `STDLIB_EXTERNAL_LAPACK`, 
+to ensure that the external library version is used instead of the internal implementation. 
+
+- In case of a CMake build, the necessary configuration can be added by ensuring both macros are defined:
+  ```
+  add_compile_definitions(STDLIB_EXTERNAL_BLAS STDLIB_EXTERNAL_LAPACK)
+  ```
+- In case of an `fpm` build, the stdlib dependency should be set as follows:
+  ```toml
+  [dependencies]
+  stdlib = { git="https://github.com/fortran-lang/stdlib", branch="stdlib-fpm", preprocess.cpp.macros=["STDLIB_EXTERNAL_BLAS", "STDLIB_EXTERNAL_LAPACK"] }
+  ```
+
+Support for 64-bit integer size interfaces of all BLAS and LAPACK procedures may also be enabled 
+by setting the CMake flag `-DWITH_ILP64=True`. The 64-bit integer version is always built in addition to 
+the 32-bit integer version, that is always available. Additional macros `STDLIB_EXTERNAL_BLAS_I64` and `STDLIB_EXTERNAL_LAPACK_I64`  
+may be defined to link against an external 64-bit integer library, such as Intel MKL. 
+
+- In case of an `fpm` build, 64-bit integer linear algebra support is given via branch `stdlib-fpm-ilp64`:
+  ```toml
+  [dependencies]
+  stdlib = { git="https://github.com/fortran-lang/stdlib", branch="stdlib-fpm-ilp64", preprocess.cpp.macros=["STDLIB_EXTERNAL_BLAS_I64", "STDLIB_EXTERNAL_LAPACK"] }
+  ```
+
 ## Contributing
 
 * [Guidelines](CONTRIBUTING.md)

config/CMakeLists.txt

@@ -39,6 +39,11 @@ if (NOT DEFINED WITH_XDP)
   )
   set(WITH_XDP ${WITH_XDP} PARENT_SCOPE)
 endif()
+# Check if WITH_ILP64 is defined; if not, set it to FALSE
+if (NOT DEFINED WITH_ILP64)
+  set(WITH_ILP64 FALSE)
+  set(WITH_ILP64 ${WITH_ILP64} PARENT_SCOPE)
+endif()
 
 # Export a pkg-config file
 configure_file(

config/cmake/Findtest-drive.cmake

@@ -123,7 +123,7 @@ foreach(method ${${_pkg}_FIND_METHOD})
 
       # We need the module directory in the subproject before we finish the configure stage
       if(NOT EXISTS "${${_pkg}_BINARY_DIR}/include")
-        make_directory("${${_pkg}_BINARY_DIR}/include")
+        file(MAKE_DIRECTORY "${${_pkg}_BINARY_DIR}/include")
       endif()
 
       break()
@@ -147,7 +147,7 @@ foreach(method ${${_pkg}_FIND_METHOD})
     FetchContent_GetProperties("${_lib}" SOURCE_DIR "${_pkg}_SOURCE_DIR")
     FetchContent_GetProperties("${_lib}" BINARY_DIR "${_pkg}_BINARY_DIR")
     if(NOT EXISTS "${${_pkg}_BINARY_DIR}/include")
-      make_directory("${${_pkg}_BINARY_DIR}/include")
+      file(MAKE_DIRECTORY "${${_pkg}_BINARY_DIR}/include")
     endif()
 
     break()

config/fypp_deployment.py

@@ -42,6 +42,8 @@ def pre_process_fypp(args):
         kwd.append("-DWITH_QP=True")
     if args.with_xdp:
         kwd.append("-DWITH_XDP=True")
+    if args.with_ilp64:
+        kwd.append("-DWITH_ILP64=True")
 
     optparser = fypp.get_option_parser()
     options, leftover = optparser.parse_args(args=kwd)
@@ -78,32 +80,38 @@ def process_f(file):
     return
 
 
-def deploy_stdlib_fpm():
+def deploy_stdlib_fpm(with_ilp64):
     """create the stdlib-fpm folder for backwards compatibility (to be deprecated)
     """
     import shutil
     prune=(
         "test_hash_functions.f90",
         "f18estop.f90",
     )
-    if not os.path.exists('stdlib-fpm'+os.sep+'src'):
-        os.makedirs('stdlib-fpm'+os.sep+'src')
-    if not os.path.exists('stdlib-fpm'+os.sep+'test'):
-        os.makedirs('stdlib-fpm'+os.sep+'test')
-    if not os.path.exists('stdlib-fpm'+os.sep+'example'):
-        os.makedirs('stdlib-fpm'+os.sep+'example')
+    
+    if with_ilp64:
+        base_folder = 'stdlib-fpm-ilp64'
+    else:
+        base_folder = 'stdlib-fpm'        
+
+    if not os.path.exists(base_folder+os.sep+'src'):
+        os.makedirs(base_folder+os.sep+'src')
+    if not os.path.exists(base_folder+os.sep+'test'):
+        os.makedirs(base_folder+os.sep+'test')
+    if not os.path.exists(base_folder+os.sep+'example'):
+        os.makedirs(base_folder+os.sep+'example')
 
     def recursive_copy(folder):
         for root, _, files in os.walk(folder):
             for file in files:
                 if file not in prune:
-                    if file.endswith(".f90") or file.endswith(".F90") or file.endswith(".dat") or file.endswith(".npy"):
-                        shutil.copy2(os.path.join(root, file), 'stdlib-fpm'+os.sep+folder+os.sep+file)
+                    if file.endswith((".f90", ".F90", ".dat", ".npy", ".c")):
+                        shutil.copy2(os.path.join(root, file), base_folder+os.sep+folder+os.sep+file)
     recursive_copy('src')
     recursive_copy('test')
     recursive_copy('example')
     for file in ['.gitignore','fpm.toml','LICENSE','VERSION']:
-        shutil.copy2(file, 'stdlib-fpm'+os.sep+file)
+        shutil.copy2(file, base_folder+os.sep+file)
     return
 
 def fpm_build(args,unknown):
@@ -122,11 +130,11 @@ def fpm_build(args,unknown):
             flags= flags + unknown[idx+1]
     #==========================================
     # build with fpm
-    subprocess.run(["fpm build"]+
-                   [" --compiler "]+[FPM_FC]+
-                   [" --c-compiler "]+[FPM_CC]+
-                   [" --cxx-compiler "]+[FPM_CXX]+
-                   [" --flag "]+[flags], shell=True, check=True)
+    subprocess.run("fpm build"+
+                   " --compiler "+FPM_FC+
+                   " --c-compiler "+FPM_CC+
+                   " --cxx-compiler "+FPM_CXX+
+                   " --flag \"{}\"".format(flags), shell=True, check=True)
     return
 
 if __name__ == "__main__":
@@ -137,11 +145,12 @@ def fpm_build(args,unknown):
     parser.add_argument("--vpatch", type=int, default=0, help="Project Version Patch")
 
     parser.add_argument("--njob", type=int, default=4, help="Number of parallel jobs for preprocessing")
-    parser.add_argument("--maxrank",type=int, default=7, help="Set the maximum allowed rank for arrays")
+    parser.add_argument("--maxrank",type=int, default=4, help="Set the maximum allowed rank for arrays")
     parser.add_argument("--with_qp",action='store_true', help="Include WITH_QP in the command")
     parser.add_argument("--with_xdp",action='store_true', help="Include WITH_XDP in the command")
+    parser.add_argument("--with_ilp64",action='store_true', help="Include WITH_ILP64 to build 64-bit integer BLAS/LAPACK")
     parser.add_argument("--lnumbering",action='store_true', help="Add line numbering in preprocessed files")
-    parser.add_argument("--deploy_stdlib_fpm",action='store_true', help="create the stdlib-fpm folder")
+    parser.add_argument("--deploy_stdlib_fpm",action='store_true', help="create the stdlib-fpm folder")    
     # external libraries arguments
     parser.add_argument("--build", action='store_true', help="Build the project")
 
@@ -158,8 +167,8 @@ def fpm_build(args,unknown):
     # pre process the meta programming fypp files
     pre_process_fypp(args)
     if args.deploy_stdlib_fpm:
-        deploy_stdlib_fpm()
+        deploy_stdlib_fpm(args.with_ilp64)
     #==========================================
     # build using fpm
     if args.build:
-        fpm_build(args,unknown)
+        fpm_build(args,unknown)

config/template.cmake

@@ -3,6 +3,7 @@
 set("@PROJECT_NAME@_WITH_CBOOL" @WITH_CBOOL@)
 set("@PROJECT_NAME@_WITH_QP" @WITH_QP@)
 set("@PROJECT_NAME@_WITH_XDP" @WITH_XDP@)
+set("@PROJECT_NAME@_WITH_ILP64" @WITH_ILP64@)
 
 if(NOT TARGET "@PROJECT_NAME@::@PROJECT_NAME@")
   include("${CMAKE_CURRENT_LIST_DIR}/@PROJECT_NAME@-targets.cmake")