Merge branch 'master' into add_close

Author: zoziha

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,4 @@
+<!--
+Thank you for contributing to stdlib.
+To help us get your pull request merged more quickly, please consider reviewing any of the already open pull requests.
+-->

.github/workflows/CI.yml

@@ -21,9 +21,18 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest]
         gcc_v: [9, 10, 11] # Version of GFortran we want to use.
+        build: [cmake]
+        include:
+          - os: ubuntu-latest
+            gcc_v: 10
+            build: cmake-inline
+          - os: ubuntu-latest
+            gcc_v: 10
+            build: make
     env:
       FC: gfortran-${{ matrix.gcc_v }}
       GCC_V: ${{ matrix.gcc_v }}
+      BUILD_DIR: ${{ matrix.build == 'cmake' && 'build' || '.' }}
 
     steps:
     - name: Checkout code
@@ -58,39 +67,38 @@ jobs:
           brew link gcc@${GCC_V}
 
     - name: Configure with CMake
+      if: ${{ contains(matrix.build, 'cmake') }}
       run: >-
         cmake -Wdev
         -DCMAKE_BUILD_TYPE=Release
         -DCMAKE_MAXIMUM_RANK:String=4
         -DCMAKE_INSTALL_PREFIX=$PWD/_dist
-        -S . -B build
+        -S . -B ${{ env.BUILD_DIR }}
 
     - name: Build and compile
-      run: cmake --build build --parallel
+      if: ${{ contains(matrix.build, 'cmake') }}
+      run: cmake --build ${{ env.BUILD_DIR }} --parallel
 
     - name: catch build fail
-      run: cmake --build build --verbose --parallel 1
-      if: failure()
+      run: cmake --build ${{ env.BUILD_DIR }} --verbose --parallel 1
+      if: ${{ failure() && contains(matrix.build, 'cmake') }}
 
     - name: test
-      run: ctest --test-dir build --parallel --output-on-failure
+      if: ${{ contains(matrix.build, 'cmake') }}
+      run: ctest --test-dir ${{ env.BUILD_DIR }} --parallel --output-on-failure
 
     - name: Install project
-      run: cmake --install build
-
-    - name: Test in-tree builds
-      if: contains( matrix.gcc_v, '10') # Only test one compiler on each platform
-      run: |
-          cmake -DCMAKE_MAXIMUM_RANK=4 .
-          cmake --build .
-          cmake --build . --target test
+      if: ${{ contains(matrix.build, 'cmake') }}
+      run: cmake --install ${{ env.BUILD_DIR }}
 
     - name: Test manual makefiles
-      if: contains(matrix.os, 'ubuntu') && contains(matrix.gcc_v, '10')
+      if: ${{ matrix.build == 'make' }}
       run: |
-        make -f Makefile.manual FYPPFLAGS="-DMAXRANK=4" -j
+        make -f Makefile.manual -j
         make -f Makefile.manual test
         make -f Makefile.manual clean
+      env:
+        FYPPFLAGS: "-DMAXRANK=4"
 
   intel-build:
     runs-on: ${{ matrix.os }}

API-doc-FORD-file.md

@@ -9,6 +9,9 @@ media_dir: doc/media
 fpp_extensions: fypp
 preprocess: true
 macro: MAXRANK=3
+       PROJECT_VERSION_MAJOR=0
+       PROJECT_VERSION_MINOR=0
+       PROJECT_VERSION_PATCH=0
 preprocessor: fypp
 display: public
          protected

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Unreleased
 
