renamed stringlist to stringlist_type

Author: aman-godara

doc/specs/index.md

@@ -26,7 +26,7 @@ This is and index/directory of the specifications (specs) for each new module/fe
  - [stats_distribution_PRNG](./stdlib_stats_distribution_PRNG.html) - Probability Distributions random number generator
  - [string\_type](./stdlib_string_type.html) - Basic string support
  - [strings](./stdlib_strings.html) - String handling and manipulation routines
- - [stringlist](./stdlib_stringlist.html) - 1-Dimensional list of strings
+ - [stringlist_type](./stdlib_stringlist_type.html) - 1-Dimensional list of strings
 
 ## Released/Stable Features & Modules
 

doc/specs/stdlib_stringlist.md renamed to doc/specs/stdlib_stringlist_type.md

@@ -1,14 +1,14 @@
 ---
-title: stringlist
+title: stringlist type
 ---
 
-# `stdlib_stringlist` module (1-D List of Strings)
+# `stdlib_stringlist_type` module (1-D List of Strings)
 
 [TOC]
 
 ## Introduction
 
-The `stdlib_stringlist` module provides with 2 derived types to deal with list of strings.
+The `stdlib_stringlist_type` module provides with 2 derived types to deal with list of strings.
 `stringlist_type` derived type represents a one-dimensional list of variable-length strings which is compatible with Fortran intrinsic character and `stringlist_type` derived type represents an index to access, modify the elements of a stringlist and insert strings to a stringlist.
 
 ## Derived type provided
@@ -47,8 +47,8 @@ Experimental
 
 #### Syntax
 
-For fidx: `res = [[stdlib_stringlist(module):fidx()]] (idx)`.  
-For bidx: `res = [[stdlib_stringlist(module):bidx()]] (idx)`.
+For fidx: `res = [[stdlib_stringlist_type(module):fidx()]] (idx)`.  
+For bidx: `res = [[stdlib_stringlist_type(module):bidx()]] (idx)`.
 
 #### Status
 
@@ -71,7 +71,7 @@ The result is of type `stringlist_index_type`.
 
 ```fortran
 program demo_fidx_bidx
-  use stdlib_stringlist, only: stringlist_type, stringlist_index_type, fidx, bidx
+  use stdlib_stringlist_type, only: stringlist_type, stringlist_index_type, fidx, bidx
   implicit none
 
   type(stringlist_type) :: stringlist
@@ -106,9 +106,9 @@ With argument: Initializes a stringlist equivalent to the input array `array` i.
 
 #### Syntax
 
-- No arguments given: `res = [[stdlib_stringlist(module):stringlist_type(interface)]] ()`
+- No arguments given: `res = [[stdlib_stringlist_type(module):stringlist_type(interface)]] ()`
 
-- With argument: `res = [[stdlib_stringlist(module):stringlist_type(interface)]] (array)`
+- With argument: `res = [[stdlib_stringlist_type(module):stringlist_type(interface)]] (array)`
 
 #### Status
 
@@ -134,7 +134,7 @@ The result is an instance of type `stringlist_type`.
 
 ```fortran
 program demo_constructor
-  use stdlib_stringlist, only: stringlist_type
+  use stdlib_stringlist_type, only: stringlist_type
   use stdlib_string_type, only: string_type
   implicit none
 
@@ -162,7 +162,7 @@ Inserts the string `string` _AT_ the index `idx`, so that the newly added elemen
 
 #### Syntax
 
-`call [[stdlib_stringlist(module):stringlist_type(type)]]%[[stdlib_stringlist(module):insert_at(generic)]] (idx, string)`
+`call [[stdlib_stringlist_type(module):stringlist_type(type)]]%[[stdlib_stringlist_type(module):insert_at(generic)]] (idx, string)`
 
 #### Status
 
@@ -174,7 +174,7 @@ Pure subroutine.
 
 #### Argument
 
-- `idx`: [[stdlib_stringlist(module):stringlist_index_type(type)]].
+- `idx`: [[stdlib_stringlist_type(module):stringlist_index_type(type)]].
   This argument is intent(in).
 
 - `string`: Character scalar or [[stdlib_string_type(module):string_type(type)]].
