Merge pull request #22 from fortran-lang/master

merge

Author: Jim-215-Fisher

.github/workflows/CI.yml

@@ -3,7 +3,6 @@ name: CI
 on: [push, pull_request]
 
 env:
-  CI: "ON" # We can detect this in the build system and other vendors implement it
   CMAKE_BUILD_PARALLEL_LEVEL: "2" # 2 cores on each GHA VM, enable parallel builds
   CTEST_OUTPUT_ON_FAILURE: "ON" # This way we don't need a flag to ctest
   CTEST_PARALLEL_LEVEL: "2"
@@ -21,14 +20,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        gcc_v: [7, 8, 9, 10] # Version of GFortran we want to use.
+        gcc_v: [9, 10, 11] # Version of GFortran we want to use.
     env:
       FC: gfortran-${{ matrix.gcc_v }}
       GCC_V: ${{ matrix.gcc_v }}
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
 
     - name: Set up Python 3.x
       uses: actions/setup-python@v1 # Use pip to install latest CMake, & FORD/Jin2For, etc.
@@ -62,20 +61,19 @@ jobs:
       run: >-
         cmake -Wdev
         -DCMAKE_BUILD_TYPE=Release
-        -DCMAKE_MAXIMUM_RANK=4
+        -DCMAKE_MAXIMUM_RANK:String=4
         -DCMAKE_INSTALL_PREFIX=$PWD/_dist
         -S . -B build
 
     - name: Build and compile
-      run: cmake --build build
+      run: cmake --build build --parallel
 
     - name: catch build fail
       run: cmake --build build --verbose --parallel 1
       if: failure()
 
     - name: test
-      run: ctest --parallel --output-on-failure
-      working-directory: build
+      run: ctest --test-dir build --parallel --output-on-failure
 
     - name: Install project
       run: cmake --install build
@@ -110,7 +108,7 @@ jobs:
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
 
     - name: Set up Python 3.x
       uses: actions/setup-python@v1
@@ -179,7 +177,7 @@ jobs:
       run: >-
          cmake -Wdev
          -DCMAKE_BUILD_TYPE=Release
-         -DCMAKE_MAXIMUM_RANK=4
+         -DCMAKE_MAXIMUM_RANK:String=4
          -DCMAKE_INSTALL_PREFIX=$PWD/_dist
          -S . -B build
 

.github/workflows/PR-review.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code.
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
       - name: misspell
         uses: reviewdog/action-misspell@v1
         with:

.github/workflows/ci_windows.yml

@@ -3,45 +3,10 @@ name: CI_windows
 on: [push, pull_request]
 
 env:
-  CI: "ON"
   CTEST_TIME_TIMEOUT: "5"  # some failures hang forever
+  CMAKE_GENERATOR: Ninja
 
 jobs:
-  Build:
-    runs-on: windows-latest
-    strategy:
-      fail-fast: false
-
-    steps:
-    - uses: actions/checkout@v1
-
-    - name: Install fypp
-      run: pip install fypp
-
-    - run: cmake -G "MinGW Makefiles" -DCMAKE_SH="CMAKE_SH-NOTFOUND" -Wdev -B build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_Fortran_FLAGS_DEBUG="-Wall -Wextra -Wimplicit-interface -fPIC -g -fcheck=all -fbacktrace" -DCMAKE_MAXIMUM_RANK=4
-
-      env:
-        FC: gfortran
-        CC: gcc
-        CXX: g++
-
-    - name: CMake build
-      run: cmake --build build --parallel
-
-    - name: catch build fail
-      run: cmake --build build --verbose --parallel 1
-      if: failure()
-
-    - name: CTest
-      run: ctest --output-on-failure --parallel -V -LE quadruple_precision
-      working-directory: build
-
-    - uses: actions/upload-artifact@v1
-      if: failure()
-      with:
-        name: WindowsCMakeTestlog
-        path: build/Testing/Temporary/LastTest.log
-
   msys2-build:
     runs-on: windows-latest
     strategy:
@@ -93,13 +58,12 @@ jobs:
       run: pip install fypp
 
     - run: >-