+Features available from the latest git source
+
+- new module `stdlib_distribution_uniform`
+  [#272](https://github.com/fortran-lang/stdlib/pull/272)
+- new module `stdlib_selection`
+  [#500](https://github.com/fortran-lang/stdlib/pull/500)
+  - new procedures `select`, `arg_select`
+- new module `stdlib_version`
+  [#579](https://github.com/fortran-lang/stdlib/pull/579)
+  - new procedure `get_stdlib_version`
+- new module `stdlib_io_npy`
+  [#581](https://github.com/fortran-lang/stdlib/pull/581)
+  - new procedures `save_npy`, `load_npy`
+
+Changes to existing modules
+
+- change in module `stdlib_math`
+  - `linspace` and `logspace` made pure
+    [#549](https://github.com/fortran-lang/stdlib/pull/549)
+- change in module `stdlib_string_type`
+  - `move` procedure made *pure*/*elemental*
+    [#562](https://github.com/fortran-lang/stdlib/pull/562)
+- support for quadruple precision made optional
+  [#565](https://github.com/fortran-lang/stdlib/pull/565)
+
 
 # Version 0.1.0
 

CMakeLists.txt

@@ -1,9 +1,17 @@
 cmake_minimum_required(VERSION 3.14.0)
 project(fortran_stdlib
         LANGUAGES Fortran
-        VERSION 0.1.0
         DESCRIPTION "Community driven and agreed upon de facto standard library for Fortran"
 )
+
+# Read version from file
+file(STRINGS "${PROJECT_SOURCE_DIR}/VERSION" PROJECT_VERSION)
+string(REPLACE "." ";" VERSION_LIST ${PROJECT_VERSION})
+list(GET VERSION_LIST 0 PROJECT_VERSION_MAJOR)
+list(GET VERSION_LIST 1 PROJECT_VERSION_MINOR)
+list(GET VERSION_LIST 2 PROJECT_VERSION_PATCH)
+unset(VERSION_LIST)
+
 enable_testing()
 
 # Follow GNU conventions for installation directories
@@ -24,7 +32,6 @@ if(CMAKE_Fortran_COMPILER_ID STREQUAL GNU)
   add_compile_options(-Wall)
   add_compile_options(-Wextra)
   add_compile_options(-Wimplicit-procedure)
-  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
   if(CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 11.0)
@@ -55,7 +62,7 @@ endif()
 # --- find preprocessor
 find_program(FYPP fypp)
 if(NOT FYPP)
-  message(FATAL_ERROR "Preprocessor fypp not found!")
+  message(FATAL_ERROR "Preprocessor fypp not found! Please install fypp following the instructions in https://fypp.readthedocs.io/en/stable/fypp.html#installing")
 endif()
 
 add_subdirectory(src)

CONTRIBUTING.md

@@ -89,6 +89,8 @@ You are welcome to propose changes to the workflow by
 * Smaller PRs are better than large PRs, and will lead to a shorter review and
   merge cycle.
 * Add tests for your feature or bug fix to be sure that it stays functional and useful.
+* Include new features and changes in the
+  [CHANGELOG](https://github.com/fortran-lang/stdlib/blob/master/CHANGELOG.md)
 * Be open to constructive criticism and requests for improving your code.
 * Again, please follow the
   [Fortran stdlib style guide](https://github.com/fortran-lang/stdlib/blob/master/STYLE_GUIDE.md).

Makefile.manual

@@ -4,6 +4,12 @@ FC ?= gfortran
 FFLAGS ?= -Wall -Wextra -Wimplicit-interface -fPIC -g -fcheck=all
 FYPPFLAGS ?=
 
+VERSION := $(subst ., ,$(file < VERSION))
+FYPPFLAGS += \
+             -DPROJECT_VERSION_MAJOR=$(word 1,$(VERSION)) \
+             -DPROJECT_VERSION_MINOR=$(word 2,$(VERSION)) \
+             -DPROJECT_VERSION_PATCH=$(word 3,$(VERSION))
+
 export FC
 export FFLAGS
 export FYPPFLAGS

VERSION

@@ -0,0 +1 @@
+0.1.0

ci/fpm-deployment.sh

@@ -12,12 +12,17 @@ fypp="${FYPP:-$(which fypp)}"
 fyflags="${FYFLAGS:--DMAXRANK=4}"
 
 # Number of parallel jobs for preprocessing
-njob="$(nproc)"
+if [ $(uname) = "Darwin" ]; then
+  njob="$(sysctl -n hw.ncpu)"
+else
+  njob="$(nproc)"
+fi
 
 # Additional files to include
 include=(
   "ci/fpm.toml"
   "LICENSE"
+  "VERSION"
 )
 
 # Files to remove from collection
@@ -28,6 +33,11 @@ prune=(
   "$destdir/src/f18estop.f90"
 )
 
+major=$(cut -d. -f1 VERSION)
+minor=$(cut -d. -f2 VERSION)
+patch=$(cut -d. -f3 VERSION)
+fyflags="${fyflags} -DPROJECT_VERSION_MAJOR=${major} -DPROJECT_VERSION_MINOR=${minor} -DPROJECT_VERSION_PATCH=${patch}"
+
 mkdir -p "$destdir/src" "$destdir/test"
 
 # Preprocess stdlib sources

ci/fpm.toml

@@ -1,9 +1,10 @@
 name = "stdlib"
-version = "0.1.0"
+version = "VERSION"
 license = "MIT"
 author = "stdlib contributors"
 maintainer = "@fortran-lang/stdlib"
 copyright = "2019-2021 stdlib contributors"
 
 [dev-dependencies]
 test-drive.git = "https://github.com/fortran-lang/test-drive"
+test-drive.tag = "v0.4.0"

config/CMakeLists.txt

@@ -13,6 +13,24 @@ endif()
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH}" PARENT_SCOPE)
 
+# Check for available features
+# Note: users can overwrite the automatic check by setting the value at configure time
+include(CheckFortranSourceRuns)
+if (NOT DEFINED WITH_QP)
+  check_fortran_source_runs(
+    "if (selected_real_kind(33) == -1) stop 1; end"
+    WITH_QP
+  )
+  set(WITH_QP ${WITH_QP} PARENT_SCOPE)
+endif()
+if (NOT DEFINED WITH_XDP)
+  check_fortran_source_runs(
+    "if (any(selected_real_kind(18) == [-1, selected_real_kind(33)])) stop 1; end"
+    WITH_XDP
+  )
+  set(WITH_XDP ${WITH_XDP} PARENT_SCOPE)
+endif()
+
 # Export a pkg-config file
 configure_file(
   "${CMAKE_CURRENT_SOURCE_DIR}/template.pc"

config/cmake/Findtest-drive.cmake

@@ -136,7 +136,7 @@ foreach(method ${${_pkg}_FIND_METHOD})
     FetchContent_Declare(
       "${_lib}"
       GIT_REPOSITORY "${_url}"
-      GIT_TAG "HEAD"
+      GIT_TAG "v0.4.0"
       )
     FetchContent_MakeAvailable("${_lib}")
 

config/template.cmake

@@ -1,5 +1,8 @@
 @PACKAGE_INIT@
 
+set("@PROJECT_NAME@_WITH_QP" @WITH_QP@)
+set("@PROJECT_NAME@_WITH_XDP" @WITH_XDP@)
+
 if(NOT TARGET "@PROJECT_NAME@::@PROJECT_NAME@")
   include("${CMAKE_CURRENT_LIST_DIR}/@[email protected]")
 endif()

doc/specs/index.md

@@ -28,6 +28,7 @@ This is and index/directory of the specifications (specs) for each new module/fe
  - [string\_type](./stdlib_string_type.html) - Basic string support
  - [strings](./stdlib_strings.html) - String handling and manipulation routines
  - [stringlist_type](./stdlib_stringlist_type.html) - 1-Dimensional list of strings
+ - [version](./stdlib_version.html) - Version information
 
 ## Released/Stable Features & Modules
 

doc/specs/stdlib_io.md

@@ -36,7 +36,7 @@ program demo_loadtxt
     use stdlib_io, only: loadtxt
     implicit none
     real, allocatable :: x(:,:)
-    call loadtxt('example.dat', x) 
+    call loadtxt('example.dat', x)
 end program demo_loadtxt
 ```
 
@@ -128,6 +128,98 @@ program demo_savetxt
     use stdlib_io, only: savetxt
     implicit none
     real :: x(3,2) = 1
-    call savetxt('example.dat', x) 
+    call savetxt('example.dat', x)
 end program demo_savetxt
 ```
+
+
+## `load_npy`
+
+### Status
+
+Experimental
+
+### Description
+
+Loads an `array` from a npy formatted binary file.
+
+### Syntax
+
+`call [[stdlib_io_npy(module):load_npy(interface)]](filename, array[, iostat][, iomsg])`
+
+### Arguments
+
+`filename`: Shall be  a character expression containing the file name from which to load the `array`.
+            This argument is `intent(in)`.
+
+`array`: Shall be an allocatable array of any rank of type `real`, `complex` or `integer`.
+         This argument is `intent(out)`.
+
+`iostat`: Default integer, contains status of loading to file, zero in case of success.
+          It is an optional argument, in case not present the program will halt for non-zero status.
+          This argument is `intent(out)`.
+
+`iomsg`: Deferred length character value, contains error message in case `iostat` is non-zero.
+         It is an optional argument, error message will be dropped if not present.
+         This argument is `intent(out)`.
+
+### Return value
+
+Returns an allocated `array` with the content of `filename` in case of success.
+
+### Example
+
+```fortran
+program demo_loadnpy
+    use stdlib_io_npy, only: load_npy
+    implicit none
+    real, allocatable :: x(:,:)
+    call loadtxt('example.npy', x)
+end program demo_loadnpy
+```
+
+
+## `save_npy`
+
+### Status
+
+Experimental
+
+### Description
+
+Saves an `array` into a npy formatted binary file.
+
+### Syntax
+
+`call [[stdlib_io_npy(module):save_npy(interface)]](filename, array[, iostat][, iomsg])`
+
+### Arguments
+
+`filename`: Shall be  a character expression containing the name of the file that will contain the `array`.
+            This argument is `intent(in)`.
+
+`array`: Shall be an array of any rank of type `real`, `complex` or `integer`.
+         This argument is `intent(in)`.
+
+`iostat`: Default integer, contains status of saving to file, zero in case of success.
+          It is an optional argument, in case not present the program will halt for non-zero status.
+          This argument is `intent(out)`.
+
+`iomsg`: Deferred length character value, contains error message in case `iostat` is non-zero.
+         It is an optional argument, error message will be dropped if not present.
+         This argument is `intent(out)`.
+
+### Output
+
+Provides a npy file called `filename` that contains the rank-2 `array`.
+
+### Example
+
+```fortran
+program demo_savenpy
+    use stdlib_io_npy, only: save_npy
+    implicit none
+    real :: x(3,2) = 1
+    call save_npy('example.npy', x)
+end program demo_savenpy
+```