Consistent lower-casing and imports.

loiseaujc · loiseaujc · commit 6777aa0ea272 · 2025-06-13T14:53:35.000+02:00
diff --git a/doc/specs/stdlib_specialmatrices.md b/doc/specs/stdlib_specialmatrices.md
@@ -33,7 +33,7 @@ Experimental
 #### Description
 
 Tridiagonal matrices are ubiquituous in scientific computing and often appear when discretizing 1D differential operators.
-A generic tridiagonal matrix has the following structure
+A generic tridiagonal matrix has the following structure:
 $$
     A
     =
@@ -50,25 +50,25 @@ This particular structure also lends itself to specialized implementations for m
 Interfaces to the most common ones will soon be provided by `stdlib_specialmatrices`.
 To date, `stdlib_specialmatrices` supports the following data types:
 
-- `Tridiagonal_sp_type`   : Tridiagonal matrix of size `n` with `real`/`single precision` data.
-- `Tridiagonal_dp_type`   : Tridiagonal matrix of size `n` with `real`/`double precision` data.
-- `Tridiagonal_xdp_type`  : Tridiagonal matrix of size `n` with `real`/`extended precision` data.
-- `Tridiagonal_qp_type`   : Tridiagonal matrix of size `n` with `real`/`quadruple precision` data.
-- `Tridiagonal_csp_type`  : Tridiagonal matrix of size `n` with `complex`/`single precision` data.
-- `Tridiagonal_cdp_type`  : Tridiagonal matrix of size `n` with `complex`/`double precision` data.
-- `Tridiagonal_cxdp_type` : Tridiagonal matrix of size `n` with `complex`/`extended precision` data.
-- `Tridiagonal_cqp_type`  : Tridiagonal matrix of size `n` with `complex`/`quadruple precision` data.
+- `tridiagonal_sp_type`   : Tridiagonal matrix of size `n` with `real`/`single precision` data.
+- `tridiagonal_dp_type`   : Tridiagonal matrix of size `n` with `real`/`double precision` data.
+- `tridiagonal_xdp_type`  : Tridiagonal matrix of size `n` with `real`/`extended precision` data.
+- `tridiagonal_qp_type`   : Tridiagonal matrix of size `n` with `real`/`quadruple precision` data.
+- `tridiagonal_csp_type`  : Tridiagonal matrix of size `n` with `complex`/`single precision` data.
+- `tridiagonal_cdp_type`  : Tridiagonal matrix of size `n` with `complex`/`double precision` data.
+- `tridiagonal_cxdp_type` : Tridiagonal matrix of size `n` with `complex`/`extended precision` data.
+- `tridiagonal_cqp_type`  : Tridiagonal matrix of size `n` with `complex`/`quadruple precision` data.
 
 
 #### Syntax
 
 - To construct a tridiagonal matrix from already allocated arrays `dl` (lower diagonal, size `n-1`), `dv` (main diagonal, size `n`) and `du` (upper diagonal, size `n-1`):
 
-`A = ` [[stdlib_specialmatrices(module):Tridiagonal(interface)]] `(dl, dv, du)`
+`A = ` [[stdlib_specialmatrices(module):tridiagonal(interface)]] `(dl, dv, du)`
 
 - To construct a tridiagonal matrix of size `n x n` with constant diagonal elements `dl`, `dv`, and `du`:
 
-`A = ` [[stdlib_specialmatrices(module):Tridiagonal(interface)]] `(dl, dv, du, n)`
+`A = ` [[stdlib_specialmatrices(module):tridiagonal(interface)]] `(dl, dv, du, n)`
 
 #### Example
 
@@ -90,7 +90,7 @@ Experimental
 
 With the exception of `extended precision` and `quadruple precision`, all the types provided by `stdlib_specialmatrices` benefit from specialized kernels for matrix-vector products accessible via the common `spmv` interface.
 
-- For `Tridiagonal` matrices, the LAPACK `lagtm` backend is being used.
+- For `tridiagonal` matrices, the LAPACK `lagtm` backend is being used.
 
 #### Syntax
 
@@ -111,7 +111,7 @@ With the exception of `extended precision` and `quadruple precision`, all the ty
 - `op` (optional) : In-place operator identifier. Shall be a character(1) argument. It can have any of the following values: `N`: no transpose, `T`: transpose, `H`: hermitian or complex transpose.
 
 @warning
