refactor: forlab_stats&mean

Author: zoziha

.gitattributes

@@ -0,0 +1,21 @@
+# Override syntax highlighting
+*.fypp linguist-language=fortran
+
+# Denote all files that are truly binary and should not be modified.
+*.mod binary
+*.smod binary
+*.o binary
+*.a binary
+*.so binary
+*.tar binary
+*.gz binary
+*.tgz binary
+
+# Prevent dev-ops files from making it into the release archives
+.gitattributes export-ignore
+.gitignore export-ignore
+codecov.yml export-ignore
+.github export-ignore
+
+# Perform substitutions when `git export`ing these files
+.VERSION export-subst 

src/forlab.fypp

@@ -566,6 +566,8 @@ module forlab
     end interface median
 
     interface mean
+        !! mean computes the mean value of an array.
+        !! ([Specification](../module/forlab_stats_mean.html))
         #:for k1, t1 in REAL_KINDS_TYPES
         ${t1}$ module function mean_1_${k1}$(x)
             ${t1}$, dimension(:), intent(in) :: x

src/forlab_stats.f90

@@ -0,0 +1,6 @@
+submodule(forlab) forlab_stats 
+    implicit none
+    
+contains
+    
+end submodule

src/forlab_mean.fypp renamed to src/forlab_stats_mean.fypp

@@ -1,8 +1,8 @@
 #:include 'common.fypp'
-submodule(forlab) forlab_mean
+submodule(forlab:forlab_stats) forlab_stats_mean
     !!## mean
     !! mean computes the mean value of an array.
-    !!
+    !!([Interface](../interface/mean.html))
     !!### Syntax
     !!    y = mean(x)
     !!    x = mean(A)

src/fpm/forlab.f90

@@ -1417,6 +1417,8 @@ end function matpow_qp
     end interface median
 
     interface mean
+        !! mean computes the mean value of an array.
+        !! ([Specification](../module/forlab_stats_mean.html))
         real(sp) module function mean_1_sp(x)
             real(sp), dimension(:), intent(in) :: x
         end function

src/fpm/forlab_stats.f90

@@ -0,0 +1,6 @@
+submodule(forlab) forlab_stats 
+    implicit none
+    
+contains
+    
+end submodule

src/fpm/forlab_mean.f90 renamed to src/fpm/forlab_stats_mean.f90

@@ -1,39 +1,35 @@
-submodule(forlab) forlab_mean
-    ! mean
-    !-----------------------------------------------------------------------
-    ! mean computes the mean value of an array.
-    !
-    ! Syntax
-    !-----------------------------------------------------------------------
-    ! y = mean(x)
-    ! x = mean(A)
-    ! x = mean(A, 1)
-    ! x = mean(A, 2)
-    !
-    ! Description
-    !-----------------------------------------------------------------------
-    ! y = mean(x) returns the mean value of the vector x.
-    !
-    ! x = mean(A) returns a dim2 vector with the mean values of each column
-    ! of matrix A.
-    !
-    ! x = mean(A, 1) (see x = mean(A)).
-    !
-    ! x = mean(A, 2) returns a dim1 vector with the mean values of each row
-    ! of matrix A.
-    !
-    ! Examples
-    !-----------------------------------------------------------------------
-    ! x = [ 1., 2., 3. ]
-    ! y = mean(x)
-    !     2.
-    !
-    ! A = reshape([ 1., 2., 3., 4., 5., 6., 7., 8., 9. ], [ 3, 3 ], &
-    !             order = [ 2, 1 ])
-    ! x = mean(A)
-    !     4.  5.  6.
-    ! x = mean(A, 2)
-    !     2.  5.  8.
+submodule(forlab:forlab_stats) forlab_stats_mean
+    !!## mean
+    !! mean computes the mean value of an array.
+    !!
+    !!### Syntax
+    !!    y = mean(x)
+    !!    x = mean(A)
+    !!    x = mean(A, 1)
+    !!    x = mean(A, 2)
+    !!
+    !!### Description
+    !! `y = mean(x)` returns the mean value of the vector `x`.
+    !!
+    !! `x = mean(A)` returns a `dim2` vector with the mean values of each column
+    !! of matrix A.
+    !!
+    !! `x = mean(A, 1)` (see `x = mean(A)`).
+    !!
+    !! `x = mean(A, 2)` returns a `dim1` vector with the mean values of each row
+    !! of matrix `A`.
+    !!
+    !!### Examples
+    !!    x = [ 1., 2., 3. ]
+    !!    y = mean(x)
+    !!        2.
+    !!
+    !!    A = reshape([ 1., 2., 3., 4., 5., 6., 7., 8., 9. ], [ 3, 3 ], &
+    !!                order = [ 2, 1 ])
+    !!    x = mean(A)
+    !!        4.  5.  6.
+    !!    x = mean(A, 2)
+    !!        2.  5.  8.
     use forlab_kinds
     implicit none