pm_distUnif::getUnifRandState Interface Reference

Generate and return an allocatable array of rank 1 containing the state vector of the Fortran default random number generator (RNG) or, optionally set the RNG state based on a reference input scalar seed, optionally distinctly on each processor. More...

Detailed Description

Generate and return an allocatable array of rank 1 containing the state vector of the Fortran default random number generator (RNG) or, optionally set the RNG state based on a reference input scalar seed, optionally distinctly on each processor.

The procedures of this generic interface are merely wrappers around the procedures of the generic interface setUnifRandState that additionally return the current RNG state.
If both seed and imageID input arguments are missing, the procedures simply return the current RNG state.
Otherwise, the behavior is identical to that of setUnifRandState.

Parameters

[in]	seed	: See the documentation of the corresponding input argument to setUnifRandState.
[in]	imageID	: See the documentation of the corresponding input argument to setUnifRandState.

Returns

unifRandState : The output allocatable vector of rank 1 whose length equals the size of the random state vector of the default Fortran RNG as returned by the Fortran intrinsic random_seed(size = size).

Possible calling interfaces ⛓

use pm_lkind, only: IK
use pm_distUnif, only: getUnifRandState
integer(IK), allocatable :: unifRandState(:)
 
unifRandState = getUnifRandState(seed = seed, imageID = imageID)

Remarks

The procedures under discussion are impure.

See also

rngf
isHead
getUnifCDF
getUnifRand
setUnifRand
getUnifRandState
setUnifRandState
rngu_type
rngf_type
splitmix64_type
xoshiro256ssw_type
getUnifRandStateSize

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK, LK
    use pm_io, only: display_type
    use pm_parallelism, only: getImageID
    use pm_distUnif, only: getUnifRandState
 
    implicit none
 
    integer(IK), allocatable :: unifRandState(:)
 
    type(display_type) :: disp
 
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Get the current RNG seed.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("unifRandState = getUnifRandState()")
                    unifRandState = getUnifRandState()
    call disp%show("unifRandState")
    call disp%show( unifRandState )
    call disp%skip()
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Set the current RNG seed based on the input scalar `seed` and return a copy of seed vector.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("unifRandState = getUnifRandState(seed = 12345_IK)")
                    unifRandState = getUnifRandState(seed = 12345_IK)
    call disp%show("unifRandState")
    call disp%show( unifRandState )
    call disp%skip()
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Set the current RNG seed on each image distinctly based on the current date and time and and the image ID and return a copy of seed vector.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("unifRandState = getUnifRandState(imageID = getImageID())")
                    unifRandState = getUnifRandState(imageID = getImageID())
    call disp%show("unifRandState")
    call disp%show( unifRandState )
    call disp%skip()
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Set the current RNG seed on each image distinctly based on the input scalar `seed` and and the image ID and return a copy of seed vector.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("unifRandState = getUnifRandState(seed = 12345_IK, imageID = getImageID())")
                    unifRandState = getUnifRandState(seed = 12345_IK, imageID = getImageID())
    call disp%show("unifRandState")
    call disp%show( unifRandState )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
!%%%%%%%%%%%%%%%%%%%%%%%%%%
! Get the current RNG seed.
!%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
unifRandState = getUnifRandState()
unifRandState
-750981303, +2070083405, +1733008626, -1262172988, -902083335, -1985651255, -1658240627, +1738057454
 
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Set the current RNG seed based on the input scalar `seed` and return a copy of seed vector.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
unifRandState = getUnifRandState(seed = 12345_IK)
unifRandState
-930397057, -1271367333, -839688912, +1099379960, +310102611, +1239277010, +1840798532, +493908163
 
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Set the current RNG seed on each image distinctly based on the current date and time and and the image ID and return a copy of seed vector.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
unifRandState = getUnifRandState(imageID = getImageID())
unifRandState
-1093144448, -1671167646, +1116058510, +206243038, -1983460214, -474484444, +649781684, -1219745346
 
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Set the current RNG seed on each image distinctly based on the input scalar `seed` and and the image ID and return a copy of seed vector.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
unifRandState = getUnifRandState(seed = 12345_IK, imageID = getImageID())
unifRandState
-930397057, -1271367333, -839688912, +1099379960, +310102611, +1239277010, +1840798532, +493908163
 
 

Test:

test_pm_distUnif

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin

Definition at line 3902 of file pm_distUnif.F90.

---

The documentation for this interface was generated from the following file:

• src/fortran/main/pm_distUnif.F90