-Due to some underlying `lapack`-related designs, `alpha` and `beta` can only take values in `[-1, 0, 1]` for `Tridiagonal` and `SymTridiagonal` matrices. See `lagtm` for more details.
+Due to some underlying `lapack`-related designs, `alpha` and `beta` can only take values in `[-1, 0, 1]` for `tridiagonal` and `symtridiagonal` matrices. See `lagtm` for more details.
 @endwarning
 
 #### Examples
diff --git a/example/specialmatrices/example_specialmatrices_dp_spmv.f90 b/example/specialmatrices/example_specialmatrices_dp_spmv.f90
@@ -1,17 +1,17 @@
 program example_tridiagonal_matrix
    use stdlib_linalg_constants, only: dp
-   use stdlib_specialmatrices, only: tridiaonal_dp_type, tridiagonal, dense
+   use stdlib_specialmatrices, only: tridiagonal_dp_type, tridiagonal, dense, spmv
    implicit none
 
    integer, parameter :: n = 5
-   type(Tridiagonal_dp_type) :: A
+   type(tridiagonal_dp_type) :: A
    real(dp) :: dl(n - 1), dv(n), du(n - 1)
    real(dp) :: x(n), y(n), y_dense(n)
    integer :: i
 
    ! Create an arbitrary tridiagonal matrix.
    dl = [(i, i=1, n - 1)]; dv = [(2*i, i=1, n)]; du = [(3*i, i=1, n - 1)]
-   A = Tridiagonal(dl, dv, du)
+   A = tridiagonal(dl, dv, du)
 
    ! Initialize vectors.
    x = 1.0_dp; y = 0.0_dp; y_dense = 0.0_dp
diff --git a/src/stdlib_specialmatrices.fypp b/src/stdlib_specialmatrices.fypp
@@ -11,7 +11,7 @@ module stdlib_specialmatrices
     use stdlib_linalg_constants
     implicit none
     private
-    public :: Tridiagonal
+    public :: tridiagonal
     public :: spmv
     public :: dense, transpose, hermitian
     public :: operator(*), operator(+), operator(-)
@@ -24,8 +24,8 @@ module stdlib_specialmatrices
 
     !--> Tridiagonal matrices
     #:for k1, t1, s1 in (KINDS_TYPES)
-    type, public :: Tridiagonal_${s1}$_type
-        !! Base type to define a `Tridiagonal` matrix.
+    type, public :: tridiagonal_${s1}$_type
+        !! Base type to define a `tridiagonal` matrix.
         private
         ${t1}$, allocatable :: dl(:), dv(:), du(:)
         integer(ilp) :: n
@@ -38,9 +38,9 @@ module stdlib_specialmatrices
     !-----                      -----
     !--------------------------------
 
