Document RNG parameters and add test of rvalue passing into algorithm

Author: sethrj

include/flc_random.i

@@ -36,9 +36,9 @@ class SWIG_MERSENNE_TWISTER
     typedef SWIG_MERSENNE_RESULT_TYPE result_type;
 
     SWIG_MERSENNE_TWISTER();
-    explicit SWIG_MERSENNE_TWISTER(result_type);
-    void seed(result_type);
-    void discard(unsigned long long);
+    explicit SWIG_MERSENNE_TWISTER(result_type seed_value);
+    void seed(result_type seed_value);
+    void discard(unsigned long long count);
 };
 } // namespace std
 

src/flc_random.f90

@@ -169,40 +169,40 @@ function swigf_new_Engine__SWIG_0() &
 self%swigdata = fresult
 end function
 
-function swigf_new_Engine__SWIG_1(arg0) &
+function swigf_new_Engine__SWIG_1(seed_value) &
 result(self)
 use, intrinsic :: ISO_C_BINDING
 type(Engine) :: self
-integer(C_INT64_T), intent(in) :: arg0
+integer(C_INT64_T), intent(in) :: seed_value
 type(SwigClassWrapper) :: fresult 
 integer(C_INT64_T) :: farg1 
 
-farg1 = arg0
+farg1 = seed_value
 fresult = swigc_new_Engine__SWIG_1(farg1)
 self%swigdata = fresult
 end function
 
-subroutine swigf_Engine_seed(self, arg1)
+subroutine swigf_Engine_seed(self, seed_value)
 use, intrinsic :: ISO_C_BINDING
 class(Engine), intent(in) :: self
-integer(C_INT64_T), intent(in) :: arg1
+integer(C_INT64_T), intent(in) :: seed_value
 type(SwigClassWrapper) :: farg1 
 integer(C_INT64_T) :: farg2 
 
 farg1 = self%swigdata
-farg2 = arg1
+farg2 = seed_value
 call swigc_Engine_seed(farg1, farg2)
 end subroutine
 
-subroutine swigf_Engine_discard(self, arg1)
+subroutine swigf_Engine_discard(self, count)
 use, intrinsic :: ISO_C_BINDING
 class(Engine), intent(in) :: self
-integer(C_LONG_LONG), intent(in) :: arg1
+integer(C_LONG_LONG), intent(in) :: count
 type(SwigClassWrapper) :: farg1 
 integer(C_LONG_LONG) :: farg2 
 
 farg1 = self%swigdata
-farg2 = arg1
+farg2 = count
 call swigc_Engine_discard(farg1, farg2)
 end subroutine
 

test/test_algorithm.F90

@@ -100,6 +100,7 @@ subroutine test_argsort()
 subroutine test_shuffle()
   use flc_algorithm, only : shuffle
   use flc_random, only : Engine
+  use, intrinsic :: ISO_C_BINDING
   implicit none
   integer :: i
   integer, dimension(8) :: iarr = (/ ((i), i = -4, 3) /)
@@ -110,6 +111,11 @@ subroutine test_shuffle()
       call shuffle(rng, iarr)
       write(*,"(A,(8I4))") "Shuffled:", iarr
   end do
+  call rng%release()
+
+  ! Shuffle using temporary RNG using seed 12345
+  call shuffle(Engine(12345_c_int64_t), iarr)
+  write(*,"(A,(8I4))") "Shuffled:", iarr
 end subroutine
 
 !-----------------------------------------------------------------------------!