Merge branch 'dev-quadrature' of https://github.com/nshaffer/stdlib into dev-quadrature

Author: nshaffer

STYLE_GUIDE.md

@@ -29,7 +29,7 @@ This style guide is a living document and proposed changes may be adopted after
 By setting and following a convention for indentation and whitespace, code reviews and git-diffs can
 focus on the semantics of the proposed changes rather than style and formatting.
 
-* The body of every Fortran construct should be indented by __two (4) spaces__
+* The body of every Fortran construct should be indented by __four (4) spaces__
 * Line length *should be limited to 80 characters* and __must not exceed 132__
 * Please do not use <kbd>Tab</kbd> characters for indentation
 * Please remove trailing white space before committing code

src/CMakeLists.txt

@@ -3,8 +3,10 @@
 # Create a list of the files to be preprocessed
 set(fppFiles
     stdlib_experimental_io.fypp
+    stdlib_experimental_optval.fypp
     stdlib_experimental_stats.fypp
     stdlib_experimental_stats_mean.fypp
+    stdlib_experimental_stats_var.fypp
     stdlib_experimental_quadrature.fypp
     stdlib_experimental_quadrature_trapz.fypp
     stdlib_experimental_quadrature_simps.fypp
@@ -24,10 +26,8 @@ fypp_f90("${fyppFlags}" "${fppFiles}" outFiles)
 
 set(SRC
     stdlib_experimental_ascii.f90
-    stdlib_experimental_io.f90
     stdlib_experimental_error.f90
     stdlib_experimental_kinds.f90
-    stdlib_experimental_optval.f90
     stdlib_experimental_system.F90
     ${outFiles}
 )

src/Makefile.manual

@@ -5,7 +5,8 @@ SRC = stdlib_experimental_ascii.f90 \
       stdlib_experimental_kinds.f90 \
       f18estop.f90 \
       stdlib_experimental_stats.f90 \
-      stdlib_experimental_stats_mean.f90
+      stdlib_experimental_stats_mean.f90 \
+      stdlib_experimental_stats_var.f90
 
 LIB = libstdlib.a
 
@@ -42,6 +43,11 @@ stdlib_experimental_stats_mean.o: \
 	stdlib_experimental_optval.o \
 	stdlib_experimental_kinds.o \
 	stdlib_experimental_stats.o
+stdlib_experimental_stats_var.o: \
+	stdlib_experimental_optval.o \
+	stdlib_experimental_kinds.o \
+	stdlib_experimental_stats.o
 stdlib_experimental_io.f90: stdlib_experimental_io.fypp
 stdlib_experimental_stats.f90: stdlib_experimental_stats.fypp
 stdlib_experimental_stats_mean.f90: stdlib_experimental_stats_mean.fypp
+stdlib_experimental_stats_var.f90: stdlib_experimental_stats_var.fypp

src/common.fypp

@@ -9,6 +9,14 @@
 #! Collected (kind, type) tuples for real types
 #:set REAL_KINDS_TYPES = list(zip(REAL_KINDS, REAL_TYPES))
 
+#! Complex kinds to be considered during templating
+#:set CMPLX_KINDS = ["sp", "dp", "qp"]
+
+#! Complex types to be considere during templating
+#:set CMPLX_TYPES = ["complex({})".format(k) for k in CMPLX_KINDS]
+
+#! Collected (kind, type) tuples for complex types
+#:set CMPLX_KINDS_TYPES = list(zip(CMPLX_KINDS, CMPLX_TYPES))
 
 #! Integer kinds to be considered during templating
 #:set INT_KINDS = ["int8", "int16", "int32", "int64"]
@@ -90,4 +98,44 @@ ${prefix + joinstr.join([line.strip() for line in txt.split("\n")]) + suffix}$
 #:enddef
 
 
+#! Generates a routine name from a generic name, rank, type and kind
+#!
+#! Args:
+#!   gname (str): Generic name
+#!   rank (integer): Rank if exist
+#!   type (str): Type of the input
+#!   kind (str): kind of inputs variable
+#!   suffix (str): other identifier (could be used for output type/kind)
+#!
+#! Returns:
+#!   A string with a new name
+#!
+#:def rname(gname, rank, type, kind, suffix='')
+  $:"{0}_{1}_{2}{3}_{2}{3}".format(gname, rank, type[0], kind) if suffix == '' else "{0}_{1}_{2}{3}_{4}".format(gname, rank, type[0], kind, suffix)
+#:enddef
+
+
+#! Generates an array rank suffix for subarrays reducing the dimension
+#!
+#! Args:
+#!   rank (int): Rank of the original variable
+#!   selectors (array): Dimension and name of the variable(s)
+#!
+#! Returns:
+#!   Array rank suffix string enclosed in braces
+#!
+#! E.g.,
+#!   select_subarray(5 , [(4, 'i'), (5, 'j')])}$
+#!   -> (:, :, :, i, j)
+#!
+#:def select_subarray(rank, selectors)
+  #:assert rank > 0
+  #:set seldict = dict(selectors)
+  #:call join_lines(joinstr=", ", prefix="(", suffix=")")
+    #:for i in range(1, rank + 1)
+      $:seldict.get(i, ":")
+    #:endfor
+  #:endcall
+#:enddef
+
 #:endmute

src/stdlib_experimental_io.fypp

@@ -1,6 +1,6 @@
 #:include "common.fypp"
 
-#:set KINDS_TYPES = REAL_KINDS_TYPES + INT_KINDS_TYPES
+#:set KINDS_TYPES = REAL_KINDS_TYPES + INT_KINDS_TYPES + CMPLX_KINDS_TYPES
 
 module stdlib_experimental_io
 
@@ -18,21 +18,21 @@ module stdlib_experimental_io
   public :: parse_mode
 
   interface loadtxt
-    #:for k1, _ in KINDS_TYPES
-      module procedure loadtxt_${k1}$
+    #:for k1, t1 in KINDS_TYPES
+      module procedure loadtxt_${t1[0]}$${k1}$
     #:endfor
   end interface loadtxt
 
   interface savetxt
-    #:for k1, _ in KINDS_TYPES
-      module procedure savetxt_${k1}$
+    #:for k1, t1 in KINDS_TYPES
+      module procedure savetxt_${t1[0]}$${k1}$
     #:endfor
   end interface
 
 contains
 
   #:for k1, t1 in KINDS_TYPES
-    subroutine loadtxt_${k1}$(filename, d)
+    subroutine  loadtxt_${t1[0]}$${k1}$(filename, d)
       ! Loads a 2D array from a text file.
       !
       ! Arguments
@@ -58,7 +58,7 @@ contains
       !     ...
       !
       integer :: s
-      integer :: nrow,ncol,i
+      integer :: nrow, ncol, i
 
       s = open(filename)
 
@@ -74,12 +74,12 @@ contains
       end do
       close(s)
 
-    end subroutine loadtxt_${k1}$
+    end subroutine loadtxt_${t1[0]}$${k1}$
   #:endfor
 
 
   #:for k1, t1 in KINDS_TYPES
-    subroutine savetxt_${k1}$(filename, d)
+    subroutine savetxt_${t1[0]}$${k1}$(filename, d)
       ! Saves a 2D array into a text file.
       !
       ! Arguments
@@ -100,13 +100,13 @@ contains
         write(s, *) d(i, :)
       end do
       close(s)
-    end subroutine savetxt_${k1}$
+    end subroutine savetxt_${t1[0]}$${k1}$
   #:endfor
 
 
   integer function number_of_columns(s)
     ! determine number of columns
-    integer,intent(in)::s
+    integer,intent(in) :: s
 
     integer :: ios
     character :: c
@@ -126,23 +126,33 @@ contains
   end function number_of_columns
 
 
-  integer function number_of_rows_numeric(s)
+  integer function number_of_rows_numeric(s) result(nrows)
     ! determine number or rows
     integer,intent(in)::s
     integer :: ios
 
-    real::r
+    real :: r
+    complex :: z
 
     rewind(s)
-    number_of_rows_numeric = 0
+    nrows = 0
     do
       read(s, *, iostat=ios) r
       if (ios /= 0) exit
-      number_of_rows_numeric = number_of_rows_numeric + 1
+      nrows = nrows + 1
     end do
 
     rewind(s)
 
+    ! If there are no rows of real numbers, it may be that they are complex
+    if( nrows == 0) then
+      do
+        read(s, *, iostat=ios) z
+        if (ios /= 0) exit
+        nrows = nrows + 1
+      end do
+      rewind(s)
+    end if
   end function number_of_rows_numeric
 
 

src/stdlib_experimental_io.md

@@ -20,7 +20,7 @@ Loads a rank-2 `array` from a text file.
 
 `filename`: Shall be  a character expression containing the file name from which to load the rank-2 `array`.
 
-`array`: Shall be an allocatable rank-2 array of type `real` or `integer`.
+`array`: Shall be an allocatable rank-2 array of type `real`, `complex` or `integer`.
 
 ### Return value
 
@@ -104,7 +104,7 @@ Saves a rank-2 `array` into a text file.
 
 `filename`: Shall be  a character expression containing the name of the file that will contain the 2D `array`.
 
-`array`: Shall be a rank-2 array of type `real` or `integer`.
+`array`: Shall be a rank-2 array of type `real`, `complex` or `integer`.
 
 ### Output