-    interface Tridiagonal
+    interface tridiagonal
         !! ([Specifications](../page/specs/stdlib_specialmatrices.html#Tridiagonal)) This
-        !! interface provides different methods to construct a `Tridiagonal` matrix. Only
+        !! interface provides different methods to construct a `tridiagonal` matrix. Only
         !! the non-zero elements of \( A \) are stored, i.e.
         !!
         !! \[
@@ -57,44 +57,44 @@ module stdlib_specialmatrices
         !!
         !! #### Syntax
         !!
-        !! - Construct a real `Tridiagonal` matrix from rank-1 arrays:
+        !! - Construct a real `tridiagonal` matrix from rank-1 arrays:
         !!
         !! ```fortran
         !!    integer, parameter :: n
         !!    real(dp), allocatable :: dl(:), dv(:), du(:)
-        !!    type(Tridiagonal_rdp_type) :: A
+        !!    type(tridiagonal_rdp_type) :: A
         !!    integer :: i
         !!
         !!    dl = [(i, i=1, n-1)]; dv = [(2*i, i=1, n)]; du = [(3*i, i=1, n)]
         !!    A = Tridiagonal(dl, dv, du)
         !! ```
         !!
-        !! - Construct a real `Tridiagonal` matrix with constant diagonals:
+        !! - Construct a real `tridiagonal` matrix with constant diagonals:
         !!
         !! ```fortran
         !!    integer, parameter :: n
         !!    real(dp), parameter :: a = 1.0_dp, b = 1.0_dp, c = 2.0_dp
-        !!    type(Tridiagonal_rdp_type) :: A
+        !!    type(tridiagonal_rdp_type) :: A
         !!
         !!    A = Tridiagonal(a, b, c, n)
         !! ```
         #:for k1, t1, s1 in (KINDS_TYPES)
         pure module function initialize_tridiagonal_${s1}$(dl, dv, du) result(A)
-            !! Construct a `Tridiagonal` matrix from the rank-1 arrays
+            !! Construct a `tridiagonal` matrix from the rank-1 arrays
             !! `dl`, `dv` and `du`.
             ${t1}$, intent(in) :: dl(:), dv(:), du(:)
             !! Tridiagonal matrix elements.
-            type(Tridiagonal_${s1}$_type) :: A
+            type(tridiagonal_${s1}$_type) :: A
             !! Corresponding Tridiagonal matrix.
         end function
 
         pure module function initialize_constant_tridiagonal_${s1}$(dl, dv, du, n) result(A)
-            !! Construct a `Tridiagonal` matrix with constant elements.
+            !! Construct a `tridiagonal` matrix with constant elements.
             ${t1}$, intent(in) :: dl, dv, du
             !! Tridiagonal matrix elements.
             integer(ilp), intent(in) :: n
             !! Matrix dimension.
-            type(Tridiagonal_${s1}$_type) :: A
+            type(tridiagonal_${s1}$_type) :: A
             !! Corresponding Tridiagonal matrix.
         end function   
         #:endfor
@@ -116,7 +116,7 @@ module stdlib_specialmatrices
         #:for k1, t1, s1 in (KINDS_TYPES)
         #:for rank in RANKS
         module subroutine spmv_tridiag_${rank}$d_${s1}$(A, x, y, alpha, beta, op)
-         type(Tridiagonal_${s1}$_type), intent(in) :: A
+         type(tridiagonal_${s1}$_type), intent(in) :: A
             ${t1}$, intent(in), contiguous, target :: x${ranksuffix(rank)}$
             ${t1}$, intent(inout), contiguous, target :: y${ranksuffix(rank)}$
             real(${k1}$), intent(in), optional :: alpha
@@ -139,8 +139,8 @@ module stdlib_specialmatrices
         !! ([Specifications](../page/specs/stdlib_specialmatrices.html#dense))
         #:for k1, t1, s1 in (KINDS_TYPES)
         pure module function tridiagonal_to_dense_${s1}$(A) result(B)
-            !! Convert a `Tridiagonal` matrix to its dense representation.
-            type(Tridiagonal_${s1}$_type), intent(in) :: A
+            !! Convert a `tridiagonal` matrix to its dense representation.
+            type(tridiagonal_${s1}$_type), intent(in) :: A
             !! Input Tridiagonal matrix.
             ${t1}$, allocatable :: B(:, :)
             !! Corresponding dense matrix.
@@ -154,9 +154,9 @@ module stdlib_specialmatrices
         !! [Specifications](../page/specs/stdlib_specialmatrices.html#transpose)
         #:for k1, t1, s1 in (KINDS_TYPES)
         pure module function transpose_tridiagonal_${s1}$(A) result(B)
-            type(Tridiagonal_${s1}$_type), intent(in) :: A
+            type(tridiagonal_${s1}$_type), intent(in) :: A
             !! Input matrix.
-            type(Tridiagonal_${s1}$_type) :: B
+            type(tridiagonal_${s1}$_type) :: B
         end function
         #:endfor
     end interface
@@ -168,9 +168,9 @@ module stdlib_specialmatrices
         !! [Specifications](../page/specs/stdlib_specialmatrices.html#hermitian)
         #:for k1, t1, s1 in (KINDS_TYPES)
         pure module function hermitian_tridiagonal_${s1}$(A) result(B)
-            type(Tridiagonal_${s1}$_type), intent(in) :: A
+            type(tridiagonal_${s1}$_type), intent(in) :: A
             !! Input matrix.
-            type(Tridiagonal_${s1}$_type) :: B
+            type(tridiagonal_${s1}$_type) :: B
         end function
         #:endfor
     end interface
@@ -188,13 +188,13 @@ module stdlib_specialmatrices
         #:for k1, t1, s1 in (KINDS_TYPES)
         pure module function scalar_multiplication_tridiagonal_${s1}$(alpha, A) result(B)
             ${t1}$, intent(in) :: alpha
-            type(Tridiagonal_${s1}$_type), intent(in) :: A
-            type(Tridiagonal_${s1}$_type) :: B
+            type(tridiagonal_${s1}$_type), intent(in) :: A
+            type(tridiagonal_${s1}$_type) :: B
         end function
         pure module function scalar_multiplication_bis_tridiagonal_${s1}$(A, alpha) result(B)
-            type(Tridiagonal_${s1}$_type), intent(in) :: A
+            type(tridiagonal_${s1}$_type), intent(in) :: A
             ${t1}$, intent(in) :: alpha
-            type(Tridiagonal_${s1}$_type) :: B
+            type(tridiagonal_${s1}$_type) :: B
         end function
         #:endfor
     end interface
@@ -205,9 +205,9 @@ module stdlib_specialmatrices
         !! [Specifications](../page/specs/stdlib_specialmatrices.html#operators)
         #:for k1, t1, s1 in (KINDS_TYPES)
         pure module function matrix_add_tridiagonal_${s1}$(A, B) result(C)
-            type(Tridiagonal_${s1}$_type), intent(in) :: A
-            type(Tridiagonal_${s1}$_type), intent(in) :: B
-            type(Tridiagonal_${s1}$_type) :: C
+            type(tridiagonal_${s1}$_type), intent(in) :: A
+            type(tridiagonal_${s1}$_type), intent(in) :: B
+            type(tridiagonal_${s1}$_type) :: C
         end function
         #:endfor
     end interface
@@ -218,9 +218,9 @@ module stdlib_specialmatrices
         !! [Specifications](../page/specs/stdlib_specialmatrices.html#operators)
         #:for k1, t1, s1 in (KINDS_TYPES)
         pure module function matrix_sub_tridiagonal_${s1}$(A, B) result(C)
-            type(Tridiagonal_${s1}$_type), intent(in) :: A
-            type(Tridiagonal_${s1}$_type), intent(in) :: B
-            type(Tridiagonal_${s1}$_type) :: C
+            type(tridiagonal_${s1}$_type), intent(in) :: A
+            type(tridiagonal_${s1}$_type), intent(in) :: B
+            type(tridiagonal_${s1}$_type) :: C
         end function
         #:endfor
     end interface
diff --git a/test/linalg/test_linalg_specialmatrices.fypp b/test/linalg/test_linalg_specialmatrices.fypp
@@ -6,7 +6,12 @@ module test_specialmatrices
     use stdlib_kinds, only: sp, dp, xdp, qp, int8, int16, int32, int64
     use stdlib_linalg, only: hermitian
     use stdlib_math, only: all_close
-    use stdlib_specialmatrices
+    use stdlib_specialmatrices, only: tridiagonal, &
+                                      tridiagonal_sp_type, &
+                                      tridiagonal_dp_type, & 
+                                      tridiagonal_xdp_type, & 
+                                      tridiagonal_qp_type, &
+                                      dense, spmv
 
     implicit none
 
@@ -30,15 +35,15 @@ contains
         block
             integer, parameter :: wp = ${k1}$
             integer, parameter :: n = 5
-            type(Tridiagonal_${s1}$_type) :: A
+            type(tridiagonal_${s1}$_type) :: A
             ${t1}$, allocatable :: Amat(:,:), dl(:), dv(:), du(:)
             ${t1}$, allocatable :: x(:)
             ${t1}$, allocatable :: y1(:), y2(:)
 
             ! Initialize matrix.
             allocate(dl(n-1), dv(n), du(n-1))
             call random_number(dl) ; call random_number(dv) ; call random_number(du)
-            A = Tridiagonal(dl, dv, du) ; Amat = dense(A)
+            A = tridiagonal(dl, dv, du) ; Amat = dense(A)
 
             ! Random vectors.
             allocate(x(n), source = 0.0_wp)   ; call random_number(x)
