Set the state of the Fortran default random number generator (RNG) to a random value or to an optionally deterministic, optionally processor-dependent value based on the user-specified input scalar seed and processor ID.
More...
Set the state of the Fortran default random number generator (RNG) to a random value or to an optionally deterministic, optionally processor-dependent value based on the user-specified input scalar seed and processor ID.
The procedures of this generic interface offer a convenient interface for the following tasks:
-
When all optional arguments are missing, this generic interface (re)sets the state of the default Fortran RNG to random values.
-
When the optional argument
seed
is present and imageID
is missing, this generic interface sets the RNG state vector to a deterministic value exclusively based on the input scalar seed
.
The generated state vector is set identically on all images/processes/threads that individually call this generic interface.
-
When both optional arguments
seed
and imageID
are present, this generic interface sets the RNG state vector to a deterministic value unique to each process/thread/image (based on the specified input process-unique imageID
).
- Parameters
-
[in] | seed | : The input scalar of type integer of default kind IK, containing a positive integer that serves as the starting point to generate the full RNG state.
Specify this input argument if you wish to make random simulations reproducible, even between multiple independent runs of the program compiled by the same compiler.
(optional. If missing, it is set to a value determined by the current date and time.) |
[in] | imageID | : The input positive scalar integer of default kind IK containing the ID of the current image/thread/process.
This can be,
-
The Coarray image ID as returned by Fortran intrinsic
this_image() within a global team of Coarray images.
-
The MPI rank of the processor (plus one) as returned by the MPI library intrinsic
mpi_comm_rank() .
-
The OpenMP thread number as returned by the OpenMP library intrinsic
omp_get_thread_num() .
-
Any (positive) integer that uniquely identifies the current processor from other processes.
The image/process/thread ID can be readily obtained by calling getImageID.
This number will be used to set the RNG state uniquely on each processor.
(optional. If missing, the RNG state will be set identically on all images.) |
Possible calling interfaces ⛓
use pm_lkind, only: IK
Set the state of the Fortran default random number generator (RNG) to a random value or to an optiona...
This module contains classes and procedures for computing various statistical quantities related to t...
- Warning
- The condition
0 < imageID
must hold for the corresponding input arguments.
- See also
- rngf
isHead
getUnifCDF
getUnifRand
setUnifRand
getUnifRandState
setUnifRandState
rngu_type
rngf_type
splitmix64_type
xoshiro256ssw_type
getUnifRandStateSize
Example usage ⛓
10 integer(IK),
allocatable :: unifRandState(:)
12 type(display_type) :: disp
17 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%")
18 call disp%show(
"! Set the current RNG seed.")
19 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%")
23 call disp%show(
"call setUnifRandState()")
28 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
29 call disp%show(
"! Set the current RNG seed based on the input scalar `seed`.")
30 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
34 call disp%show(
"call setUnifRandState(seed = 12345_IK)")
39 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
40 call disp%show(
"! Set the current RNG seed on each image distinctly based on the current date and time and and the image ID.")
41 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
45 call disp%show(
"call setUnifRandState(imageID = getImageID())")
50 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
51 call disp%show(
"! Set the current RNG seed on each image distinctly based on the input scalar `seed` and and the image ID.")
52 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
56 call disp%show(
"call setUnifRandState(seed = 12345_IK, imageID = getImageID())")
This is a generic method of the derived type display_type with pass attribute.
This is a generic method of the derived type display_type with pass attribute.
This module contains classes and procedures for input/output (IO) or generic display operations on st...
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
This module contains procedures and generic interfaces for facilitating parallel computations or comp...
integer(IK) function getImageID()
Generate and return the ID of the current Coarray image / MPI process / OpenMP thread,...
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort
compiler ⛓
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example Windows Batch compile command via Intel ifort
compiler ⛓
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran
compiler ⛓
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example output ⛓
- 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.
-
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.
-
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 Austin
Definition at line 3993 of file pm_distUnif.F90.