added constructor for carray & sarray, changed intent of clear_list subroutine

Author: aman-godara

src/stdlib_stringlist.f90

@@ -59,7 +59,7 @@ module stdlib_stringlist
         private
         procedure         :: copy                           =>  create_copy
 
-        procedure, public :: destroy                        =>  destroy_list
+        procedure, public :: clear                          =>  clear_list
 
         procedure, public :: len                            =>  length_list
 
@@ -88,13 +88,23 @@ module stdlib_stringlist
                                                                 insert_before_stringlist_int,   &
                                                                 insert_before_chararray_int,    &
                                                                 insert_before_stringarray_int
-        ! procedure         :: get_string_int         => get_string_int_impl
+
         procedure         :: get_string_idx         => get_string_idx_wrap
         generic, public   :: get                    => get_string_idx
-                                                        ! get_string_int
 
     end type stringlist_type
 
+    !> Version: experimental
+    !>
+    !> Constructor for stringlist
+    !> Returns an instance of type stringlist_type
+    !> [Specifications](../page/specs/stdlib_stringlist.html#stringlist_type)
+    interface stringlist_type
+        module procedure new_stringlist
+        module procedure new_stringlist_carray
+        module procedure new_stringlist_sarray
+    end interface
+
     !> Version: experimental
     !> 
     !> Concatenates stringlist with the input entity
@@ -140,8 +150,48 @@ module stdlib_stringlist
 
 contains
 
+  ! constructor for stringlist_type:
+
+    !> Constructor with no argument
+    !> Returns a new instance of type stringlist 
+    pure function new_stringlist()
+        type(stringlist_type)                           :: new_stringlist
+        type(string_type), dimension(0)                 :: sarray
+
+        new_stringlist = stringlist_type( 0, sarray )
+
+    end function new_stringlist
+
+    !> Constructor to convert chararray to stringlist
+    !> Returns a new instance of type stringlist
+    pure function new_stringlist_carray( carray )
+        character(len=*), dimension(:), intent(in)      :: carray
+        type(stringlist_type)                           :: new_stringlist_carray
+        type(string_type), dimension( size(carray) )    :: sarray
+        integer                                         :: i
+
+        do i = 1, size(carray)
+            sarray(i) = string_type( carray(i) )
+        end do
+
+        new_stringlist_carray = stringlist_type( sarray )
+        
+    end function new_stringlist_carray
+
+    !> Constructor to convert stringarray to stringlist
+    !> Returns a new instance of type stringlist
+    pure function new_stringlist_sarray( sarray )
+        type(string_type), dimension(:), intent(in)     :: sarray
+        type(stringlist_type)                           :: new_stringlist_sarray
+
+        new_stringlist_sarray = stringlist_type( size(sarray), sarray )
+    
+    end function new_stringlist_sarray
+
+  ! constructor for stringlist_index_type:
+
     !> Returns an instance of type 'stringlist_index_type' representing forward index 'idx'
-    pure function forward_index(idx)
+    pure function forward_index( idx )
         integer, intent(in) :: idx
         type(stringlist_index_type) :: forward_index
 
@@ -150,14 +200,16 @@ pure function forward_index(idx)
     end function forward_index
 
     !> Returns an instance of type 'stringlist_index_type' representing backward index 'idx'
-    pure function backward_index(idx)
+    pure function backward_index( idx )
         integer, intent(in) :: idx
         type(stringlist_index_type) :: backward_index
 
         backward_index = stringlist_index_type( .false., idx )
 
     end function backward_index
 
+  ! copy
+
     !> Returns a deep copy of the stringlist 'original'
     pure function create_copy( original )
         class(stringlist_type), intent(in)  :: original
@@ -167,6 +219,8 @@ pure function create_copy( original )
 
     end function create_copy
 
+  ! concatenation operator:
+
     !> Appends character scalar 'string' to the stringlist 'list'
     !> Returns a new stringlist
     function append_char( list, string )
@@ -273,6 +327,8 @@ function prepend_sarray( sarray, list )
 
     end function prepend_sarray
 
+  ! equality operator:
+
     !> Compares stringlist 'list' for equality with stringlist 'slist'
     !> Returns a logical
     pure logical function eq_stringlist( list, slist )
@@ -353,6 +409,8 @@ pure logical function eq_sarray_stringlist( sarray, list )
 
     end function eq_sarray_stringlist
 
+  ! inequality operator:
+
     !> Compares stringlist 'list' for inequality with stringlist 'slist'
     !> Returns a logical
     pure logical function ineq_stringlist( list, slist )
@@ -403,22 +461,21 @@ pure logical function ineq_sarray_stringlist( sarray, list )
 
     end function ineq_sarray_stringlist
 
-  ! destroy:
+  ! clear:
 
     !> Version: experimental
     !>
     !> Resets stringlist 'list' to an empy stringlist of len 0
     !> Modifies the input stringlist 'list'
-    subroutine destroy_list( list )
-        !> TODO: needs a better name?? like clear_list or reset_list
-        class(stringlist_type), intent(out) :: list
+    subroutine clear_list( list )
+        class(stringlist_type), intent(inout) :: list
 
         list%size = 0
         if ( allocated( list%stringarray ) ) then
             deallocate( list%stringarray )
         end if
 
-    end subroutine destroy_list
+    end subroutine clear_list
 
   ! len:
 

src/tests/stringlist/test_append_prepend.f90

@@ -126,7 +126,7 @@ subroutine test_append_prepend_list
         integer, parameter              :: stride = 10
 
         do i = first, last - 1, stride
-            call temp_list%destroy()
+            call temp_list%clear()
             do j = i, i + stride - 1
                 call temp_list%insert_at( list_tail, string_type( to_string(j) ) )
             end do
@@ -153,7 +153,7 @@ subroutine test_append_prepend_list
             call check( reference_list /= work_list, "test_append_prepend_list:&
                                     & reference_list /= work_list" )
 
-            call temp_list%destroy()
+            call temp_list%clear()
             do j = i - stride + 1, i
                 call temp_list%insert_at( list_tail, to_string(j) )
             end do

src/tests/stringlist/test_insert_at.f90

@@ -15,6 +15,8 @@ subroutine test_insert_at_string_1
         integer, parameter              :: first = -100
         integer, parameter              :: last = 1
 
+        work_list = stringlist_type()
+        call check( work_list%len() == 0, "test_insert_at_string_1: constructor" )
         call check( work_list%to_current_idxn( list_tail ) == 0, "test_insert_at_string_1: list_tail == 0")
         call check( work_list%to_current_idxn( list_head ) == 1, "test_insert_at_string_1: list_head == 1")
 
@@ -46,8 +48,8 @@ subroutine test_insert_at_string_1
         ! compare work_list with [1, 0, -1, ..., ..., -99, -100]
         call compare_list( work_list, last, first - 1, 1)
 
-        call work_list%destroy()
-        call work_list%destroy()
+        call work_list%clear()
+        call work_list%clear()
         current_length = 0
 
         write (*,*) "test_insert_at_string_1: Starting test case 2!"
@@ -279,63 +281,63 @@ subroutine test_insert_at_list
 
         write (*,*) "test_insert_at_list:     Starting work_list!"
 
-        call temp_list%destroy()
+        call temp_list%clear()
         do j = first, first + stride - 1
             call temp_list%insert_at( list_tail, string_type( to_string(j) ) )
         end do
 
         call work_list%insert_at(list_head, temp_list)
         call compare_list( work_list, first, first + stride, 9)
 
-        call temp_list%destroy()
+        call temp_list%clear()
         do j = last - 1, last - stride, -1
             call temp_list%insert_at( list_head, string_type( to_string(j) ) )
         end do
 
         call work_list%insert_at(list_tail, temp_list)
 
         do i = first + stride, last - stride - 1, stride
-            call temp_list%destroy()
+            call temp_list%clear()
             do j = i, i + stride - 1
                 call temp_list%insert_at( list_tail, to_string(j) )
             end do
             call work_list%insert_at( fidx( i - first + 1 ), temp_list )
 
         end do
 
-        call temp_list%destroy()
+        call temp_list%clear()
         call temp_list%insert_at( list_head, to_string(last) )
         call work_list%insert_at( list_tail, temp_list )
 
         call compare_list( work_list, first, last + 1, 10 )
 
         write (*,*) "test_insert_at_list:     Starting reference_list!"
 
-        call temp_list%destroy()
+        call temp_list%clear()
         do j = last - stride + 1, last
             call temp_list%insert_at( list_tail, to_string(j) )
         end do
 
         call reference_list%insert_at( list_tail, temp_list )
         call compare_list( reference_list, last - stride + 1, last + 1, 11 )
 
-        call temp_list%destroy()
+        call temp_list%clear()
         do j = first + 1, first + stride
             call temp_list%insert_at( list_tail, string_type( to_string(j) ) )
         end do
 
         call reference_list%insert_at( list_head, temp_list )
 
         do i = last - stride, first + stride + 1, -1 * stride
-            call temp_list%destroy()
+            call temp_list%clear()
             do j = i - stride + 1, i
                 call temp_list%insert_at( list_tail, to_string(j) )
             end do
             call reference_list%insert_at( bidx( last - i + 1 ), temp_list )
 
         end do
 
-        call temp_list%destroy()
+        call temp_list%clear()
         call temp_list%insert_at( list_tail, to_string(first) )
         call reference_list%insert_at( list_head, temp_list )