@@ -188,7 +188,7 @@ No result.
 
 ```fortran
 program demo_insert_at
-  use stdlib_stringlist, only: stringlist_type, stringlist_index_type, fidx, bidx
+  use stdlib_stringlist_type, only: stringlist_type, stringlist_index_type, fidx, bidx
   use stdlib_string_type, only: string_type
   implicit none
 
@@ -222,7 +222,7 @@ Returns the string present currently at the index `idx` in a stringlist. If inde
 
 #### Syntax
 
-`res = [[stdlib_stringlist(module):stringlist_type(type)]]%[[stdlib_stringlist(module):get(generic)]] (idx)`
+`res = [[stdlib_stringlist_type(module):stringlist_type(type)]]%[[stdlib_stringlist_type(module):get(generic)]] (idx)`
 
 #### Status
 
@@ -234,7 +234,7 @@ Pure function.
 
 #### Argument
 
-- `idx`: [[stdlib_stringlist(module):stringlist_index_type(type)]].
+- `idx`: [[stdlib_stringlist_type(module):stringlist_index_type(type)]].
   This argument is intent(in).
 
 #### Result value
@@ -245,7 +245,7 @@ The result is a string of type `string_type`.
 
 ```fortran
 program demo_get
-  use stdlib_stringlist, only: stringlist_type, fidx, bidx
+  use stdlib_stringlist_type, only: stringlist_type, fidx, bidx
   use stdlib_string_type, only: string_type
   implicit none
 
@@ -284,7 +284,7 @@ Returns the number of elements present currently in the stringlist.
 
 #### Syntax
 
-`res = [[stdlib_stringlist(module):stringlist_type(type)]]%[[stdlib_stringlist(module):len()]] ()`
+`res = [[stdlib_stringlist_type(module):stringlist_type(type)]]%[[stdlib_stringlist_type(module):len()]] ()`
 
 #### Status
 
@@ -306,7 +306,7 @@ The result is of type `integer`.
 
 ```fortran
 program demo_len
-  use stdlib_stringlist, only: stringlist_type, bidx
+  use stdlib_stringlist_type, only: stringlist_type, bidx
   implicit none
 
   type(stringlist_type) :: stringlist
@@ -336,7 +336,7 @@ Removes all elements from a stringlist.
 
 #### Syntax
 
-`call [[stdlib_stringlist(module):stringlist_type(type)]]%[[stdlib_stringlist(module):clear()]] ()`
+`call [[stdlib_stringlist_type(module):stringlist_type(type)]]%[[stdlib_stringlist_type(module):clear()]] ()`
 
 #### Status
 
@@ -358,7 +358,7 @@ No result.
 
 ```fortran
 program demo_clear
-  use stdlib_stringlist, only: stringlist_type, fidx
+  use stdlib_stringlist_type, only: stringlist_type, fidx
   implicit none
 
   type(stringlist_type) :: stringlist

src/CMakeLists.txt

@@ -56,7 +56,7 @@ set(SRC
     stdlib_specialfunctions.f90
     stdlib_specialfunctions_legendre.f90
     stdlib_quadrature_gauss.f90
-    stdlib_stringlist.f90
+    stdlib_stringlist_type.f90
     ${outFiles}
 )
 

src/Makefile.manual

@@ -40,7 +40,7 @@ SRC = f18estop.f90 \
       stdlib_logger.f90 \
       stdlib_quadrature_gauss.f90 \
       stdlib_strings.f90 \
-      stdlib_stringlist.f90 \
+      stdlib_stringlist_type.f90 \
       $(SRCGEN)
 
 LIB = libstdlib.a
@@ -156,6 +156,6 @@ stdlib_math_linspace.o: \
 stdlib_math_logspace.o: \
 	stdlib_math_linspace.o
 stdlib_linalg_outer_product.o: stdlib_linalg.o
-stdlib_stringlist.o: stdlib_string_type.o \
+stdlib_stringlist_type.o: stdlib_string_type.o \
     stdlib_math.o \
 	stdlib_optval.o

src/stdlib_stringlist.f90 renamed to src/stdlib_stringlist_type.f90

