Merge branch 'master' into hash_functions2

Author: jvdp1

.github/workflows/CI.yml

@@ -45,10 +45,6 @@ jobs:
       with:
         python-version: 3.x
 
-    - name: Install CMake Linux
-      if: contains(matrix.os, 'ubuntu')
-      run: ci/install_cmake.sh
-
     - name: Install fypp
       run: pip install --upgrade fypp
 
@@ -88,7 +84,12 @@ jobs:
 
     - name: test
       if: ${{ contains(matrix.build, 'cmake') }}
-      run: ctest --test-dir ${{ env.BUILD_DIR }} --parallel --output-on-failure
+      run: >-
+        ctest
+        --test-dir ${{ env.BUILD_DIR }}
+        --parallel
+        --output-on-failure
+        --no-tests=error
 
     - name: Install project
       if: ${{ contains(matrix.build, 'cmake') }}
@@ -101,7 +102,7 @@ jobs:
         make -f Makefile.manual test
         make -f Makefile.manual clean
       env:
-        FYPPFLAGS: "-DMAXRANK=4"
+        ADD_FYPPFLAGS: "-DMAXRANK=4"
 
   intel-build:
     runs-on: ${{ matrix.os }}
@@ -130,10 +131,6 @@ jobs:
       with:
         python-version: 3.x
 
-    - name: Install CMake Linux
-      if: contains(matrix.os, 'ubuntu')
-      run: ci/install_cmake.sh
-
     - name: Prepare for cache restore (OSX)
       if: contains(matrix.os, 'macos')
       run: |
@@ -205,7 +202,7 @@ jobs:
       if: failure()
 
     - name: test
-      run: ctest --parallel --output-on-failure
+      run: ctest --parallel --output-on-failure --no-tests=error
       working-directory: build
 
     - name: Install project

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
 

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

@@ -1,15 +1,17 @@
 # Fortran stdlib Makefile
 
 FC ?= gfortran
-FFLAGS ?= -Wall -Wextra -Wimplicit-interface -fPIC -g -fcheck=all -fno-range-check
-FYPPFLAGS ?=
+FFLAGS ?= -Wall -Wextra -Wimplicit-interface -fPIC -g -fcheck=all  -fno-range-check
+ADD_FYPPFLAGS ?=
 
 VERSION := $(subst ., ,$(file < VERSION))
-FYPPFLAGS += \
+VERSION_FYPPFLAGS += \
              -DPROJECT_VERSION_MAJOR=$(word 1,$(VERSION)) \
              -DPROJECT_VERSION_MINOR=$(word 2,$(VERSION)) \
              -DPROJECT_VERSION_PATCH=$(word 3,$(VERSION))
 
+FYPPFLAGS := $(ADD_FYPPFLAGS) $(VERSION_FYPPFLAGS)
+
 export FC
 export FFLAGS
 export FYPPFLAGS

README.md

@@ -176,15 +176,15 @@ Alternatively, you can build using provided Makefiles:
 make -f Makefile.manual
 ```
 
-You can limit the maximum rank by setting ``-DMAXRANK=<num>`` in the ``FYPPFLAGS`` environment variable (which can reduce the compilation time):
+You can limit the maximum rank by setting ``-DMAXRANK=<num>`` in the ``ADD_FYPPFLAGS`` environment variable (which can reduce the compilation time):
 
 ```sh
-make -f Makefile.manual FYPPFLAGS=-DMAXRANK=4
+make -f Makefile.manual ADD_FYPPFLAGS=-DMAXRANK=4
 ```
 
 You can also specify the compiler and compiler-flags by setting the ``FC`` and ``FFLAGS`` environmental variables. Among other things, this facilitates use of compiler optimizations that are not specified in the Makefile.manual defaults.
 ```sh
-make -f Makefile.manual FYPPFLAGS=-DMAXRANK=4 FC=gfortran FFLAGS="-O3 -flto"
+make -f Makefile.manual ADD_FYPPFLAGS=-DMAXRANK=4 FC=gfortran FFLAGS="-O3 -flto"
 ```
 
 ### Build with [fortran-lang/fpm](https://github.com/fortran-lang/fpm)

ci/install_cmake.sh

@@ -27,6 +27,7 @@ This is and index/directory of the specifications (specs) for each new module/fe
  - [sorting](./stdlib_sorting.html) - Sorting of rank one arrays
  - [stats](./stdlib_stats.html) - Descriptive Statistics
  - [stats_distributions_uniform](./stdlib_stats_distribution_uniform.html) - Uniform Probability Distribution
+ - [stats_distributions_normal](./stdlib_stats_distribution_normal.html) - Normal Probability Distribution
  - [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

doc/specs/index.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
+```

doc/specs/stdlib_io.md

@@ -23,6 +23,7 @@ which implements selection algorithms.
 ## Overview of the module
 
 The module `stdlib_selection` defines two generic subroutines:
