Rename caffeine_m to prif_m and update procedure names in tests

Author: ktras

example/hello.f90

@@ -1,5 +1,5 @@
 program hello_world
-  use caffeine_m, only : prif_caffeinate, this_image => prif_this_image, num_images => prif_num_images, prif_stop
+  use prif_m, only : prif_caffeinate, this_image => prif_this_image, num_images => prif_num_images, prif_stop
   implicit none
 
   if (prif_caffeinate() /= 0) error stop "caffeinate returned a non-zero exit code"

example/support-test/error_stop_character_code.f90

@@ -1,5 +1,5 @@
 program error_stop_character_code
-  use caffeine_m, only : prif_caffeinate, prif_error_stop
+  use prif_m, only : prif_caffeinate, prif_error_stop
   implicit none
 
   if (prif_caffeinate() /= 0) error stop "caffeinate returned a non-zero exit_code"

example/support-test/error_stop_integer_code.f90

@@ -1,5 +1,5 @@
 program error_stop_integer_code
-  use caffeine_m, only : prif_caffeinate, prif_error_stop
+  use prif_m, only : prif_caffeinate, prif_error_stop
   implicit none
 
   if (prif_caffeinate() /= 0) error stop "caffeinate returned a non-zero exit_code"

example/support-test/stop_with_integer_code.f90

@@ -1,5 +1,5 @@
 program stop_with_no_code
-  use caffeine_m, only : prif_caffeinate, prif_stop
+  use prif_m, only : prif_caffeinate, prif_stop
   implicit none
 
   if (prif_caffeinate() /= 0) error stop "caffeinate returned a non-zero exit_code"

example/support-test/stop_with_no_code.f90

@@ -1,5 +1,5 @@
 program stop_with_no_code
-  use caffeine_m, only : prif_caffeinate, prif_stop
+  use prif_m, only : prif_caffeinate, prif_stop
   implicit none
 
   if (prif_caffeinate() /= 0) error stop "caffeinate returned a non-zero exit_code"

src/caffeine_m.f90 renamed to src/prif_m.f90

@@ -1,11 +1,11 @@
 ! Copyright (c), The Regents of the University of California
 ! Terms of use are as specified in LICENSE.txt
-module caffeine_m
+module prif_m
   use program_termination_m, only : prif_stop, prif_error_stop
   use image_enumeration_m, only : prif_this_image, prif_num_images
   use collective_subroutines_m, only : prif_co_sum, prif_co_max, prif_co_min, prif_co_reduce, prif_co_broadcast
   use caffeinate_decaffeinate_m, only : prif_caffeinate, prif_decaffeinate
   use team_type_m, only: prif_form_team, prif_change_team, prif_end_team, prif_team_type
   use synchronization_m, only : prif_sync_all
   implicit none
-end module caffeine_m
+end module prif_m

test/caf_co_broadcast_test.f90

@@ -1,10 +1,10 @@
 module caf_co_broadcast_test
-  use caffeine_m, only : caf_co_broadcast, caf_num_images, caf_this_image
+  use prif_m, only : prif_co_broadcast, prif_num_images, prif_this_image
   use veggies, only : result_t, test_item_t, describe, it, assert_equals, assert_that
 
   implicit none
   private
-  public :: test_caf_co_broadcast
+  public :: test_prif_co_broadcast
 
   type object_t
     integer i
@@ -19,11 +19,11 @@ module caf_co_broadcast_test
 
 contains
 
-  function test_caf_co_broadcast() result(tests)
+  function test_prif_co_broadcast() result(tests)
     type(test_item_t) tests
 
     tests = describe( &
-      "The caf_co_broadcast subroutine", &
+      "The prif_co_broadcast subroutine", &
       [ it("broadcasts a default integer scalar with no optional arguments present", broadcast_default_integer_scalar) &
        ,it("broadcasts a derived type scalar with no allocatable components", broadcast_derived_type) &
     ])
@@ -44,8 +44,8 @@ function broadcast_default_integer_scalar() result(result_)
     integer iPhone
     integer, parameter :: source_value = 7779311, junk = -99
 