@@ -1,4 +1,4 @@
-! stdlib_stringlist.f90 --
+! stdlib_stringlist_type.f90 --
 !     Module for storing and manipulating list of strings
 !     The strings may have arbitrary lengths, not necessarily the same
 !
@@ -14,7 +14,7 @@
 !     Note the distinction between AT and BEFORE in the module. Care has been taken to keep it consistent
 !     throughout the PR
 !
-module stdlib_stringlist
+module stdlib_stringlist_type
     use stdlib_string_type, only: string_type, operator(/=) !, move
     use stdlib_math, only: clip
     implicit none
@@ -36,15 +36,15 @@ module stdlib_stringlist
     !> Version: experimental
     !> 
     !> Returns an instance of type 'stringlist_index_type' representing forward index
-    !> [Specifications](../page/specs/stdlib_stringlist.html#fidx)
+    !> [Specifications](../page/specs/stdlib_stringlist_type.html#fidx)
     interface fidx
         module procedure forward_index
     end interface
 
     !> Version: experimental
     !> 
     !> Returns an instance of type 'stringlist_index_type' representing backward index
-    !> [Specifications](../page/specs/stdlib_stringlist.html#bidx)
+    !> [Specifications](../page/specs/stdlib_stringlist_type.html#bidx)
     interface bidx
         module procedure backward_index
     end interface
@@ -93,7 +93,7 @@ module stdlib_stringlist
     !>
     !> Constructor for stringlist
     !> Returns an instance of type stringlist_type
-    !> [Specifications](../page/specs/stdlib_stringlist.html#stringlist_type)
+    !> [Specifications](../page/specs/stdlib_stringlist_type.html#stringlist_type)
     interface stringlist_type
         module procedure new_stringlist
         module procedure new_stringlist_carray
@@ -103,7 +103,7 @@ module stdlib_stringlist
     !> 
     !> Concatenates stringlist with the input entity
     !> Returns a new stringlist
-    !> [Specifications](../page/specs/stdlib_stringlist.html#append-operator)
+    !> [Specifications](../page/specs/stdlib_stringlist_type.html#append-operator)
     interface operator(//)
         module procedure append_char
         module procedure append_string
@@ -120,7 +120,7 @@ module stdlib_stringlist
     !> 
     !> Compares stringlist for equality with the input entity
     !> Returns a logical
-    !> [Specifications](../page/specs/stdlib_stringlist.html#equality-operator)
+    !> [Specifications](../page/specs/stdlib_stringlist_type.html#equality-operator)
     interface operator(==)
         module procedure eq_stringlist
         module procedure eq_stringlist_carray
@@ -133,7 +133,7 @@ module stdlib_stringlist
     !> 
     !> Compares stringlist for inequality with the input entity
     !> Returns a logical
-    !> [Specifications](../page/specs/stdlib_stringlist.html#inequality-operator)
+    !> [Specifications](../page/specs/stdlib_stringlist_type.html#inequality-operator)
     interface operator(/=)
         module procedure ineq_stringlist
         module procedure ineq_stringlist_carray
@@ -723,4 +723,4 @@ pure function get_string_idx_wrap( list, idx )
     end function get_string_idx_wrap
 
 
-end module stdlib_stringlist
+end module stdlib_stringlist_type

src/tests/stringlist/test_append_prepend.f90

@@ -2,7 +2,7 @@
 module test_append_prepend
     use stdlib_error, only: check
     use stdlib_string_type, only: string_type, operator(//), operator(==)
-    use stdlib_stringlist, only: stringlist_type, fidx, bidx, list_head, &
+    use stdlib_stringlist_type, only: stringlist_type, fidx, bidx, list_head, &
                             & list_tail, operator(//), operator(==), operator(/=)
     use stdlib_ascii, only: to_string
     implicit none    

src/tests/stringlist/test_insert_at.f90

@@ -2,7 +2,7 @@
 module test_insert_at
     use stdlib_error, only: check
     use stdlib_string_type, only: string_type, operator(//), operator(==)
-    use stdlib_stringlist, only: stringlist_type, fidx, bidx, list_head, list_tail, operator(==)
+    use stdlib_stringlist_type, only: stringlist_type, fidx, bidx, list_head, list_tail, operator(==)
     use stdlib_ascii, only: to_string
     implicit none