+
 * `select` is used to find the k-th smallest entry of an array. The input
 array is also modified in-place, and on return will be partially sorted
 such that `all(array(1:k) <= array(k)))`  and `all(array(k) <= array((k+1):size(array)))` is true.
@@ -159,7 +160,7 @@ Generic subroutine.
 
 `array` : shall be a rank one array of any of the types:
 `integer(int8)`, `integer(int16)`, `integer(int32)`, `integer(int64)`,
-`real(sp)`, `real(dp)`, `real(xdp), `real(qp)`. It is an `intent(in)` argument. On input it is
+`real(sp)`, `real(dp)`, `real(xdp)`, `real(qp)`. It is an `intent(in)` argument. On input it is
 the array in which we search for the k-th smallest entry.
 
 `indx`: shall be a rank one array with the same size as `array`, containing all integers
@@ -198,7 +199,7 @@ The code does not support `NaN` elements in `array`; it will run, but there is
 no consistent interpretation given to the order of `NaN` entries of `array`
 compared to other entries.
 
-While it is essential that that `indx` contains a permutation of the integers `1:size(array)`, 
+While it is essential that `indx` contains a permutation of the integers `1:size(array)`, 
 the code does not check for this. For example if `size(array) == 4`, then we could have 
 `indx = [4, 2, 1, 3]` or `indx = [1, 2, 3, 4]`, but not `indx = [2, 1, 2, 4]`. It is the user's
 responsibility to avoid such errors.

doc/specs/stdlib_selection.md

@@ -32,11 +32,11 @@ Generic subroutine
 
 ### Arguments
 
-`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`.
+`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument.
 
-`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`.
+`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. It is an `intent(in)` argument.
 
-`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`.
+`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. It is an `intent(in)` argument.
 
 ### Return value
 
@@ -93,13 +93,13 @@ Generic subroutine
 
 ### Arguments
 
-`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`.
+`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument.
 
-`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`.
+`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. It is an `intent(in)` argument.
 
-`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`.
+`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. It is an `intent(in)` argument.
 
-`corrected` (optional): Shall be a scalar of type `logical`. If `corrected` is `.true.` (default value), the sum is scaled with `n-1`. If `corrected` is `.false.`, then the sum is scaled with `n`.
+`corrected` (optional): Shall be a scalar of type `logical`. If `corrected` is `.true.` (default value), the sum is scaled with `n-1`. If `corrected` is `.false.`, then the sum is scaled with `n`. It is an `intent(in)` argument.
 
 ### Return value
 
@@ -148,11 +148,11 @@ Generic subroutine
 
 ### Arguments
 
-`array`: Shall be an array of type `integer`, `real`, or `complex`.
+`array`: Shall be an array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument.
 
-`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`.
+`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. It is an `intent(in)` argument.
 
-`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`.
+`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. It is an `intent(in)` argument.
 
 ### Return value
 
@@ -204,9 +204,9 @@ and if `n` is an odd number, the median is:
 median(array) = mean( array_sorted( floor( (n + 1) / 2.):floor( (n + 1) / 2.) + 1 ) )
 ```
 
-The current implementation is a quite naive implementation that relies on sorting
-the whole array, using the subroutine `[[stdlib_sorting(module):ord_sort(interface)]]`
-provided by the `[[stdlib_sorting(module)]]` module.
+The current implementation relies on a selection algorithm applied on a copy of
+the whole array, using the subroutine `[[stdlib_selection(module):select(interface)]]`
+provided by the `[[stdlib_selection(module)]]` module.
 
 ### Syntax
 
@@ -220,11 +220,11 @@ Generic subroutine
 
 ### Arguments
 
-`array`: Shall be an array of type `integer` or `real`.
+`array`: Shall be an array of type `integer` or `real`. It is an `intent(in)` argument.
 
-`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`.
+`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. It is an `intent(in)` argument.
 
-`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`.
+`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. It is an `intent(in)` argument.
 
 ### Return value
 
@@ -360,13 +360,13 @@ Generic subroutine
 
 ### Arguments
 
-`array`: Shall be an array of type `integer`, `real`, or `complex`.
+`array`: Shall be an array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument.
 
-`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`.
+`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. It is an `intent(in)` argument.
 
-`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`.
+`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. It is an `intent(in)` argument.
 
-`corrected` (optional): Shall be a scalar of type `logical`. If `corrected` is `.true.` (default value), the sum is scaled with `n-1`. If `corrected` is `.false.`, then the sum is scaled with `n`.
+`corrected` (optional): Shall be a scalar of type `logical`. If `corrected` is `.true.` (default value), the sum is scaled with `n-1`. If `corrected` is `.false.`, then the sum is scaled with `n`. It is an `intent(in)` argument.
 
 ### Return value