-    iPhone = merge(source_value, junk, caf_this_image()==1)
-    call caf_co_broadcast(iPhone, source_image=1)
+    iPhone = merge(source_value, junk, prif_this_image()==1)
+    call prif_co_broadcast(iPhone, source_image=1)
     result_ = assert_equals(source_value, iPhone)
   end function
 
@@ -54,11 +54,11 @@ function broadcast_derived_type() result(result_)
     type(object_t) object
 
 
-    associate(me => caf_this_image(), ni => caf_num_images())
+    associate(me => prif_this_image(), ni => prif_num_images())
 
      object = object_t(me, .false., "gooey", me*(1.,0.))
 
-      call caf_co_broadcast(object, source_image=ni)
+      call prif_co_broadcast(object, source_image=ni)
 
       associate(expected_object => object_t(ni, .false., "gooey", ni*(1.,0.)))
         result_ = assert_that(expected_object == object, "co_broadcast derived type")

test/caf_co_max_test.f90

@@ -1,18 +1,18 @@
 module caf_co_max_test
-    use caffeine_m, only : caf_co_max, caf_num_images
+    use prif_m, only : prif_co_max, prif_num_images
     use veggies, only: result_t, test_item_t, assert_equals, describe, it, assert_that, assert_equals
-    use image_enumeration_m, only : caf_this_image, caf_num_images
+    use image_enumeration_m, only : prif_this_image, prif_num_images
 
     implicit none
     private
-    public :: test_caf_co_max
+    public :: test_prif_co_max
 
 contains