-        cmake -G Ninja
-        -DCMAKE_SH="CMAKE_SH-NOTFOUND"
+        cmake
         -Wdev
         -B build
         -DCMAKE_BUILD_TYPE=Debug
         -DCMAKE_Fortran_FLAGS_DEBUG="-Wall -Wextra -Wimplicit-interface -fPIC -g -fcheck=all -fbacktrace"
-        -DCMAKE_MAXIMUM_RANK=4
+        -DCMAKE_MAXIMUM_RANK:String=4
         -DCMAKE_INSTALL_PREFIX=$PWD/_dist
       env:
         FC: gfortran
@@ -114,8 +78,7 @@ jobs:
       if: failure()
 
     - name: CTest
-      run: ctest --output-on-failure --parallel -V -LE quadruple_precision
-      working-directory: build
+      run: ctest --test-dir build --output-on-failure --parallel -V -LE quadruple_precision
 
     - uses: actions/upload-artifact@v1
       if: failure()

CMakeLists.txt

@@ -16,6 +16,9 @@ add_subdirectory(config)
 
 # --- compiler options
 if(CMAKE_Fortran_COMPILER_ID STREQUAL GNU)
+  if(CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 9.0)
+    message(FATAL_ERROR "GCC Version 9 or newer required")
+  endif()
   add_compile_options(-fimplicit-none)
   add_compile_options(-ffree-line-length-132)
   add_compile_options(-Wall)
@@ -24,32 +27,29 @@ if(CMAKE_Fortran_COMPILER_ID STREQUAL GNU)
   add_compile_options(-Wconversion-extra)
   # -pedantic-errors triggers a false positive for optional arguments of elemental functions,
   # see test_optval and https://gcc.gnu.org/bugzilla/show_bug.cgi?id=95446
-  add_compile_options(-pedantic-errors)
-  if(CMAKE_Fortran_COMPILER_VERSION VERSION_GREATER_EQUAL 8.0)
-    add_compile_options(-std=f2018)
-  else()
-    add_compile_options(-std=f2008ts)
+  if(CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 11.0)
+    add_compile_options(-pedantic-errors)
   endif()
-elseif(CMAKE_Fortran_COMPILER_ID STREQUAL Intel)
-  add_compile_options(-warn declarations,general,usage,interfaces,unused)
-  if(CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 18.0)
-    add_compile_options(-stand f15)
+  add_compile_options(-std=f2018)
+elseif(CMAKE_Fortran_COMPILER_ID MATCHES "^Intel")
+  if(WIN32)
+    add_compile_options(/warn:declarations,general,usage,interfaces,unused)
+    add_compile_options(/stand:f18)
   else()
+    add_compile_options(-warn declarations,general,usage,interfaces,unused)
     add_compile_options(-stand f18)
   endif()
-elseif(CMAKE_Fortran_COMPILER_ID STREQUAL PGI)
-  add_compile_options(-Mdclchk)
 endif()
 
 # --- compiler feature checks
 include(CheckFortranSourceCompiles)
 include(CheckFortranSourceRuns)
-check_fortran_source_runs("i=0; error stop i; end" f18errorstop SRC_EXT f90)
+check_fortran_source_runs("i=0; error stop i; end" f18errorstop)
 check_fortran_source_compiles("real, allocatable :: array(:, :, :, :, :, :, :, :, :, :); end" f03rank SRC_EXT f90)
 check_fortran_source_runs("use, intrinsic :: iso_fortran_env, only : real128; real(real128) :: x; x = x+1; end" f03real128)
 
-if(DEFINED CMAKE_MAXIMUM_RANK)
-  set(CMAKE_MAXIMUM_RANK ${CMAKE_MAXIMUM_RANK})
+if(NOT DEFINED CMAKE_MAXIMUM_RANK)
+  set(CMAKE_MAXIMUM_RANK 4 CACHE STRING "Maximum array rank for generated procedures")
 endif()
 
 # --- find preprocessor

README.md

@@ -87,9 +87,8 @@ The following combinations are tested on the default branch of stdlib:
 
 Name | Version | Platform | Architecture
 --- | --- | --- | ---
