Return a scalar or array of arbitrary rank of Bernoullidistributed random values (0
or 1
), with the specified input success probability p
.
More...
Return a scalar or array of arbitrary rank of Bernoullidistributed random values (0
or 1
), with the specified input success probability p
.
 Parameters

[out]  rand  : The output scalar (or array of the same rank, shape, and size as other arraylike arguments), of

type
integer of kind any supported by the processor (e.g., IK, IK8, IK16, IK32, or IK64),

type
logical of kind any supported by the processor (e.g., LK),

type
real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128),
containing the Bernoullidistributed random output value.

If
rand is real , then an output value of 1. means success/yes/true and 0. means failure/no/false.

If
rand is integer , then an output value of 1 means success/yes/true and 0 means failure/no/false.

If
rand is logical , then an output value of .true. means success/yes/true and .false. means failure/no/false.

[in]  urand  : The input scalar (or array of the same rank, shape, and size as other arraylike arguments), of

type
real of the same kind as rand if rand is real , or

type
real of the kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), if rand is of type logical or integer ,
containing uniformlydistributed random value(s) with the range 0 <= urand < 1 .
Such random value(s) can be readily obtained via the Fortran intrinsic procedure random_number() or via getUnifRand().
Supplying this argument ensures the purity of the procedures, allowing further compiler optimizations.

[in]  p  : The input scalar (or array of the same rank, shape, and size as other arraylike arguments), of

type
real of the same kind as rand if rand is real , or

type
real of the kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), if rand is of type logical or integer ,
representing the success probability of in the Bernoulli trial.
Note that p must be a number in the range [0,1] . 
Possible calling interfaces ⛓
Return a scalar or array of arbitrary rank of Bernoullidistributed random values (0 or 1),...
This module contains classes and procedures for generating Bernoullidistributed random numbers.
 Warning
 The conditions
0 <= p <= 1
must hold for the corresponding input arguments.
The conditions 0 <= urand < 1
must hold for the corresponding input arguments.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1
.

The
pure
procedure(s) documented herein become impure
when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1
.
By default, these procedures are pure
in release
build and impure
in debug
and testing
builds.
 See also
 isHead
getBernRand
getUnifRand
setUnifRand
Example usage ⛓
10 integer(IK) ,
parameter :: NP
= 5_IK
11 logical :: Rand_LK(NP)
12 integer :: Rand_IK(NP)
14 type(display_type) :: disp
19 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
20 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
21 call disp%show(
"! Generate `integer`valued random state.")
22 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
23 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
27 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
28 call disp%show(
"! Generate a scalar integer random value.")
29 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
32 call disp%show(
"call setBernRand(Rand_IK(1), getUnifRand(0., 1.), p = .5) ! 0.5 odds of success.")
39 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
40 call disp%show(
"! Generate a vector integer random value.")
41 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
44 call disp%show(
"call setBernRand(Rand_IK(:), getUnifRand(0., 1., NP), p = 0.75) ! 0.75 odds of success.")
51 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
52 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
53 call disp%show(
"! Generate `logical`valued random state.")
54 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
55 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
59 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
60 call disp%show(
"! Generate a scalar logical random value.")
61 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
64 call disp%show(
"call setBernRand(Rand_LK(1), getUnifRand(0., 1.), p = .5) ! 0.5 odds of success.")
71 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
72 call disp%show(
"! Generate a vector logical random value.")
73 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
76 call disp%show(
"call setBernRand(Rand_LK(:), getUnifRand(0., 1., NP), p = 0.75) ! 0.75 odds of success.")
83 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
84 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
85 call disp%show(
"! Generate `real`valued random numbers.")
86 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
87 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
91 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
92 call disp%show(
"! Generate a scalar real random number.")
93 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
96 call disp%show(
"call setBernRand(Rand_RK(1), getUnifRand(0., 1.), p = .5) ! 0.5 odds of success.")
103 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
104 call disp%show(
"! Generate a vector of real random numbers.")
105 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
108 call disp%show(
"call setBernRand(Rand_RK(:), getUnifRand(0., 1., NP), p = 0.75) ! 0.75 odds of success.")
Generate and return a scalar or a contiguous array of rank 1 of length s1 of randomly uniformly distr...
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 computing various statistical quantities related to t...
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 typeparameters 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 CFortran Interoper...
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in CFortran Intero...
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort
compiler ⛓
3ifort fpp standardsemantics 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 /standardsemantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran
compiler ⛓
3gfortran cpp ffreelinelengthnone O3 Wl,rpath,../../../lib I../../../inc main.F90 ../../../lib/libparamonte* o main.exe
Example output ⛓
74+0.00000000,
+1.00000000,
+1.00000000,
+1.00000000,
+1.00000000
 Test:
 test_pm_distBern
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, Oct 16, 2009, 11:14 AM, Michigan
Definition at line 554 of file pm_distBern.F90.