-    function test_caf_co_max() result(tests)
+    function test_prif_co_max() result(tests)
         type(test_item_t) tests
 
         tests = describe( &
-          "The caf_co_max subroutine computes the maximum", &
+          "The prif_co_max subroutine computes the maximum", &
           [ it("default integer scalar with stat argument present", max_default_integer_scalars) &
            ,it("integer(c_int64_t) scalar with no optional arguments present", max_c_int64_scalars) &
            ,it("default integer 1D array elements with no optional arguments present", max_default_integer_1D_array) &
@@ -30,8 +30,8 @@ function max_default_integer_scalars() result(result_)
         integer i, status_
 
         status_ = -1
-        i = -caf_this_image()
-        call caf_co_max(i, stat=status_)
+        i = -prif_this_image()
+        call prif_co_max(i, stat=status_)
         result_ = assert_equals(-1, i) .and. assert_equals(0, status_)
     end function
 
@@ -40,20 +40,20 @@ function max_c_int64_scalars() result(result_)
         type(result_t) result_
         integer(c_int64_t) i
 
-        i = caf_this_image()
-        call caf_co_max(i)
-        result_ = assert_equals(caf_num_images(), int(i))
+        i = prif_this_image()
+        call prif_co_max(i)
+        result_ = assert_equals(prif_num_images(), int(i))
     end function
 
     function max_default_integer_1D_array() result(result_)
         type(result_t) result_
         integer i
         integer, allocatable :: array(:)
 
-        associate(sequence_ => caf_this_image()*[(i, i=1, caf_num_images())])
+        associate(sequence_ => prif_this_image()*[(i, i=1, prif_num_images())])
           array = sequence_
-          call caf_co_max(array)
-          associate(max_sequence => caf_num_images()*[(i, i=1, caf_num_images())])
+          call prif_co_max(array)
+          associate(max_sequence => prif_num_images()*[(i, i=1, prif_num_images())])
             result_ = assert_that(all(max_sequence == array))
           end associate
         end associate
@@ -64,9 +64,9 @@ function max_default_integer_7D_array() result(result_)
         integer array(2,1,1, 1,1,1, 2), status_
 
         status_ = -1
-        array = 3 + caf_this_image()
-        call caf_co_max(array, stat=status_)
-        result_ = assert_that(all(array == 3+caf_num_images())) .and. assert_equals(0, status_)
+        array = 3 + prif_this_image()
+        call prif_co_max(array, stat=status_)
+        result_ = assert_that(all(array == 3+prif_num_images())) .and. assert_equals(0, status_)
     end function
 
     function max_default_real_scalars() result(result_)
@@ -76,8 +76,8 @@ function max_default_real_scalars() result(result_)
         integer status_
 
         status_ = -1
-        scalar = -pi*caf_this_image()
-        call caf_co_max(scalar, stat=status_)
+        scalar = -pi*prif_this_image()
+        call prif_co_max(scalar, stat=status_)
         result_ = assert_equals(-dble(pi), dble(scalar) ) .and. assert_equals(0, status_)
     end function
 
@@ -86,8 +86,8 @@ function max_double_precision_2D_array() result(result_)
         double precision, allocatable :: array(:,:)
         double precision, parameter :: tent(*,*) = dble(reshape(-[0,1,2,3,2,1], [3,2]))
 
-        array = tent*dble(caf_this_image())
-        call caf_co_max(array)
+        array = tent*dble(prif_this_image())
+        call prif_co_max(array)
         result_ = assert_that(all(array==tent))
     end function
 
@@ -104,15 +104,15 @@ function max_elements_in_3D_string_arrays() result(result_)
       end associate
 
       co_max_scramlet = scramlet
-      call caf_co_max(co_max_scramlet, result_image=1)
+      call prif_co_max(co_max_scramlet, result_image=1)
 
       block 
         integer j, delta_j
         character(len=len(script)) expected_script(size(script)), expected_scramlet(size(scramlet,1),size(scramlet,2))
 
         do j=1, size(script)
           expected_script(j) = script(j)
-          do delta_j = 1, max(caf_num_images()-1, size(script))
+          do delta_j = 1, max(prif_num_images()-1, size(script))
             associate(periodic_index => 1 + mod(j+delta_j-1, size(script)))
               expected_script(j) = max(expected_script(j), script(periodic_index))
             end associate
@@ -130,14 +130,14 @@ function reverse_alphabetize_default_character_scalars() result(result_)
       character(len=*), parameter :: words(*) = [character(len=len("loddy")):: "loddy","doddy","we","like","to","party"]
       character(len=:), allocatable :: my_word
 
-      associate(me => caf_this_image())
+      associate(me => prif_this_image())
         associate(periodic_index => 1 + mod(me-1,size(words)))
           my_word = words(periodic_index)
-          call caf_co_max(my_word)
+          call prif_co_max(my_word)
         end associate
       end associate
 
-      associate(expected_word => maxval(words(1:min(caf_num_images(), size(words)))))
+      associate(expected_word => maxval(words(1:min(prif_num_images(), size(words)))))
         result_ = assert_equals(expected_word, my_word)
       end associate
     end function

test/caf_co_min_test.f90

@@ -1,18 +1,18 @@
 module caf_co_min_test
-    use caffeine_m, only : caf_co_min, caf_num_images
+    use prif_m, only : prif_co_min, prif_num_images
     use veggies, only: result_t, test_item_t, assert_equals, describe, it, assert_that, assert_equals, succeed
-    use image_enumeration_m, only : caf_this_image, caf_num_images
+    use image_enumeration_m, only : prif_this_image, prif_num_images
 
     implicit none
     private
-    public :: test_caf_co_min
+    public :: test_prif_co_min
 
 contains
-    function test_caf_co_min() result(tests)
+    function test_prif_co_min() result(tests)
         type(test_item_t) tests
 
         tests = describe( &
-          "The caf_co_min subroutine computes the minimum", &
+          "The prif_co_min subroutine computes the minimum", &
           [ it("default integer scalar with stat argument present", min_default_integer_scalars) &
            ,it("integer(c_int64_t) scalar with no optional arguments present", min_c_int64_scalars) &
            ,it("default integer 1D array elements with no optional arguments present", min_default_integer_1D_array) &
@@ -30,18 +30,18 @@ function min_default_integer_scalars() result(result_)
         integer i, status_
 
         status_ = -1
-        i = -caf_this_image()
-        call caf_co_min(i, stat=status_)
-        result_ = assert_equals(-caf_num_images(), i) .and. assert_equals(0, status_)
+        i = -prif_this_image()
+        call prif_co_min(i, stat=status_)
+        result_ = assert_equals(-prif_num_images(), i) .and. assert_equals(0, status_)
     end function
 
     function min_c_int64_scalars() result(result_)
         use iso_c_binding, only : c_int64_t 
         type(result_t) result_
         integer(c_int64_t) i
 
-        i = caf_this_image()
-        call caf_co_min(i)
+        i = prif_this_image()
+        call prif_co_min(i)
         result_ = assert_equals(1, int(i))
     end function
 
@@ -50,10 +50,10 @@ function min_default_integer_1D_array() result(result_)
         integer i
         integer, allocatable :: array(:)
 
-        associate(sequence_ => caf_this_image()*[(i, i=1, caf_num_images())])
+        associate(sequence_ => prif_this_image()*[(i, i=1, prif_num_images())])
           array = sequence_
-          call caf_co_min(array)
-          associate(min_sequence => [(i, i=1, caf_num_images())])
+          call prif_co_min(array)
+          associate(min_sequence => [(i, i=1, prif_num_images())])
             result_ = assert_that(all(min_sequence == array))
           end associate
         end associate
@@ -64,9 +64,9 @@ function min_default_integer_7D_array() result(result_)
         integer array(2,1,1, 1,1,1, 2), status_
 
         status_ = -1
-        array = 3 - caf_this_image()
-        call caf_co_min(array, stat=status_)
-        result_ = assert_that(all(array == 3 - caf_num_images())) .and. assert_equals(0, status_)
+        array = 3 - prif_this_image()
+        call prif_co_min(array, stat=status_)
+        result_ = assert_that(all(array == 3 - prif_num_images())) .and. assert_equals(0, status_)
     end function
 
     function min_default_real_scalars() result(result_)
@@ -76,19 +76,19 @@ function min_default_real_scalars() result(result_)
         integer status_
 
         status_ = -1
-        scalar = -pi*caf_this_image()
-        call caf_co_min(scalar, stat=status_)
-        result_ = assert_equals(-dble(pi*caf_num_images()), dble(scalar) ) .and. assert_equals(0, status_)
+        scalar = -pi*prif_this_image()
+        call prif_co_min(scalar, stat=status_)
+        result_ = assert_equals(-dble(pi*prif_num_images()), dble(scalar) ) .and. assert_equals(0, status_)
     end function
 
     function min_double_precision_2D_array() result(result_)
         type(result_t) result_
         double precision, allocatable :: array(:,:)
         double precision, parameter :: tent(*,*) = dble(reshape(-[0,1,2,3,2,1], [3,2]))
 
-        array = tent*dble(caf_this_image())
-        call caf_co_min(array)
-        result_ = assert_that(all(array==tent*caf_num_images()))
+        array = tent*dble(prif_this_image())
+        call prif_co_min(array)
+        result_ = assert_that(all(array==tent*prif_num_images()))
     end function
 
     function min_elements_in_2D_string_arrays() result(result_)
@@ -105,15 +105,15 @@ function min_elements_in_2D_string_arrays() result(result_)
       end associate
 
       co_min_scramlet = scramlet
-      call caf_co_min(co_min_scramlet, result_image=1)
+      call prif_co_min(co_min_scramlet, result_image=1)
 
       block 
         integer j, delta_j
         character(len=len(script)) expected_script(size(script)), expected_scramlet(size(scramlet,1),size(scramlet,2))
 
         do j=1, size(script)
           expected_script(j) = script(j)
-          do delta_j = 1, min(caf_num_images()-1, size(script))
+          do delta_j = 1, min(prif_num_images()-1, size(script))
             associate(periodic_index => 1 + mod(j+delta_j-1, size(script)))
               expected_script(j) = min(expected_script(j), script(periodic_index))
             end associate
@@ -131,14 +131,14 @@ function alphabetically_1st_scalar_string() result(result_)
       character(len=*), parameter :: words(*) = [character(len=len("to party!")):: "Loddy","doddy","we","like","to party!"]
       character(len=:), allocatable :: my_word
 
-      associate(me => caf_this_image())
+      associate(me => prif_this_image())
         associate(periodic_index => 1 + mod(me-1,size(words)))
           my_word = words(periodic_index)
-          call caf_co_min(my_word)
+          call prif_co_min(my_word)
         end associate
       end associate
 
-      associate(expected_word => minval(words(1:min(caf_num_images(), size(words)))))
+      associate(expected_word => minval(words(1:min(prif_num_images(), size(words)))))
         result_ = assert_equals(expected_word, my_word)
       end associate
     end function