-GCC Fortran | 7, 8, 9, 10 | Ubuntu 18.04 | x86_64
-GCC Fortran | 7, 8, 9, 10 | MacOS Catalina 10.15 | x86_64
-GCC Fortran | 8 | Windows Server 2019 | x86_64
+GCC Fortran | 9, 10, 11 | Ubuntu 20.04 | x86_64
+GCC Fortran | 9, 10, 11 | MacOS Catalina 10.15 | x86_64
 GCC Fortran (MSYS) | 10 | Windows Server 2019 | x86_64
 GCC Fortran (MinGW) | 10 | Windows Server 2019 | x86_64, i686
 Intel oneAPI classic | 2021.1 | Ubuntu 20.04 | x86_64
@@ -106,7 +105,7 @@ A list of tested compilers which are currently not working and the respective is
 
 Name | Version | Platform | Architecture | Status
 --- | --- | --- | --- | ---
-GCC Fortran | 7.4 | Windows 10 | i686 | [#296](https://github.com/fortran-lang/stdlib/issues/296)
+GCC Fortran | <9 | any | any | [#296](https://github.com/fortran-lang/stdlib/issues/296), [#430](https://github.com/fortran-lang/stdlib/pull/430)
 NVIDIA HPC SDK | 20.7, 20.9, 20.11 | Manjaro Linux 20 | x86_64 | [#107](https://github.com/fortran-lang/stdlib/issues/107)
 NAG | 7.0 | RHEL | x86_64 | [#108](https://github.com/fortran-lang/stdlib/issues/108)
 Intel Parallel Studio XE | 16, 17, 18 | OpenSUSE | x86_64 | failed to compile
@@ -128,15 +127,16 @@ Important options are
 - `-G Ninja` to use the Ninja backend instead of the default Make backend. Other build backends are available with a similar syntax.
 - `-DCMAKE_INSTALL_PREFIX` is used to provide the install location for the library.
 - `-DCMAKE_MAXIMUM_RANK` the maximum array rank procedures should be generated for.
-  The default is 15 for Fortran 2003 compliant compilers, otherwise 7 for compilers not supporting Fortran 2003 completely yet.
+  The default value is chosen as 4.
+  The maximum is 15 for Fortran 2003 compliant compilers, otherwise 7 for compilers not supporting Fortran 2003 completely yet.
   The minimum required rank to compile this project is 4.
   Compiling with maximum rank 15 can be resource intensive and requires at least 16 GB of memory to allow parallel compilation or 4 GB memory for sequential compilation.
 - `-DBUILD_SHARED_LIBS` set to `on` in case you want link your application dynamically against the standard library (default: `off`).
 
 For example, to configure a build using the Ninja backend and generating procedures up to rank 7, which is installed to your home directory use
 
 ```sh
-cmake -B build -G Ninja -DCMAKE_MAXIMUM_RANK=7 -DCMAKE_INSTALL_PREFIX=$HOME/.local
+cmake -B build -G Ninja -DCMAKE_MAXIMUM_RANK:String=7 -DCMAKE_INSTALL_PREFIX=$HOME/.local
 ```
 
 To build the standard library run

config/CMakeLists.txt

@@ -1,5 +1,11 @@
 # SPDX-Identifier: MIT
 
+option(
+  CMAKE_INSTALL_MODULEDIR
+  "Directory in prefix to install generated module files"
+  "${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}/${CMAKE_Fortran_COMPILER_ID}-${CMAKE_Fortran_COMPILER_VERSION}"
+)
+
 # Export a pkg-config file
 configure_file(
   "${CMAKE_CURRENT_SOURCE_DIR}/template.pc"

config/template.pc

@@ -1,9 +1,10 @@
 prefix=@CMAKE_INSTALL_PREFIX@
 libdir=${prefix}/@CMAKE_INSTALL_LIBDIR@
 includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@
+moduledir=${prefix}/@CMAKE_INSTALL_MODULEDIR@
 
 Name: @PROJECT_NAME@
 Description: @PROJECT_DESCRIPTION@
 Version: @PROJECT_VERSION@
 Libs: -L${libdir} -l@PROJECT_NAME@
-Cflags: -I${includedir}
+Cflags: -I${includedir} -I${moduledir}

doc/specs/index.md

@@ -15,19 +15,18 @@ This is and index/directory of the specifications (specs) for each new module/fe
  - [bitsets](./stdlib_bitsets.html) - Bitset data types and procedures
  - [error](./stdlib_error.html) - Catching and handling errors
  - [IO](./stdlib_io.html) - Input/output helper & convenience
+ - [kinds](./stdlib_kinds.html) - Kind parameters
  - [linalg](./stdlib_linalg.html) - Linear Algebra
  - [logger](./stdlib_logger.html) - Runtime logging system
+ - [math](./stdlib_math.html) - General purpose mathematical functions
  - [optval](./stdlib_optval.html) - Fallback value for optional arguments
  - [quadrature](./stdlib_quadrature.html) - Numerical integration
+ - [sorting](./stdlib_sorting.html) - Sorting of rank one arrays
  - [stats](./stdlib_stats.html) - Descriptive Statistics
  - [stats_distribution_PRNG](./stdlib_stats_distribution_PRNG.html) - Probability Distributions random number generator
  - [string\_type](./stdlib_string_type.html) - Basic string support
  - [strings](./stdlib_strings.html) - String handling and manipulation routines
 
-## Missing specs
-
- - [kinds](https://github.com/fortran-lang/stdlib/blob/master/src/stdlib_kinds.f90)
-
 ## Released/Stable Features & Modules
 
  - (None yet)

doc/specs/stdlib_kinds.md

@@ -0,0 +1,59 @@
+---
+title: kinds
+---
+
+# The `stdlib_kinds` module
+
+[TOC]
+
+## Introduction
+
+The `stdlib_kinds` module provides kind parameters for the Fortran intrinsic data types,
+*integer*, *logical*, *real*, and *complex*.
+
+
+## Constants provided by `stdlib_kinds`
+
+### `sp`
+
+Alias for intrinsic named constant `real32` imported from `iso_fortran_env`.
+
+
+### `dp`
+
+Alias for intrinsic named constant `real64` imported from `iso_fortran_env`.
+
+
+### `qp`
+
+Alias for intrinsic named constant `real128` imported from `iso_fortran_env`.
+
+
+### `int8`
+
+Reexported intrinsic named constant `int8` from `iso_fortran_env`.
+
+
+### `int16`
+
+Reexported intrinsic named constant `int16` from `iso_fortran_env`.
+
+
+### `int32`
+
+Reexported intrinsic named constant `int32` from `iso_fortran_env`.
+
+
+### `int64`
+
+Reexported intrinsic named constant `int64` from `iso_fortran_env`.
+
+
+### `lk`
+
+Kind parameter of the default logical data type.
+
+
+### `c_bool`
+
+Reexported intrinsic named constant `c_bool` from `iso_c_binding`.

doc/specs/stdlib_linalg.md

@@ -168,3 +168,41 @@ program demo_trace
     print *, trace(A) ! 1 + 5 + 9
 end program demo_trace
 ```
+
+## `outer_product` - Computes the outer product of two vectors
+
+### Status
+
+Experimental
+
+### Description
+
+Computes the outer product of two vectors
+
+### Syntax
+
+`d = [[stdlib_linalg(module):outer_product(interface)]](u, v)`
+
+### Arguments
+
+`u`: Shall be a rank-1 array
+
+`v`: Shall be a rank-1 array
+
+### Return value
+
+Returns a rank-2 array equal to `u v^T` (where `u, v` are considered column vectors). The shape of the returned array is `[size(u), size(v)]`.
+
+### Example
+
+```fortran
+program demo_outer_product
+    use stdlib_linalg, only: outer_product
+    implicit none
+    real, allocatable :: A(:,:), u(:), v(:)
+    u = [1., 2., 3. ]
+    v = [3., 4.]
+    A = outer_product(u,v)
+    !A = reshape([3., 6., 9., 4., 8., 12.], [3,2])
+end program demo_outer_product
+```